Oxc Resolver
Rust port of enhanced-resolve.
- built-in tsconfig-paths-webpack-plugin
- support extending tsconfig defined in
tsconfig.extends - support paths alias defined in
tsconfig.compilerOptions.paths - support project references defined
tsconfig.references
- support extending tsconfig defined in
- supports in-memory file system via the
FileSystemtrait - contains
tracinginstrumentation
Options
The options are aligned with enhanced-resolve.
| Field | Default | Description |
|---|---|---|
| alias | [] | A list of module alias configurations or an object which maps key to value |
| aliasFields | [] | A list of alias fields in description files |
| extensionAlias | {} | An object which maps extension to extension aliases |
| conditionNames | [] | A list of exports field condition names |
| descriptionFiles | ["package.json"] | A list of description files to read from |
| enforceExtension | false | Enforce that a extension from extensions must be used |
| exportsFields | ["exports"] | A list of exports fields in description files |
| extensions | [".js", ".json", ".node"] | A list of extensions which should be tried for files |
| fallback | [] | Same as alias, but only used if default resolving fails |
| fileSystem | The file system which should be used | |
| fullySpecified | false | Request passed to resolve is already fully specified and extensions or main files are not resolved for it (they are still resolved for internal requests) |
| mainFields | ["main"] | A list of main fields in description files |
| mainFiles | ["index"] | A list of main files in directories |
| modules | ["node_modules"] | A list of directories to resolve modules from, can be absolute path or folder name |
| resolveToContext | false | Resolve to a context instead of a file |
| preferRelative | false | Prefer to resolve module requests as relative request and fallback to resolving as module |
| preferAbsolute | false | Prefer to resolve server-relative urls as absolute paths before falling back to resolve in roots |
| restrictions | [] | A list of resolve restrictions |
| roots | [] | A list of root paths |
| symlinks | true | Whether to resolve symlinks to their symlinked location |
Unimplemented Options
| Field | Default | Description |
|---|---|---|
| cachePredicate | function() { return true }; | A function which decides whether a request should be cached or not. An object is passed to the function with path and request properties. |
| cacheWithContext | true | If unsafe cache is enabled, includes request.context in the cache key |
| plugins | [] | A list of additional resolve plugins which should be applied |
| resolver | undefined | A prepared Resolver to which the plugins are attached |
| unsafeCache | false | Use this cache object to unsafely cache the successful requests |
Debugging
Rspack
The following environment variable will emit tracing information.
RSPACK_PROFILE='TRACE=filter=oxc_resolver=trace&layer=logger' rspack build
Test
Tests are ported from
- enhanced-resolve
- tsconfig-path and parcel-resolver for tsconfig-paths
Test cases are located in ./src/tests, fixtures are located in ./tests
- alias.test.js
- browserField.test.js
- dependencies.test.js
- exportsField.test.js
- extension-alias.test.js
- extensions.test.js
- fallback.test.js
- fullSpecified.test.js
- identifier.test.js (see unit test in
crates/oxc_resolver/src/request.rs) - importsField.test.js
- incorrect-description-file.test.js (need to add ctx.fileDependencies)
- missing.test.js
- path.test.js (see unit test in
crates/oxc_resolver/src/path.rs) - plugins.test.js
- pnp.test.js
- resolve.test.js
- restrictions.test.js (partially done, regex is not supported yet)
- roots.test.js
- scoped-packages.test.js
- simple.test.js
- symlink.test.js
Irrelevant tests
- CachedInputFileSystem.test.js
- SyncAsyncFileSystemDecorator.test.js
- forEachBail.test.js
- getPaths.test.js
- pr-53.test.js
- unsafe-cache.test.js
- yield.test.js
π License
oxc_resolver is free and open-source software licensed under the MIT License.
Oxc partially copies code from the following projects.
| Project | License |
|---|---|
| webpack/enhanced-resolve | MIT |
| dividab/tsconfig-paths | MIT |
| parcel-bundler/parcel | MIT |
| tmccombs/json-comments-rs | Apache 2.0 |
2 Oct 12, 2022
4 Aug 25, 2022
51 Jul 4, 2023
15 Sep 2, 2023
10 Feb 21, 2023
3k Sep 20, 2021
26 Dec 15, 2022
3 May 3, 2023
2 Jul 8, 2023
11 Aug 14, 2023
29 Oct 9, 2023
3 Nov 21, 2023
3 Nov 28, 2023
5 Feb 9, 2024
81 Jun 29, 2022
63.8k Jan 7, 2023
15 May 2, 2022
3 Sep 18, 2022
3 Sep 18, 2022