swc_ecma_loader/resolvers/tsc.rs
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 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340
use std::{
cmp::Ordering,
path::{Component, Path, PathBuf},
};
use anyhow::{bail, Context, Error};
use swc_common::FileName;
use tracing::{debug, info, trace, warn, Level};
use crate::resolve::{Resolution, Resolve};
#[derive(Debug)]
enum Pattern {
Wildcard {
prefix: String,
},
/// No wildcard.
Exact(String),
}
/// Support for `paths` of `tsconfig.json`.
///
/// See https://www.typescriptlang.org/docs/handbook/module-resolution.html#path-mapping
#[derive(Debug)]
pub struct TsConfigResolver<R>
where
R: Resolve,
{
inner: R,
base_url: PathBuf,
base_url_filename: FileName,
paths: Vec<(Pattern, Vec<String>)>,
}
impl<R> TsConfigResolver<R>
where
R: Resolve,
{
///
/// # Parameters
///
/// ## base_url
///
/// See https://www.typescriptlang.org/tsconfig#baseUrl
///
/// The typescript documentation says `This must be specified if "paths"
/// is.`.
///
/// ## `paths`
///
/// Pass `paths` map from `tsconfig.json`.
///
/// See https://www.typescriptlang.org/tsconfig#paths
///
/// Note that this is not a hashmap because value is not used as a hash map.
pub fn new(inner: R, base_url: PathBuf, paths: Vec<(String, Vec<String>)>) -> Self {
if cfg!(debug_assertions) {
info!(
base_url = tracing::field::display(base_url.display()),
"jsc.paths"
);
}
let mut paths: Vec<(Pattern, Vec<String>)> = paths
.into_iter()
.map(|(from, to)| {
assert!(
!to.is_empty(),
"value of `paths.{}` should not be an empty array",
from,
);
let pos = from.as_bytes().iter().position(|&c| c == b'*');
let pat = if from.contains('*') {
if from.as_bytes().iter().rposition(|&c| c == b'*') != pos {
panic!("`paths.{}` should have only one wildcard", from)
}
Pattern::Wildcard {
prefix: from[..pos.unwrap()].to_string(),
}
} else {
assert_eq!(
to.len(),
1,
"value of `paths.{}` should be an array with one element because the src \
path does not contains * (wildcard)",
from,
);
Pattern::Exact(from)
};
(pat, to)
})
.collect();
paths.sort_by(|(a, _), (b, _)| match (a, b) {
(Pattern::Wildcard { .. }, Pattern::Exact(_)) => Ordering::Greater,
(Pattern::Exact(_), Pattern::Wildcard { .. }) => Ordering::Less,
(Pattern::Exact(_), Pattern::Exact(_)) => Ordering::Equal,
(Pattern::Wildcard { prefix: prefix_a }, Pattern::Wildcard { prefix: prefix_b }) => {
prefix_a.len().cmp(&prefix_b.len()).reverse()
}
});
Self {
inner,
base_url_filename: FileName::Real(base_url.clone()),
base_url,
paths,
}
}
fn invoke_inner_resolver(
&self,
base: &FileName,
module_specifier: &str,
) -> Result<Resolution, Error> {
let res = self.inner.resolve(base, module_specifier).with_context(|| {
format!(
"failed to resolve `{module_specifier}` from `{base}` using inner \
resolver\nbase_url={}",
self.base_url_filename
)
});
match res {
Ok(resolved) => {
info!(
"Resolved `{}` as `{}` from `{}`",
module_specifier, resolved.filename, base
);
let is_base_in_node_modules = if let FileName::Real(v) = base {
v.components().any(|c| match c {
Component::Normal(v) => v == "node_modules",
_ => false,
})
} else {
false
};
let is_target_in_node_modules = if let FileName::Real(v) = &resolved.filename {
v.components().any(|c| match c {
Component::Normal(v) => v == "node_modules",
_ => false,
})
} else {
false
};
// If node_modules is in path, we should return module specifier.
if !is_base_in_node_modules && is_target_in_node_modules {
return Ok(Resolution {
filename: FileName::Real(module_specifier.into()),
..resolved
});
}
Ok(resolved)
}
Err(err) => {
warn!("{:?}", err);
Err(err)
}
}
}
}
impl<R> Resolve for TsConfigResolver<R>
where
R: Resolve,
{
fn resolve(&self, base: &FileName, module_specifier: &str) -> Result<Resolution, Error> {
let _tracing = if cfg!(debug_assertions) {
Some(
tracing::span!(
Level::ERROR,
"TsConfigResolver::resolve",
base_url = tracing::field::display(self.base_url.display()),
base = tracing::field::display(base),
src = tracing::field::display(module_specifier),
)
.entered(),
)
} else {
None
};
if module_specifier.starts_with('.')
&& (module_specifier == ".."
|| module_specifier.starts_with("./")
|| module_specifier.starts_with("../"))
{
return self
.invoke_inner_resolver(base, module_specifier)
.context("not processed by tsc resolver because it's relative import");
}
if let FileName::Real(v) = base {
if v.components().any(|c| match c {
Component::Normal(v) => v == "node_modules",
_ => false,
}) {
return self.invoke_inner_resolver(base, module_specifier).context(
"not processed by tsc resolver because base module is in node_modules",
);
}
}
info!("Checking `jsc.paths`");
// https://www.typescriptlang.org/docs/handbook/module-resolution.html#path-mapping
for (from, to) in &self.paths {
match from {
Pattern::Wildcard { prefix } => {
debug!("Checking `{}` in `jsc.paths`", prefix);
let extra = module_specifier.strip_prefix(prefix);
let extra = match extra {
Some(v) => v,
None => {
if cfg!(debug_assertions) {
trace!("skip because src doesn't start with prefix");
}
continue;
}
};
if cfg!(debug_assertions) {
debug!("Extra: `{}`", extra);
}
let mut errors = Vec::new();
for target in to {
let replaced = target.replace('*', extra);
let _tracing = if cfg!(debug_assertions) {
Some(
tracing::span!(
Level::ERROR,
"TsConfigResolver::resolve::jsc.paths",
replaced = tracing::field::display(&replaced),
)
.entered(),
)
} else {
None
};
let relative = format!("./{}", replaced);
let res = self
.invoke_inner_resolver(base, module_specifier)
.or_else(|_| {
self.invoke_inner_resolver(&self.base_url_filename, &relative)
})
.or_else(|_| {
self.invoke_inner_resolver(&self.base_url_filename, &replaced)
});
errors.push(match res {
Ok(resolved) => return Ok(resolved),
Err(err) => err,
});
if to.len() == 1 && !prefix.is_empty() {
info!(
"Using `{}` for `{}` because the length of the jsc.paths entry is \
1",
replaced, module_specifier
);
return Ok(Resolution {
slug: Some(
replaced
.split([std::path::MAIN_SEPARATOR, '/'])
.last()
.unwrap()
.into(),
),
filename: FileName::Real(replaced.into()),
});
}
}
bail!(
"`{}` matched `{}` (from tsconfig.paths) but failed to resolve:\n{:?}",
module_specifier,
prefix,
errors
)
}
Pattern::Exact(from) => {
// Should be exactly matched
if module_specifier != from {
continue;
}
let tp = Path::new(&to[0]);
let slug = to[0]
.split([std::path::MAIN_SEPARATOR, '/'])
.last()
.filter(|&slug| slug != "index.ts" && slug != "index.tsx")
.map(|v| v.rsplit_once('.').map(|v| v.0).unwrap_or(v))
.map(From::from);
if tp.is_absolute() {
return Ok(Resolution {
filename: FileName::Real(tp.into()),
slug,
});
}
if let Ok(res) = self
.invoke_inner_resolver(&self.base_url_filename, &format!("./{}", &to[0]))
{
return Ok(Resolution { slug, ..res });
}
return Ok(Resolution {
filename: FileName::Real(self.base_url.join(&to[0])),
slug,
});
}
}
}
if !module_specifier.starts_with('.') {
let path = self.base_url.join(module_specifier);
// https://www.typescriptlang.org/docs/handbook/modules/reference.html#baseurl
if let Ok(v) = self.invoke_inner_resolver(base, &path.to_string_lossy()) {
return Ok(v);
}
}
self.invoke_inner_resolver(base, module_specifier)
}
}