mirror of
https://github.com/denoland/deno.git
synced 2024-12-22 07:14:47 -05:00
92a8d09e49
Closes https://github.com/denoland/deno/issues/23036 --------- Co-authored-by: Nathan Whitaker <nathan@deno.com>
453 lines
14 KiB
Rust
453 lines
14 KiB
Rust
// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.
|
|
|
|
use std::borrow::Cow;
|
|
use std::path::Path;
|
|
use std::path::PathBuf;
|
|
|
|
use deno_ast::MediaType;
|
|
use deno_ast::ModuleSpecifier;
|
|
use deno_config::glob::PathGlobMatch;
|
|
use deno_config::glob::PathOrPattern;
|
|
use deno_config::glob::PathOrPatternSet;
|
|
|
|
/// Checks if the path has an extension Deno supports for script execution.
|
|
pub fn is_script_ext(path: &Path) -> bool {
|
|
if let Some(ext) = get_extension(path) {
|
|
matches!(
|
|
ext.as_str(),
|
|
"ts" | "tsx" | "js" | "jsx" | "mjs" | "mts" | "cjs" | "cts"
|
|
)
|
|
} else {
|
|
false
|
|
}
|
|
}
|
|
|
|
/// Checks if the path has an extension Deno supports for importing.
|
|
pub fn is_importable_ext(path: &Path) -> bool {
|
|
if let Some(ext) = get_extension(path) {
|
|
matches!(
|
|
ext.as_str(),
|
|
"ts" | "tsx" | "js" | "jsx" | "mjs" | "mts" | "cjs" | "cts" | "json"
|
|
)
|
|
} else {
|
|
false
|
|
}
|
|
}
|
|
|
|
/// Get the extension of a file in lowercase.
|
|
pub fn get_extension(file_path: &Path) -> Option<String> {
|
|
return file_path
|
|
.extension()
|
|
.and_then(|e| e.to_str())
|
|
.map(|e| e.to_lowercase());
|
|
}
|
|
|
|
pub fn get_atomic_dir_path(file_path: &Path) -> PathBuf {
|
|
let rand = gen_rand_path_component();
|
|
let new_file_name = format!(
|
|
".{}_{}",
|
|
file_path
|
|
.file_name()
|
|
.map(|f| f.to_string_lossy())
|
|
.unwrap_or(Cow::Borrowed("")),
|
|
rand
|
|
);
|
|
file_path.with_file_name(new_file_name)
|
|
}
|
|
|
|
pub fn get_atomic_file_path(file_path: &Path) -> PathBuf {
|
|
let rand = gen_rand_path_component();
|
|
let extension = format!("{rand}.tmp");
|
|
file_path.with_extension(extension)
|
|
}
|
|
|
|
fn gen_rand_path_component() -> String {
|
|
(0..4).fold(String::new(), |mut output, _| {
|
|
output.push_str(&format!("{:02x}", rand::random::<u8>()));
|
|
output
|
|
})
|
|
}
|
|
|
|
/// TypeScript figures out the type of file based on the extension, but we take
|
|
/// other factors into account like the file headers. The hack here is to map the
|
|
/// specifier passed to TypeScript to a new specifier with the file extension.
|
|
pub fn mapped_specifier_for_tsc(
|
|
specifier: &ModuleSpecifier,
|
|
media_type: MediaType,
|
|
) -> Option<String> {
|
|
let ext_media_type = MediaType::from_specifier(specifier);
|
|
if media_type != ext_media_type {
|
|
// we can't just add on the extension because typescript considers
|
|
// all .d.*.ts files as declaration files in TS 5.0+
|
|
if media_type != MediaType::Dts
|
|
&& media_type == MediaType::TypeScript
|
|
&& specifier
|
|
.path()
|
|
.split('/')
|
|
.last()
|
|
.map(|last| last.contains(".d."))
|
|
.unwrap_or(false)
|
|
{
|
|
let mut path_parts = specifier
|
|
.path()
|
|
.split('/')
|
|
.map(ToOwned::to_owned)
|
|
.collect::<Vec<_>>();
|
|
let last_part = path_parts.last_mut().unwrap();
|
|
*last_part = last_part.replace(".d.", "$d$");
|
|
let mut specifier = specifier.clone();
|
|
specifier.set_path(&path_parts.join("/"));
|
|
Some(format!("{}{}", specifier, media_type.as_ts_extension()))
|
|
} else {
|
|
Some(format!("{}{}", specifier, media_type.as_ts_extension()))
|
|
}
|
|
} else {
|
|
None
|
|
}
|
|
}
|
|
|
|
/// `from.make_relative(to)` but with fixes.
|
|
pub fn relative_specifier(
|
|
from: &ModuleSpecifier,
|
|
to: &ModuleSpecifier,
|
|
) -> Option<String> {
|
|
let is_dir = to.path().ends_with('/');
|
|
|
|
if is_dir && from == to {
|
|
return Some("./".to_string());
|
|
}
|
|
|
|
// workaround using parent directory until https://github.com/servo/rust-url/pull/754 is merged
|
|
let from = if !from.path().ends_with('/') {
|
|
if let Some(end_slash) = from.path().rfind('/') {
|
|
let mut new_from = from.clone();
|
|
new_from.set_path(&from.path()[..end_slash + 1]);
|
|
Cow::Owned(new_from)
|
|
} else {
|
|
Cow::Borrowed(from)
|
|
}
|
|
} else {
|
|
Cow::Borrowed(from)
|
|
};
|
|
|
|
// workaround for url crate not adding a trailing slash for a directory
|
|
// it seems to be fixed once a version greater than 2.2.2 is released
|
|
let mut text = from.make_relative(to)?;
|
|
if is_dir && !text.ends_with('/') && to.query().is_none() {
|
|
text.push('/');
|
|
}
|
|
|
|
let text = if text.starts_with("../") || text.starts_with("./") {
|
|
text
|
|
} else {
|
|
format!("./{text}")
|
|
};
|
|
Some(to_percent_decoded_str(&text))
|
|
}
|
|
|
|
/// Gets a path with the specified file stem suffix.
|
|
///
|
|
/// Ex. `file.ts` with suffix `_2` returns `file_2.ts`
|
|
pub fn path_with_stem_suffix(path: &Path, suffix: &str) -> PathBuf {
|
|
if let Some(file_name) = path.file_name().map(|f| f.to_string_lossy()) {
|
|
if let Some(file_stem) = path.file_stem().map(|f| f.to_string_lossy()) {
|
|
if let Some(ext) = path.extension().map(|f| f.to_string_lossy()) {
|
|
return if file_stem.to_lowercase().ends_with(".d") {
|
|
path.with_file_name(format!(
|
|
"{}{}.{}.{}",
|
|
&file_stem[..file_stem.len() - ".d".len()],
|
|
suffix,
|
|
// maintain casing
|
|
&file_stem[file_stem.len() - "d".len()..],
|
|
ext
|
|
))
|
|
} else {
|
|
path.with_file_name(format!("{file_stem}{suffix}.{ext}"))
|
|
};
|
|
}
|
|
}
|
|
|
|
path.with_file_name(format!("{file_name}{suffix}"))
|
|
} else {
|
|
path.with_file_name(suffix)
|
|
}
|
|
}
|
|
|
|
#[cfg_attr(windows, allow(dead_code))]
|
|
pub fn relative_path(from: &Path, to: &Path) -> Option<PathBuf> {
|
|
pathdiff::diff_paths(to, from)
|
|
}
|
|
|
|
/// Gets if the provided character is not supported on all
|
|
/// kinds of file systems.
|
|
pub fn is_banned_path_char(c: char) -> bool {
|
|
matches!(c, '<' | '>' | ':' | '"' | '|' | '?' | '*')
|
|
}
|
|
|
|
/// Gets a safe local directory name for the provided url.
|
|
///
|
|
/// For example:
|
|
/// https://deno.land:8080/path -> deno.land_8080/path
|
|
pub fn root_url_to_safe_local_dirname(root: &ModuleSpecifier) -> PathBuf {
|
|
fn sanitize_segment(text: &str) -> String {
|
|
text
|
|
.chars()
|
|
.map(|c| if is_banned_segment_char(c) { '_' } else { c })
|
|
.collect()
|
|
}
|
|
|
|
fn is_banned_segment_char(c: char) -> bool {
|
|
matches!(c, '/' | '\\') || is_banned_path_char(c)
|
|
}
|
|
|
|
let mut result = String::new();
|
|
if let Some(domain) = root.domain() {
|
|
result.push_str(&sanitize_segment(domain));
|
|
}
|
|
if let Some(port) = root.port() {
|
|
if !result.is_empty() {
|
|
result.push('_');
|
|
}
|
|
result.push_str(&port.to_string());
|
|
}
|
|
let mut result = PathBuf::from(result);
|
|
if let Some(segments) = root.path_segments() {
|
|
for segment in segments.filter(|s| !s.is_empty()) {
|
|
result = result.join(sanitize_segment(segment));
|
|
}
|
|
}
|
|
|
|
result
|
|
}
|
|
|
|
/// Slightly different behaviour than the default matching
|
|
/// where an exact path needs to be matched to be opted-in
|
|
/// rather than just a partial directory match.
|
|
///
|
|
/// This is used by the test and bench filtering.
|
|
pub fn matches_pattern_or_exact_path(
|
|
path_or_pattern_set: &PathOrPatternSet,
|
|
path: &Path,
|
|
) -> bool {
|
|
for p in path_or_pattern_set.inner().iter().rev() {
|
|
match p {
|
|
PathOrPattern::Path(p) => {
|
|
if p == path {
|
|
return true;
|
|
}
|
|
}
|
|
PathOrPattern::NegatedPath(p) => {
|
|
if path.starts_with(p) {
|
|
return false;
|
|
}
|
|
}
|
|
PathOrPattern::RemoteUrl(_) => {}
|
|
PathOrPattern::Pattern(p) => match p.matches_path(path) {
|
|
PathGlobMatch::Matched => return true,
|
|
PathGlobMatch::MatchedNegated => return false,
|
|
PathGlobMatch::NotMatched => {}
|
|
},
|
|
}
|
|
}
|
|
false
|
|
}
|
|
|
|
/// For decoding percent-encodeing string
|
|
/// could be used for module specifier string literal of local modules,
|
|
/// or local file path to display `non-ASCII` characters correctly
|
|
/// # Examples
|
|
/// ```
|
|
/// use crate::util::path::to_percent_decoded_str;
|
|
///
|
|
/// let str = to_percent_decoded_str("file:///Users/path/to/%F0%9F%A6%95.ts");
|
|
/// assert_eq!(str, "file:///Users/path/to/🦕.ts");
|
|
/// ```
|
|
pub fn to_percent_decoded_str(s: &str) -> String {
|
|
match percent_encoding::percent_decode_str(s).decode_utf8() {
|
|
Ok(s) => s.to_string(),
|
|
// when failed to decode, return the original string
|
|
Err(_) => s.to_string(),
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod test {
|
|
use super::*;
|
|
|
|
#[test]
|
|
fn test_is_script_ext() {
|
|
assert!(!is_script_ext(Path::new("tests/subdir/redirects")));
|
|
assert!(!is_script_ext(Path::new("README.md")));
|
|
assert!(is_script_ext(Path::new("lib/typescript.d.ts")));
|
|
assert!(is_script_ext(Path::new("testdata/run/001_hello.js")));
|
|
assert!(is_script_ext(Path::new("testdata/run/002_hello.ts")));
|
|
assert!(is_script_ext(Path::new("foo.jsx")));
|
|
assert!(is_script_ext(Path::new("foo.tsx")));
|
|
assert!(is_script_ext(Path::new("foo.TS")));
|
|
assert!(is_script_ext(Path::new("foo.TSX")));
|
|
assert!(is_script_ext(Path::new("foo.JS")));
|
|
assert!(is_script_ext(Path::new("foo.JSX")));
|
|
assert!(is_script_ext(Path::new("foo.mjs")));
|
|
assert!(is_script_ext(Path::new("foo.mts")));
|
|
assert!(is_script_ext(Path::new("foo.cjs")));
|
|
assert!(is_script_ext(Path::new("foo.cts")));
|
|
assert!(!is_script_ext(Path::new("foo.json")));
|
|
assert!(!is_script_ext(Path::new("foo.mjsx")));
|
|
}
|
|
|
|
#[test]
|
|
fn test_is_importable_ext() {
|
|
assert!(!is_importable_ext(Path::new("tests/subdir/redirects")));
|
|
assert!(!is_importable_ext(Path::new("README.md")));
|
|
assert!(is_importable_ext(Path::new("lib/typescript.d.ts")));
|
|
assert!(is_importable_ext(Path::new("testdata/run/001_hello.js")));
|
|
assert!(is_importable_ext(Path::new("testdata/run/002_hello.ts")));
|
|
assert!(is_importable_ext(Path::new("foo.jsx")));
|
|
assert!(is_importable_ext(Path::new("foo.tsx")));
|
|
assert!(is_importable_ext(Path::new("foo.TS")));
|
|
assert!(is_importable_ext(Path::new("foo.TSX")));
|
|
assert!(is_importable_ext(Path::new("foo.JS")));
|
|
assert!(is_importable_ext(Path::new("foo.JSX")));
|
|
assert!(is_importable_ext(Path::new("foo.mjs")));
|
|
assert!(is_importable_ext(Path::new("foo.mts")));
|
|
assert!(is_importable_ext(Path::new("foo.cjs")));
|
|
assert!(is_importable_ext(Path::new("foo.cts")));
|
|
assert!(is_importable_ext(Path::new("foo.json")));
|
|
assert!(!is_importable_ext(Path::new("foo.mjsx")));
|
|
}
|
|
|
|
#[test]
|
|
fn test_relative_specifier() {
|
|
let fixtures: Vec<(&str, &str, Option<&str>)> = vec![
|
|
("file:///from", "file:///to", Some("./to")),
|
|
("file:///from", "file:///from/other", Some("./from/other")),
|
|
("file:///from", "file:///from/other/", Some("./from/other/")),
|
|
("file:///from", "file:///other/from", Some("./other/from")),
|
|
("file:///from/", "file:///other/from", Some("../other/from")),
|
|
("file:///from", "file:///other/from/", Some("./other/from/")),
|
|
(
|
|
"file:///from",
|
|
"file:///to/other.txt",
|
|
Some("./to/other.txt"),
|
|
),
|
|
(
|
|
"file:///from/test",
|
|
"file:///to/other.txt",
|
|
Some("../to/other.txt"),
|
|
),
|
|
(
|
|
"file:///from/other.txt",
|
|
"file:///to/other.txt",
|
|
Some("../to/other.txt"),
|
|
),
|
|
(
|
|
"https://deno.land/x/a/b/d.ts",
|
|
"https://deno.land/x/a/b/c.ts",
|
|
Some("./c.ts"),
|
|
),
|
|
(
|
|
"https://deno.land/x/a/b/d.ts",
|
|
"https://deno.land/x/a/c.ts",
|
|
Some("../c.ts"),
|
|
),
|
|
(
|
|
"https://deno.land/x/a/b/d.ts",
|
|
"https://deno.land/x/a/b/c/d.ts",
|
|
Some("./c/d.ts"),
|
|
),
|
|
(
|
|
"https://deno.land/x/a/b/c/",
|
|
"https://deno.land/x/a/b/c/d.ts",
|
|
Some("./d.ts"),
|
|
),
|
|
(
|
|
"https://deno.land/x/a/b/c/",
|
|
"https://deno.land/x/a/b/c/d/e.ts",
|
|
Some("./d/e.ts"),
|
|
),
|
|
(
|
|
"https://deno.land/x/a/b/c/f.ts",
|
|
"https://deno.land/x/a/b/c/d/e.ts",
|
|
Some("./d/e.ts"),
|
|
),
|
|
(
|
|
"https://deno.land/x/a/b/d.ts",
|
|
"https://deno.land/x/a/c.ts?foo=bar",
|
|
Some("../c.ts?foo=bar"),
|
|
),
|
|
(
|
|
"https://deno.land/x/a/b/d.ts?foo=bar",
|
|
"https://deno.land/x/a/b/c.ts",
|
|
Some("./c.ts"),
|
|
),
|
|
("file:///a/b/d.ts", "file:///a/b/c.ts", Some("./c.ts")),
|
|
("https://deno.land/x/a/b/c.ts", "file:///a/b/c.ts", None),
|
|
(
|
|
"https://deno.land/",
|
|
"https://deno.land/x/a/b/c.ts",
|
|
Some("./x/a/b/c.ts"),
|
|
),
|
|
(
|
|
"https://deno.land/x/d/e/f.ts",
|
|
"https://deno.land/x/a/b/c.ts",
|
|
Some("../../a/b/c.ts"),
|
|
),
|
|
];
|
|
for (from_str, to_str, expected) in fixtures {
|
|
let from = ModuleSpecifier::parse(from_str).unwrap();
|
|
let to = ModuleSpecifier::parse(to_str).unwrap();
|
|
let actual = relative_specifier(&from, &to);
|
|
assert_eq!(
|
|
actual.as_deref(),
|
|
expected,
|
|
"from: \"{from_str}\" to: \"{to_str}\""
|
|
);
|
|
}
|
|
}
|
|
|
|
#[test]
|
|
fn test_path_with_stem_suffix() {
|
|
assert_eq!(
|
|
path_with_stem_suffix(&PathBuf::from("/"), "_2"),
|
|
PathBuf::from("/_2")
|
|
);
|
|
assert_eq!(
|
|
path_with_stem_suffix(&PathBuf::from("/test"), "_2"),
|
|
PathBuf::from("/test_2")
|
|
);
|
|
assert_eq!(
|
|
path_with_stem_suffix(&PathBuf::from("/test.txt"), "_2"),
|
|
PathBuf::from("/test_2.txt")
|
|
);
|
|
assert_eq!(
|
|
path_with_stem_suffix(&PathBuf::from("/test/subdir"), "_2"),
|
|
PathBuf::from("/test/subdir_2")
|
|
);
|
|
assert_eq!(
|
|
path_with_stem_suffix(&PathBuf::from("/test/subdir.other.txt"), "_2"),
|
|
PathBuf::from("/test/subdir.other_2.txt")
|
|
);
|
|
assert_eq!(
|
|
path_with_stem_suffix(&PathBuf::from("/test.d.ts"), "_2"),
|
|
PathBuf::from("/test_2.d.ts")
|
|
);
|
|
assert_eq!(
|
|
path_with_stem_suffix(&PathBuf::from("/test.D.TS"), "_2"),
|
|
PathBuf::from("/test_2.D.TS")
|
|
);
|
|
assert_eq!(
|
|
path_with_stem_suffix(&PathBuf::from("/test.d.mts"), "_2"),
|
|
PathBuf::from("/test_2.d.mts")
|
|
);
|
|
assert_eq!(
|
|
path_with_stem_suffix(&PathBuf::from("/test.d.cts"), "_2"),
|
|
PathBuf::from("/test_2.d.cts")
|
|
);
|
|
}
|
|
|
|
#[test]
|
|
fn test_to_percent_decoded_str() {
|
|
let str = to_percent_decoded_str("%F0%9F%A6%95");
|
|
assert_eq!(str, "🦕");
|
|
}
|
|
}
|