Oxc Resolver

Rust port of [enhanced-resolve], [tsconfig-paths-webpack-plugin] and [tsconfck]

- Released on crates.io and npm.
- Implements the ESM and CommonJS module resolution algorithm specification.
- 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 template variable ${configDir} for substitution of config files directory path
- Built-in tsconfig discovery ([tsconfck])
- Supports in-memory file system via the FileSystem trait.
- Contains tracing instrumentation.

Usage

$3

See index.d.ts for resolveSync and ResolverFactory API.

Quick example:

``javascript
import assert from "assert";
import path from "path";
import resolve, { ResolverFactory } from "./index.js";

// resolve
assert(resolve.sync(process.cwd(), "./index.js").path, path.join(cwd, "index.js"));

// ResolverFactory
const resolver = new ResolverFactory();
assert(resolver.sync(process.cwd(), "./index.js").path, path.join(cwd, "index.js"));
`

#### File-based Resolution

For file-based resolution with automatic tsconfig discovery, use resolveFileSync or resolveFileAsync:

`javascript
const resolver = new ResolverFactory();

// Resolves from a file path (not directory)
const result = resolver.resolveFileSync("/path/to/file.ts", "./module");

// Async version
const result = await resolver.resolveFileAsync("/path/to/file.ts", "./module");
`

Key Differences:

- sync(directory, specifier) - Takes a directory path, uses manually configured tsconfig if provided
- resolveFileSync(file, specifier) - Takes a file path, automatically discovers tsconfig.json by traversing parent directories

Why use resolveFileSync?

When resolving from a specific file (e.g., in bundlers, linters, or language servers), resolveFileSync automatically finds the correct tsconfig.json by:

- Traversing parent directories from the file location
- Respecting TypeScript project references
- Honoring include, exclude, and files fields to determine which tsconfig applies
- Ensuring tsconfig paths aliases work correctly based on the file's context

#### Supports WASM

See https://stackblitz.com/edit/oxc-resolver for usage example.

$3

See docs.rs/oxc_resolver.

$3

- For node.js, yarn pnp should work without any configuration, given the following conditions:
- the program is called with the yarn command, where the value process.versions.pnp is set.
- .pnp.cjs manifest file exists in the closest directory, searched from the current working directory,
- no multi-project setup, per second bullet point in FIND_PNP_MANIFEST

Terminology

$3

An absolute path to a directory where the specifier is resolved against.

For CommonJS modules, it is the __dirname variable that contains the absolute path to the folder containing current module.

For ECMAScript modules, it is the value of import.meta.url.

Behavior is undefined when given a path to a file.

$3

The string passed to require or import, i.e. require("specifier") or import "specifier"

Errors and Trouble Shooting

- Error: Package subpath '.' is not defined by "exports" in - occurs when resolving without conditionNames.

Configuration

The following usages apply to both Rust and Node.js; the code snippets are written in JavaScript.

To handle the exports field in package.json, ESM and CJS need to be differentiated.

$3

Per ESM Resolution algorithm

> defaultConditions is the conditional environment name array, ["node", "import"].

This means when the caller is an ESM import (import "module"), resolve options should be

`javascript
{
"conditionNames": ["node", "import"]
}
`

$3

Per CJS Resolution algorithm

> LOAD_PACKAGE_EXPORTS(X, DIR)
>
> 5. let MATCH = PACKAGE_EXPORTS_RESOLVE(pathToFileURL(DIR/NAME), "." + SUBPATH,
> package.json "exports", ["node", "require"]) defined in the ESM resolver.

This means when the caller is a CJS require (require("module")), resolve options should be

`javascript
{
"conditionNames": ["node", "require"]
}
`

$3

To support both CJS and ESM with the same cache:

`javascript
const esmResolver = new ResolverFactory({
conditionNames: ["node", "import"],
});

const cjsResolver = esmResolver.cloneWithOptions({
conditionNames: ["node", "require"],
});
`

$3

From this non-standard spec:

> The browser field is provided to JavaScript bundlers or component tools when packaging modules for client side use.

The option is

`javascript
{
"aliasFields": ["browser"]
}
`

$3

`javascript
{
"mainFields": ["module", "main"]
}
`

Quoting esbuild's documentation:

- main - This is the standard field for all packages that are meant to be used with node. The name main is hard-coded in to node's module resolution logic itself. Because it's intended for use with node, it's reasonable to expect that the file path in this field is a CommonJS-style module.
- module - This field came from a proposal for how to integrate ECMAScript modules into node. Because of this, it's reasonable to expect that the file path in this field is an ECMAScript-style module. This proposal wasn't adopted by node (node uses "type": "module" instead) but it was adopted by major bundlers because ECMAScript-style modules lead to better tree shaking, or dead code removal.
- browser - This field came from a proposal that allows bundlers to replace node-specific files or modules with their browser-friendly versions. It lets you specify an alternate browser-specific entry point. Note that it is possible for a package to use both the browser and module field together (see the note below).

Options

The following options are aligned with [enhanced-resolve], and is implemented for Rust crate usage.

See index.d.ts for Node.js usage.

| Field | Default | Description |
| ------------------------------------- | ------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| alias | {} | A hash map of module alias configurations |
| 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 |
| enforceExtension | false | Enforce that an 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 |
| allowPackageExportsInDirectoryResolve | false | Allow exports field in require('../directory'). Not part of enhanced-resolve. |

$3

| Field | Default | Description |
| ------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| tsconfig | None | TypeScript related config for resolver |
| tsconfig.configFile | | A relative path to the tsconfig file based on cwd, or an absolute path to the tsconfig file. |
| tsconfig.references | [] | - 'auto': inherits from TypeScript config
- string []: relative path (based on directory of the referencing tsconfig file) or absolute path of referenced project's tsconfig |

$3

| Field | Default | Description |
| ---------------- | --------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
| descriptionFiles | ["package.json"] | A list of description files to read from |
| 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

The following environment variable emits tracing information for the oxc_resolver::resolve function.

e.g.

`
2024-06-11T07:12:20.003537Z DEBUG oxc_resolver: options: ResolveOptions { ... }, path: "...", specifier: "...", ret: "..."
at /path/to/oxc_resolver-1.8.1/src/lib.rs:212
in oxc_resolver::resolve with path: "...", specifier: "..."
`

The input values are options, path and specifier, the returned value is ret.

$3

`
OXC_LOG=DEBUG your_program
`

$3

`bash
RD_LOG='oxc_resolver' rolldown 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

- [x] alias.test.js
- [x] browserField.test.js
- [x] dependencies.test.js
- [x] exportsField.test.js
- [x] extension-alias.test.js
- [x] extensions.test.js
- [x] fallback.test.js
- [x] fullSpecified.test.js
- [x] identifier.test.js (see unit test in crates/oxc_resolver/src/request.rs)
- [x] importsField.test.js
- [x] incorrect-description-file.test.js (need to add ctx.fileDependencies)
- [x] missing.test.js
- [x] path.test.js (see unit test in crates/oxc_resolver/src/path.rs)
- [ ] plugins.test.js
- [ ] pnp.test.js
- [x] resolve.test.js
- [x] restrictions.test.js (partially done, regex is not supported yet)
- [x] roots.test.js
- [x] scoped-packages.test.js
- [x] simple.test.js
- [x] 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

Sponsored By

📖 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 |
| dominikg/tsconfck | MIT |

[enhanced-resolve]: https://github.com/webpack/enhanced-resolve
[tsconfig-paths-webpack-plugin]: https://github.com/dividab/tsconfig-paths-webpack-plugin
[discord-badge]: https://img.shields.io/discord/1079625926024900739?logo=discord&label=Discord
[discord-url]: https://discord.gg/9uXCAwqQZW
[license-badge]: https://img.shields.io/badge/license-MIT-blue.svg
[license-url]: https://github.com/oxc-project/oxc-resolver/blob/main/LICENSE
[ci-badge]: https://github.com/oxc-project/oxc-resolver/actions/workflows/ci.yml/badge.svg?event=push&branch=main
[ci-url]: https://github.com/oxc-project/oxc-resolver/actions/workflows/ci.yml?query=event%3Apush+branch%3Amain
[code-coverage-badge]: https://codecov.io/github/oxc-project/oxc-resolver/branch/main/graph/badge.svg
[code-coverage-url]: https://codecov.io/gh/oxc-project/oxc-resolver
[sponsors-badge]: https://img.shields.io/github/sponsors/Boshen
[sponsors-url]: https://github.com/sponsors/Boshen
[codspeed-badge]: https://img.shields.io/endpoint?url=https://codspeed.io/badge.json
[codspeed-url]: https://codspeed.io/oxc-project/oxc-resolver
[crates-badge]: https://img.shields.io/crates/dr/oxc_resolver
[crates-url]: https://crates.io/crates/oxc_resolver
[docs-badge]: https://img.shields.io/docsrs/oxc_resolver
[docs-url]: https://docs.rs/oxc_resolver/latest/oxc_resolver
[npm-badge]: https://img.shields.io/npm/dw/oxc-resolver?label=npm
[npm-url]: https://www.npmjs.com/package/oxc-resolver
[tsconfck]: https://github.com/dominikg/tsconfck