feat: migrate enhanced-resolve to oxc-resolver

.changeset/dirty-rabbits-pretend.md

@@ -0,0 +1,5 @@
+---
+"eslint-plugin-import-x": minor
+---
+
+feat: migrate `enhanced-resolve` to `oxc-resolver`

.github/workflows/ci.yml

@@ -6,7 +6,7 @@ on:
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
-  cancel-in-progress: ${{ github.event_name == 'pull_request' }}
+  cancel-in-progress: true
 
 jobs:
   ci:
@@ -30,6 +30,7 @@ jobs:
           - executeLint: true
             node: 20
             os: ubuntu-latest
+      fail-fast: false
 
     runs-on: ${{ matrix.os }}
     steps:

jest.config.ts

@@ -13,6 +13,7 @@ export default {
     '^eslint-plugin-import-x/package.json$': `<rootDir>/package.json`,
     '^eslint-plugin-import-x/(.+)$': `<rootDir>/${srcDir}/$1`,
   },
+  snapshotSerializers: ['<rootDir>/test/jest.serializer.ts'],
   testMatch: ['<rootDir>/test/**/*.spec.ts'],
   transform: {
     '^.+\\.(t|j)sx?$': ['@swc-node/jest', {} satisfies SwcOptions],

package.json

@@ -53,11 +53,11 @@
     "@typescript-eslint/utils": "^8.1.0",
     "debug": "^4.3.4",
     "doctrine": "^3.0.0",
-    "enhanced-resolve": "^5.17.1",
     "eslint-import-resolver-node": "^0.3.9",
     "get-tsconfig": "^4.7.3",
     "is-glob": "^4.0.3",
     "minimatch": "^9.0.3",
+    "oxc-resolver": "^5.0.0",
     "semver": "^7.6.3",
     "stable-hash": "^0.0.4",
     "tslib": "^2.6.3"
@@ -117,6 +117,7 @@
     "jest": "^29.7.0",
     "klaw-sync": "^6.0.0",
     "npm-run-all2": "^6.1.2",
+    "path-serializer": "^0.3.4",
     "prettier": "^3.2.5",
     "redux": "^5.0.1",
     "rimraf": "^5.0.10",

src/node-resolver.ts

@@ -1,40 +1,45 @@
-import fs from 'node:fs'
 import { isBuiltin } from 'node:module'
 import path from 'node:path'
 
-import { ResolverFactory, CachedInputFileSystem } from 'enhanced-resolve'
-import type { ResolveOptions } from 'enhanced-resolve'
+import { ResolverFactory } from 'oxc-resolver'
+import type { NapiResolveOptions as ResolveOptions } from 'oxc-resolver'
 
 import type { NewResolver } from './types'
 
-type NodeResolverOptions = {
+export type NodeResolverOptions = {
   /**
-   * The allowed extensions the resolver will attempt to find when resolving a module
-   * @type {string[] | undefined}
+   * Attempt to resolve these extensions in order.
+   * If multiple files share the same name but have different extensions,
+   * will resolve the one with the extension listed first in the array and skip the rest.
+   *
    * @default ['.mjs', '.cjs', '.js', '.json', '.node']
    */
   extensions?: string[]
   /**
-   * The import conditions the resolver will used when reading the exports map from "package.json"
-   * @type {string[] | undefined}
-   * @default ['default', 'module', 'import', 'require']
+   * Condition names for exports field which defines entry points of a package.
+   * The key order in the exports field is significant. During condition matching, earlier entries have higher priority and take precedence over later entries.
+   *
+   * @default ['import', 'require', 'default']
    */
   conditionNames?: string[]
-} & Omit<ResolveOptions, 'useSyncFileSystemCalls'>
+  /**
+   * A list of main fields in description files
+   *
+   * @default ['module', 'main']
+   */
+  mainFields?: string[]
+} & ResolveOptions
 
 export function createNodeResolver({
   extensions = ['.mjs', '.cjs', '.js', '.json', '.node'],
   conditionNames = ['import', 'require', 'default'],
   mainFields = ['module', 'main'],
-  fileSystem = new CachedInputFileSystem(fs, 4 * 1000),
   ...restOptions
-}: Partial<NodeResolverOptions> = {}): NewResolver {
-  const resolver = ResolverFactory.createResolver({
+}: NodeResolverOptions = {}): NewResolver {
+  const resolver = new ResolverFactory({
     extensions,
-    fileSystem,
     conditionNames,
     mainFields,
-    useSyncFileSystemCalls: true,
     ...restOptions,
   })
 
@@ -43,7 +48,7 @@ export function createNodeResolver({
   return {
     interfaceVersion: 3,
     name: 'eslint-plugin-import-x built-in node resolver',
-    resolve: (modulePath, sourceFile) => {
+    resolve(modulePath, sourceFile) {
       if (isBuiltin(modulePath)) {
         return { found: true, path: null }
       }
@@ -53,13 +58,9 @@ export function createNodeResolver({
       }
 
       try {
-        const resolved = resolver.resolveSync(
-          {},
-          path.dirname(sourceFile),
-          modulePath,
-        )
-        if (resolved) {
-          return { found: true, path: resolved }
+        const resolved = resolver.sync(path.dirname(sourceFile), modulePath)
+        if (resolved.path) {
+          return { found: true, path: resolved.path }
         }
         return { found: false }
       } catch {

src/types.ts

@@ -1,6 +1,6 @@
 import type { TSESLint, TSESTree } from '@typescript-eslint/utils'
-import type { ResolveOptions } from 'enhanced-resolve'
 import type { MinimatchOptions } from 'minimatch'
+import type { NapiResolveOptions as ResolveOptions } from 'oxc-resolver'
 import type { KebabCase } from 'type-fest'
 
 import type { ImportType as ImportType_, PluginName } from './utils'
@@ -40,7 +40,7 @@ export type NodeResolverOptions = {
 }
 
 export type WebpackResolverOptions = {
-  config?: string | { resolve: Omit<ResolveOptions, 'fileSystem'> }
+  config?: string | { resolve: ResolveOptions }
   'config-index'?: number
   env?: Record<string, unknown>
   argv?: Record<string, unknown>
@@ -50,7 +50,7 @@ export type TsResolverOptions = {
   alwaysTryTypes?: boolean
   project?: string[] | string
   extensions?: string[]
-} & Omit<ResolveOptions, 'fileSystem' | 'useSyncFileSystemCalls'>
+} & ResolveOptions
 
 // TODO: remove prefix New in the next major version
 export type NewResolverResolve = (

src/utils/parse.ts

@@ -146,7 +146,7 @@ export function parse(
     if (!ast || typeof ast !== 'object') {
       console.warn(
         // Can only be invalid for custom parser per imports/parser
-        `\`parseForESLint\` from parser \`${typeof parserOrPath === 'string' ? parserOrPath : '`context.languageOptions.parser`'}\` is invalid and will just be ignored`,
+        `\`parseForESLint\` from parser \`${typeof parserOrPath === 'string' ? parserOrPath : 'context.languageOptions.parser'}\` is invalid and will just be ignored`,
         { content, parserMeta: parser.meta },
       )
     } else {

test/__snapshots__/node-resolver.spec.ts.snap

@@ -0,0 +1,207 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`builtin node:path => true 1`] = `
+{
+  "expected": true,
+  "requireResolve": "node:path",
+  "source": "node:path",
+}
+`;
+
+exports[`builtin node:path => true 2`] = `
+{
+  "expected": true,
+  "result": {
+    "found": true,
+    "path": null,
+  },
+  "source": "node:path",
+}
+`;
+
+exports[`builtin path => true 1`] = `
+{
+  "expected": true,
+  "requireResolve": "path",
+  "source": "path",
+}
+`;
+
+exports[`builtin path => true 2`] = `
+{
+  "expected": true,
+  "result": {
+    "found": true,
+    "path": null,
+  },
+  "source": "path",
+}
+`;
+
+exports[`modules @sukka/does-not-exists => false 1`] = `
+{
+  "expected": false,
+  "requireResolve": undefined,
+  "source": "@sukka/does-not-exists",
+}
+`;
+
+exports[`modules @sukka/does-not-exists => false 2`] = `
+{
+  "expected": false,
+  "result": {
+    "found": false,
+  },
+  "source": "@sukka/does-not-exists",
+}
+`;
+
+exports[`modules jest => true 1`] = `
+{
+  "expected": true,
+  "requireResolve": "<ROOT>/node_modules/jest/build/index.js",
+  "source": "jest",
+}
+`;
+
+exports[`modules jest => true 2`] = `
+{
+  "expected": true,
+  "result": {
+    "found": true,
+    "path": "<ROOT>/node_modules/jest/build/index.js",
+  },
+  "source": "jest",
+}
+`;
+
+exports[`relative ../.github/dependabot.yml => false 1`] = `
+{
+  "expected": false,
+  "requireResolve": undefined,
+  "source": "../.github/dependabot.yml",
+}
+`;
+
+exports[`relative ../.github/dependabot.yml => false 2`] = `
+{
+  "expected": false,
+  "result": {
+    "found": false,
+  },
+  "source": "../.github/dependabot.yml",
+}
+`;
+
+exports[`relative ../babel.config.js => babel.config.js 1`] = `
+{
+  "expected": "babel.config.js",
+  "requireResolve": "<ROOT>/babel.config.js",
+  "source": "../babel.config.js",
+}
+`;
+
+exports[`relative ../babel.config.js => babel.config.js 2`] = `
+{
+  "expected": "babel.config.js",
+  "result": {
+    "found": true,
+    "path": "<ROOT>/babel.config.js",
+  },
+  "source": "../babel.config.js",
+}
+`;
+
+exports[`relative ../inexistent.js => false 1`] = `
+{
+  "expected": false,
+  "requireResolve": undefined,
+  "source": "../inexistent.js",
+}
+`;
+
+exports[`relative ../inexistent.js => false 2`] = `
+{
+  "expected": false,
+  "result": {
+    "found": false,
+  },
+  "source": "../inexistent.js",
+}
+`;
+
+exports[`relative ../package.json => package.json 1`] = `
+{
+  "expected": "package.json",
+  "requireResolve": "<ROOT>/package.json",
+  "source": "../package.json",
+}
+`;
+
+exports[`relative ../package.json => package.json 2`] = `
+{
+  "expected": "package.json",
+  "result": {
+    "found": true,
+    "path": "<ROOT>/package.json",
+  },
+  "source": "../package.json",
+}
+`;
+
+exports[`relative ../test => test/index.js 1`] = `
+{
+  "expected": "test/index.js",
+  "requireResolve": "<ROOT>/test/index.js",
+  "source": "../test",
+}
+`;
+
+exports[`relative ../test => test/index.js 2`] = `
+{
+  "expected": "test/index.js",
+  "result": {
+    "found": true,
+    "path": "<ROOT>/test/index.js",
+  },
+  "source": "../test",
+}
+`;
+
+exports[`relative ../test/ => test/index.js 1`] = `
+{
+  "expected": "test/index.js",
+  "requireResolve": "<ROOT>/test/index.js",
+  "source": "../test/",
+}
+`;
+
+exports[`relative ../test/ => test/index.js 2`] = `
+{
+  "expected": "test/index.js",
+  "result": {
+    "found": true,
+    "path": "<ROOT>/test/index.js",
+  },
+  "source": "../test/",
+}
+`;
+
+exports[`relative ../test/index.js => test/index.js 1`] = `
+{
+  "expected": "test/index.js",
+  "requireResolve": "<ROOT>/test/index.js",
+  "source": "../test/index.js",
+}
+`;
+
+exports[`relative ../test/index.js => test/index.js 2`] = `
+{
+  "expected": "test/index.js",
+  "result": {
+    "found": true,
+    "path": "<ROOT>/test/index.js",
+  },
+  "source": "../test/index.js",
+}
+`;

test/jest.serializer.ts

@@ -0,0 +1,6 @@
+import { createSnapshotSerializer } from 'path-serializer'
+
+const serializer: ReturnType<typeof createSnapshotSerializer> =
+  createSnapshotSerializer()
+
+export = serializer