1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306
use crate::{
inner_string_text, AnyJsBinding, AnyJsImportClause, AnyJsNamedImportSpecifier,
JsCallExpression, JsImport, JsImportAssertion, JsImportCallExpression, JsModuleSource,
JsSyntaxToken,
};
use biome_rowan::{declare_node_union, AstNode, SyntaxResult, TokenText};
impl JsImport {
/// It checks if the source of an import against the string `source_to_check`
///
/// ## Examples
///
/// ```
/// use biome_js_factory::make;
/// use biome_js_syntax::T;
///
/// let source = make::js_module_source(make::js_string_literal("react"));
/// let binding = make::js_identifier_binding(make::ident("React"));
/// let specifier = make::js_default_import_specifier(binding.into());
/// let clause = make::js_import_default_clause(specifier, make::token(T![from]), source).build();
/// let import = make::js_import(make::token(T![import]), clause.into()).build();
///
/// assert_eq!(import.source_text().unwrap().text(), "react");
/// ```
pub fn source_text(&self) -> SyntaxResult<TokenText> {
self.import_clause()?.source()?.inner_string_text()
}
}
impl AnyJsImportClause {
/// Type token of the import clause.
///
/// ```ts
/// import { type X }
/// ^^^^
/// ```
pub fn type_token(&self) -> Option<JsSyntaxToken> {
match self {
Self::JsImportBareClause(_) => None,
Self::JsImportDefaultClause(clause) => clause.type_token(),
Self::JsImportNamedClause(clause) => clause.type_token(),
Self::JsImportNamespaceClause(clause) => clause.type_token(),
Self::JsImportCombinedClause(_) => None,
}
}
/// Source of this import clause.
///
/// ```
/// use biome_js_factory::make;
/// use biome_js_syntax::T;
///
/// let source = make::js_module_source(make::js_string_literal("react"));
/// let binding = make::js_identifier_binding(make::ident("React"));
/// let specifier = make::js_default_import_specifier(binding.into());
/// let clause = make::js_import_default_clause(specifier, make::token(T![from]), source).build();
///
/// assert_eq!(clause.source().unwrap().inner_string_text().unwrap().text(), "react");
/// ```
pub fn source(&self) -> SyntaxResult<JsModuleSource> {
match self {
Self::JsImportBareClause(clause) => clause.source(),
Self::JsImportDefaultClause(clause) => clause.source(),
Self::JsImportNamedClause(clause) => clause.source(),
Self::JsImportNamespaceClause(clause) => clause.source(),
Self::JsImportCombinedClause(clause) => clause.source(),
}
}
/// Assertion of this import clause.
///
/// ```
/// use biome_js_factory::make;
/// use biome_js_syntax::T;
///
/// let source = make::js_module_source(make::js_string_literal("react"));
/// let binding = make::js_identifier_binding(make::ident("React"));
/// let specifier = make::js_default_import_specifier(binding.into());
/// let clause = make::js_import_default_clause(specifier, make::token(T![from]), source).build();
///
/// assert_eq!(clause.source().unwrap().inner_string_text().unwrap().text(), "react");
/// ```
pub fn assertion(&self) -> Option<JsImportAssertion> {
match self {
Self::JsImportBareClause(clause) => clause.assertion(),
Self::JsImportDefaultClause(clause) => clause.assertion(),
Self::JsImportNamedClause(clause) => clause.assertion(),
Self::JsImportNamespaceClause(clause) => clause.assertion(),
Self::JsImportCombinedClause(clause) => clause.assertion(),
}
}
}
impl AnyJsNamedImportSpecifier {
/// Type token of the import specifier.
///
/// ```ts
/// import { type X }
/// ^^^^
/// ```
pub fn type_token(&self) -> Option<JsSyntaxToken> {
match self {
Self::JsBogusNamedImportSpecifier(_) => None,
Self::JsNamedImportSpecifier(specifier) => specifier.type_token(),
Self::JsShorthandNamedImportSpecifier(specifier) => specifier.type_token(),
}
}
/// Returns the import clause that includes this specifier.
pub fn import_clause(&self) -> Option<AnyJsImportClause> {
AnyJsImportClause::cast(self.syntax().ancestors().nth(3)?)
}
/// Returns `true` if this specifier or its import clause has **only** a type modifier.
pub fn imports_only_types(&self) -> bool {
self.type_token().is_some() || self.import_clause().and_then(|x| x.type_token()).is_some()
}
/// Imported name of this import specifier
///
/// ```
/// use biome_js_factory::make;
/// use biome_js_syntax::AnyJsNamedImportSpecifier;
///
/// let binding = make::js_identifier_binding(make::ident("React"));
/// let specifier = make::js_shorthand_named_import_specifier(binding.into()).build();
/// let specifier = AnyJsNamedImportSpecifier::JsShorthandNamedImportSpecifier(specifier);
///
/// assert_eq!(specifier.imported_name().unwrap().text_trimmed(), "React");
/// ```
pub fn imported_name(&self) -> Option<JsSyntaxToken> {
match self {
specifier @ (Self::JsNamedImportSpecifier(_)
| Self::JsShorthandNamedImportSpecifier(_)) => specifier
.local_name()?
.as_js_identifier_binding()?
.name_token()
.ok(),
Self::JsBogusNamedImportSpecifier(_) => None,
}
}
/// Local name of this import specifier
///
/// ```
/// use biome_js_factory::make;
/// use biome_js_syntax::AnyJsNamedImportSpecifier;
///
/// let binding = make::js_identifier_binding(make::ident("React"));
/// let specifier = make::js_shorthand_named_import_specifier(binding.into()).build();
/// let specifier = AnyJsNamedImportSpecifier::JsShorthandNamedImportSpecifier(specifier);
///
/// let name_token = specifier.local_name().unwrap().as_js_identifier_binding().unwrap().name_token();
/// assert_eq!(name_token.unwrap().text_trimmed(), "React");
/// ```
pub fn local_name(&self) -> Option<AnyJsBinding> {
match self {
Self::JsBogusNamedImportSpecifier(_) => None,
Self::JsNamedImportSpecifier(specifier) => specifier.local_name().ok(),
Self::JsShorthandNamedImportSpecifier(specifier) => specifier.local_name().ok(),
}
}
pub fn with_type_token(self, type_token: Option<JsSyntaxToken>) -> AnyJsNamedImportSpecifier {
match self {
Self::JsBogusNamedImportSpecifier(_) => self,
Self::JsNamedImportSpecifier(specifier) => specifier.with_type_token(type_token).into(),
Self::JsShorthandNamedImportSpecifier(specifier) => {
specifier.with_type_token(type_token).into()
}
}
}
}
impl JsModuleSource {
/// Get the inner text of a string not including the quotes
///
/// ## Examples
///
/// ```
/// use biome_js_factory::make;
/// use biome_rowan::TriviaPieceKind;
///
/// let source_token = make::js_string_literal("react")
/// .with_leading_trivia(vec![(TriviaPieceKind::Whitespace, " ")]);
/// let source = make::js_module_source(source_token);
///
/// assert_eq!(source.inner_string_text().unwrap().text(), "react");
/// ```
pub fn inner_string_text(&self) -> SyntaxResult<TokenText> {
Ok(inner_string_text(&self.value_token()?))
}
}
declare_node_union! {
/// This node union is meant to match the following syntax:
/// ```js
/// import "lodash";
/// // ^^^^^^^^
/// require("lodash")
/// // ^^^^^^^^^^^^^^^^^
/// import("lodash")
/// // ^^^^^^^^^^^^^^^^
/// ```
pub AnyJsImportSpecifierLike = JsModuleSource | JsCallExpression | JsImportCallExpression
}
impl AnyJsImportSpecifierLike {
/// Returns the inner text of specifier:
///
/// ## Examples
///
/// ```
/// use biome_js_factory::make;
/// use biome_js_syntax::AnyJsImportSpecifierLike;
/// use biome_rowan::TriviaPieceKind;
///
/// let source_name = make::js_module_source(make::js_string_literal("foo"));
/// let any_import_specifier = AnyJsImportSpecifierLike::JsModuleSource(source_name);
/// assert_eq!(any_import_specifier.inner_string_text().unwrap().text(), "foo")
/// ```
pub fn inner_string_text(&self) -> Option<TokenText> {
match self {
AnyJsImportSpecifierLike::JsModuleSource(source) => source.inner_string_text().ok(),
AnyJsImportSpecifierLike::JsCallExpression(expression) => {
let callee = expression.callee().ok()?;
let name = callee.as_js_reference_identifier()?.value_token().ok()?;
if name.text_trimmed() == "require" {
let [Some(argument)] = expression.arguments().ok()?.get_arguments_by_index([0])
else {
return None;
};
argument
.as_any_js_expression()?
.as_any_js_literal_expression()?
.as_js_string_literal_expression()?
.inner_string_text()
.ok()
} else {
None
}
}
AnyJsImportSpecifierLike::JsImportCallExpression(import_call) => {
let [Some(argument)] = import_call.arguments().ok()?.get_arguments_by_index([0])
else {
return None;
};
argument
.as_any_js_expression()?
.as_any_js_literal_expression()?
.as_js_string_literal_expression()?
.inner_string_text()
.ok()
}
}
}
/// Returns the whole token text of the specifier, with quotes included:
///
/// ## Examples
///
/// ```
/// use biome_js_factory::make;
/// use biome_js_syntax::AnyJsImportSpecifierLike;
/// use biome_rowan::TriviaPieceKind;
///
/// let source_name = make::js_module_source(make::js_string_literal("foo"));
/// let any_import_specifier = AnyJsImportSpecifierLike::JsModuleSource(source_name);
/// assert_eq!(any_import_specifier.module_name_token().unwrap().text(), "\"foo\"")
/// ```
pub fn module_name_token(&self) -> Option<JsSyntaxToken> {
match self {
AnyJsImportSpecifierLike::JsModuleSource(source) => source.value_token().ok(),
AnyJsImportSpecifierLike::JsCallExpression(expression) => {
let callee = expression.callee().ok()?;
let name = callee.as_js_reference_identifier()?.value_token().ok()?;
if name.text_trimmed() == "require" {
let [Some(argument)] = expression.arguments().ok()?.get_arguments_by_index([0])
else {
return None;
};
argument
.as_any_js_expression()?
.as_any_js_literal_expression()?
.as_js_string_literal_expression()?
.value_token()
.ok()
} else {
None
}
}
AnyJsImportSpecifierLike::JsImportCallExpression(import_call) => {
let [Some(argument)] = import_call.arguments().ok()?.get_arguments_by_index([0])
else {
return None;
};
argument
.as_any_js_expression()?
.as_any_js_literal_expression()?
.as_js_string_literal_expression()?
.value_token()
.ok()
}
}
}
}