oxc_resolver 11.19.1

ESM / CJS module resolution
Documentation 
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

//! <https://github.com/webpack/enhanced-resolve/blob/main/test/extensions.test.js>

use rustc_hash::FxHashSet;

use crate::{EnforceExtension, Resolution, ResolveContext, ResolveError, ResolveOptions, Resolver};

#[test]
fn extensions() {
    let f = super::fixture().join("extensions");

    let resolver = Resolver::new(ResolveOptions {
        extensions: vec![".ts".into(), ".js".into()],
        ..ResolveOptions::default()
    });

    #[rustfmt::skip]
    let pass = [
        ("should resolve according to order of provided extensions", "./foo", "foo.ts"),
        ("should resolve according to order of provided extensions (dir index)", "./dir", "dir/index.ts"),
        ("should resolve according to main field in module root", ".", "index.js"),
        // This is a core module
        // ("should resolve single file module before directory", "module", "node_modules/module.js"),
        ("should resolve trailing slash directory before single file", "module/", "node_modules/module/index.ts"),
    ];

    for (comment, request, expected_path) in pass {
        let resolved_path = resolver.resolve(&f, request).map(|r| r.full_path());
        let expected = f.join(expected_path);
        assert_eq!(resolved_path, Ok(expected), "{comment} {request} {expected_path}");
    }

    #[rustfmt::skip]
    let fail = [
        ("not resolve to file when request has a trailing slash (relative)", "./foo.js/", "./foo.js/".into())
    ];

    for (comment, request, expected_error) in fail {
        let resolution = resolver.resolve(&f, request);
        let error = ResolveError::NotFound(expected_error);
        assert_eq!(resolution, Err(error), "{comment} {request} {resolution:?}");
    }
}

// should default enforceExtension to true when extensions includes an empty string
#[test]
fn default_enforce_extension() {
    let f = super::fixture().join("extensions");

    let mut ctx = ResolveContext::default();
    let resolved = Resolver::new(ResolveOptions {
        extensions: vec![".ts".into(), String::new(), ".js".into()],
        ..ResolveOptions::default()
    })
    .resolve_with_context(&f, "./foo", None, &mut ctx);

    assert_eq!(resolved.map(Resolution::into_path_buf), Ok(f.join("foo.ts")));
    assert_eq!(
        ctx.file_dependencies,
        FxHashSet::from_iter([f.join("foo.ts"), f.join("package.json")])
    );
    assert!(ctx.missing_dependencies.is_empty());
}

// should respect enforceExtension when extensions includes an empty string
#[test]
fn respect_enforce_extension() {
    let f = super::fixture().join("extensions");

    let mut ctx = ResolveContext::default();
    let resolved = Resolver::new(ResolveOptions {
        enforce_extension: EnforceExtension::Disabled,
        extensions: vec![".ts".into(), String::new(), ".js".into()],
        ..ResolveOptions::default()
    })
    .resolve_with_context(&f, "./foo", None, &mut ctx);

    assert_eq!(resolved.map(Resolution::into_path_buf), Ok(f.join("foo.ts")));
    assert_eq!(
        ctx.file_dependencies,
        FxHashSet::from_iter([f.join("foo.ts"), f.join("package.json")])
    );
    assert_eq!(ctx.missing_dependencies, FxHashSet::from_iter([f.join("foo")]));
}

#[test]
fn multi_dot_extension() {
    let f = super::fixture().join("extensions");

    let resolver = Resolver::new(ResolveOptions {
        // Test for `.d.ts`, not part of enhanced-resolve.
        extensions: vec![".a.b.c".into(), ".d.ts".into(), ".ts".into(), ".js".into()],
        extension_alias: vec![(".ts".into(), vec![".ts".into(), ".d.ts".into()])],
        ..ResolveOptions::default()
    });

    #[rustfmt::skip]
    let pass = [
        ("should resolve according to order of provided extensions", "./foo", "foo.ts"),
        ("should resolve .d.ts for .ts", "./bar.ts", "bar.d.ts"),
        ("should resolve file with extension", "./app.module", "app.module.js")
    ];

    for (comment, request, expected_path) in pass {
        let resolved_path = resolver.resolve(&f, request).map(|r| r.full_path());
        let expected = f.join(expected_path);
        assert_eq!(resolved_path, Ok(expected), "{comment} {request} {expected_path}");
    }

    #[rustfmt::skip]
    let fail = [
        ("not resolve to file", "./index.", "./index.".into())
    ];

    for (comment, request, expected_error) in fail {
        let resolution = resolver.resolve(&f, request);
        let error = ResolveError::NotFound(expected_error);
        assert_eq!(resolution, Err(error), "{comment} {request} {resolution:?}");
    }
}

#[test]
#[should_panic = "All extensions must start with a leading dot"]
fn without_leading_dot() {
    let _ = Resolver::new(ResolveOptions {
        extensions: vec!["ts".into(), "js".into()],
        ..ResolveOptions::default()
    });
}

#[test]
fn extension_combinations() {
    let f = super::fixture().join("extensions");

    let resolver = Resolver::new(ResolveOptions {
        extensions: vec![".jsx".into(), ".tsx".into(), ".js".into(), ".ts".into()],
        ..ResolveOptions::default()
    });

    let pass = [
        ("should resolve file with explicit extension", "./foo.ts", "foo.ts"),
        ("should resolve directory index", "./dir/index.ts", "dir/index.ts"),
    ];

    for (comment, request, expected_path) in pass {
        let resolved_path = resolver.resolve(&f, request).map(|r| r.full_path());
        let expected = f.join(expected_path);
        assert_eq!(resolved_path, Ok(expected), "{comment} {request} {expected_path}");
    }
}