feat: implement interface version 3 (#41)

* feat: implement interface version 3

* test: fix tests w/ eslint-plugin-import-x@4.5.0

* refactor: rename v3 interface factory function

* chore: update

---------

Co-authored-by: Vida Xie <38204901+9romise@users.noreply.github.com>

Author: SukkaW

pnpm-lock.yaml

@@ -5,19 +5,24 @@ import { ResolverFactory } from 'oxc-resolver'
 import { normalizeOptions } from './normalizeOptions'
 import { hashObject } from './utils'
 
-let cacheOptionsHash: string | undefined
-let resolver: ResolverFactory | undefined
-export function resolve(source: string, file: string, options?: NapiResolveOptions | null): { found: boolean, path: string | null | undefined } {
+let cachedOptionsHash: string | undefined
+let cachedResolver: ResolverFactory | undefined
+
+export function resolve(source: string, file: string, options?: NapiResolveOptions | null, resolver: ResolverFactory | null = null): { found: boolean, path: string | null | undefined } {
   if (isBuiltin(source))
     return { found: true, path: null }
 
-  options ??= {}
-  const optionsHash = hashObject(options)
+  if (resolver == null) {
+    options ??= {}
+    const optionsHash = hashObject(options)
+
+    if (!cachedResolver || cachedOptionsHash !== optionsHash) {
+      options = normalizeOptions(options)
+      cachedResolver = new ResolverFactory(options)
+      cachedOptionsHash = optionsHash
+    }
 
-  if (!resolver || cacheOptionsHash !== optionsHash) {
-    options = normalizeOptions(options)
-    resolver = new ResolverFactory(options)
-    cacheOptionsHash = optionsHash
+    resolver = cachedResolver
   }
 
   // https://github.com/oxc-project/oxc-resolver/blob/main/npm/README.md#api
@@ -30,3 +35,15 @@ export function resolve(source: string, file: string, options?: NapiResolveOptio
 }
 
 export const interfaceVersion = 2
+
+export function createOxcImportResolver(options?: NapiResolveOptions | null) {
+  const resolver = new ResolverFactory(normalizeOptions(options))
+
+  return {
+    interfaceVersion: 3,
+    name: 'eslint-import-resolver-oxc',
+    resolve(source: string, file: string) {
+      return resolve(source, file, null, resolver)
+    },
+  }
+}

src/index.ts

@@ -2,7 +2,8 @@ import { run } from '../utils'
 
 function createCycleSourceError(p: string) {
   return {
-    message: `Dependency cycle via ${p}`,
+    messageId: 'cycleSource',
+    data: { source: p },
   }
 }
 

tests/eslint-plugin/rules/no-cycle.test.ts

@@ -1,5 +1,4 @@
-import type { NapiResolveOptions } from 'oxc-resolver'
-import { oxcResolver, run, testFilePath } from '../utils'
+import { createOxcImportResolver, run, testFilePath } from '../utils'
 
 run({
   rule: 'no-extraneous-dependencies',
@@ -13,27 +12,27 @@ run({
     {
       code: 'import "@custom-internal-alias/api/service";',
       settings: {
-        'import-x/resolver': {
-          [oxcResolver]: {
+        'import-x/resolver-next': [
+          createOxcImportResolver({
             alias: {
               '@custom-internal-alias': [testFilePath('internal-modules')],
             },
-          } satisfies NapiResolveOptions,
-        },
+          }),
+        ],
       },
     },
   ],
   invalid: [
     {
       code: 'import jest from "alias/jest";',
       settings: {
-        'import-x/resolver': {
-          [oxcResolver]: {
+        'import-x/resolver-next': [
+          createOxcImportResolver({
             alias: {
               'alias/jest': ['jest'],
             },
-          } satisfies NapiResolveOptions,
-        },
+          }),
+        ],
       },
       errors: [
       // missing dependency is jest not alias

tests/eslint-plugin/rules/no-extraneous-dependencies.test.ts

@@ -1,5 +1,4 @@
-import type { NapiResolveOptions } from 'oxc-resolver'
-import { oxcResolver, run, testFilePath } from '../utils'
+import { createOxcImportResolver, run, testFilePath } from '../utils'
 
 run({
   rule: 'no-internal-modules',
@@ -19,13 +18,13 @@ run({
         },
       ],
       settings: {
-        'import-x/resolver': {
-          [oxcResolver]: {
+        'import-x/resolver-next': [
+          createOxcImportResolver({
             alias: {
               '@': [testFilePath('internal-modules')],
             },
-          } satisfies NapiResolveOptions,
-        },
+          }),
+        ],
       },
     },
   ],

tests/eslint-plugin/rules/no-internal-modules.test.ts

@@ -1,5 +1,4 @@
-import type { NapiResolveOptions } from 'oxc-resolver'
-import { oxcResolver, run, testFilePath } from '../utils'
+import { createOxcImportResolver, run, testFilePath } from '../utils'
 
 run({
   rule: 'order',
@@ -54,13 +53,13 @@ run({
         },
       ],
       settings: {
-        'import-x/resolver': {
-          [oxcResolver]: {
+        'import-x/resolver-next': [
+          createOxcImportResolver({
             alias: {
               '@': [testFilePath('internal-modules')],
             },
-          } satisfies NapiResolveOptions,
-        },
+          }),
+        ],
       },
     },
   ],

tests/eslint-plugin/rules/order.test.ts

@@ -1,13 +1,13 @@
 import type { RuleTesterInitOptions, TestCasesOptions } from 'eslint-vitest-rule-tester'
-import type { NapiResolveOptions } from 'oxc-resolver'
 import path from 'node:path'
-import { cwd } from 'node:process'
 import tsParser from '@typescript-eslint/parser'
 import { rules } from 'eslint-plugin-import-x'
 import { run as _run } from 'eslint-vitest-rule-tester'
+import { createOxcImportResolver } from '../../src'
 
-export * from 'eslint-vitest-rule-tester'
+export { createOxcImportResolver } from '../../src'
 export { unindent as $ } from 'eslint-vitest-rule-tester'
+export * from 'eslint-vitest-rule-tester'
 
 export interface ExtendedRuleTesterOptions extends RuleTesterInitOptions, TestCasesOptions {
   lang?: 'js' | 'ts'
@@ -25,8 +25,6 @@ const defaultFilenames = {
   ts: 'tests/eslint-plugin/fixtures/foo.ts',
 }
 
-export const oxcResolver = path.resolve(cwd(), 'dist/index.cjs')
-
 export function run(options: ExtendedRuleTesterOptions) {
   return _run({
     recursive: false,
@@ -35,15 +33,15 @@ export function run(options: ExtendedRuleTesterOptions) {
     configs: {
       settings: {
         ...(options.lang === 'js' ? {} : { 'import-x/parsers': { [require.resolve('@typescript-eslint/parser')]: ['.ts'] } }),
-        'import-x/resolver': {
-          [oxcResolver]: {
+        'import-x/resolver-next': [
+          createOxcImportResolver({
             tsconfig: {
               configFile: path.resolve(FIXTURES_PATH, 'tsconfig.json'),
               references: 'auto',
             },
             roots: [FIXTURES_PATH],
-          } satisfies NapiResolveOptions,
-        },
+          }),
+        ],
       },
     },
     ...(options.lang === 'js' ? {} : { parser: tsParser as any }),