feat: implement a new options argument for resolver with 100% compatibility

Author: JounQin

.changeset/four-pumas-leave.md

@@ -0,0 +1,5 @@
+---
+"eslint-plugin-import-x": minor
+---
+
+feat: implement a new `options` argument for `resolver` with 100% compatibility

resolvers/README.md

@@ -10,6 +10,9 @@ Currently, version 1 is assumed if no `interfaceVersion` is available. (didn't t
     - [Arguments](#arguments)
       - [`source`](#source)
       - [`file`](#file)
+      - [`options`](#options)
+        - [`options.context`](#optionscontext)
+        - [`options.tsconfig`](#optionstsconfig)
   - [Optional `name`](#optional-name)
   - [Example](#example)
 - [v2](#v2)
@@ -19,6 +22,8 @@ Currently, version 1 is assumed if no `interfaceVersion` is available. (didn't t
       - [`source`](#source-1)
       - [`file`](#file-1)
       - [`config`](#config)
+      - [`undefined`](#undefined)
+      - [`options`](#options-1)
   - [Example](#example-1)
 - [Shared `resolve` return value](#shared-resolve-return-value)
 
@@ -42,7 +47,7 @@ exports.interfaceVersion = 3
 
 ### Required `resolve`
 
-Signature: `(source: string, file: string) => { found: boolean, path?: string | null }`
+Signature: `(source: string, file: string, options: { context: ChildContext | RuleContext, tsconfig?: TsConfigJsonResolved }) => { found: boolean, path?: string | null }`
 
 Given:
 
@@ -64,7 +69,7 @@ export default [
         {
           name: 'my-cool-resolver',
           interfaceVersion: 3,
-          resolve(source, file) {
+          resolve(source, file, options) {
             // use a factory to get config outside of the resolver
           },
         },
@@ -89,6 +94,22 @@ the module identifier (`./imported-file`).
 
 the absolute path to the file making the import (`/some/path/to/module.js`)
 
+##### `options`
+
+###### `options.context`
+
+> [!NOTE]
+> Only available after `eslint-plugin-import-x@4.13.0+`
+
+Please view [ChildContext] and [RuleContext] for more details.
+
+###### `options.tsconfig`
+
+> [!NOTE]
+> Only available after `eslint-plugin-import-x@4.13.0+`
+
+Please view [TsConfigJsonResolved] for more details.
+
 ### Optional `name`
 
 the resolver name used in logs/debug output
@@ -204,6 +225,14 @@ the absolute path to the file making the import (`/some/path/to/module.js`)
 an object provided via the `import/resolver` setting. `my-cool-resolver` will get `["some", "stuff"]` as its `config`, while
 `node` will get `{ "paths": ["a", "b", "c"] }` provided as `config`.
 
+##### `undefined`
+
+For compatibility reason, the 4th argument is always passed as `undefined`. Take [TypeScript resolver](https://github.com/import-js/eslint-import-resolver-typescript/blob/c45039e5c310479c1e178c2180e054380facbadd/src/index.ts#L69) for example. It uses the 4th argument to pass the optional [unrs-resolver] `ResolverFactory` instance to support both `v2` and `v3` interface at the same time.
+
+##### `options`
+
+Same as [options](#options) in `v3` resolver above
+
 ### Example
 
 Here is most of the [Node resolver] at the time of this writing. It is just a wrapper around substack/Browserify's synchronous [`resolve`][resolve]:
@@ -212,7 +241,7 @@ Here is most of the [Node resolver] at the time of this writing. It is just a wr
 var resolve = require('resolve/sync')
 var isCoreModule = require('is-core-module')
 
-exports.resolve = function (source, file, config) {
+exports.resolve = function (source, file, config, _, options) {
   if (isCoreModule(source)) return { found: true, path: null }
   try {
     return { found: true, path: resolve(source, opts(file, config)) }
@@ -237,3 +266,6 @@ If the resolver cannot resolve `source` relative to `file`, it should just retur
 [Node resolver]: https://github.com/import-js/eslint-plugin-import/blob/main/resolvers/node/index.js
 [resolve]: https://www.npmjs.com/package/resolve
 [unrs-resolver]: https://www.npmjs.com/package/unrs-resolver
+[ChildContext]: https://github.com/un-ts/eslint-plugin-import-x/blob/685477fd509a3b5a91d68f349735198a4cf70020/src/types.ts#L137
+[RuleContext]: https://eslint.org/docs/latest/extend/custom-rules#the-context-object
+[TsConfigJsonResolved]: https://github.com/privatenumber/get-tsconfig/blob/8564f8821efa26cc53d2d60b2f63c013969dbe49/src/types.ts#L5C13-L5C33

src/types.ts

@@ -1,7 +1,8 @@
 import type { TSESLint, TSESTree } from '@typescript-eslint/utils'
+import type { TsConfigJsonResolved } from 'get-tsconfig'
 import type { MinimatchOptions } from 'minimatch'
 import type { KebabCase } from 'type-fest'
-import type { NapiResolveOptions as ResolveOptions } from 'unrs-resolver'
+import type { NapiResolveOptions } from 'unrs-resolver'
 
 import type {
   ImportType as ImportType_,
@@ -41,22 +42,31 @@ export interface NodeResolverOptions {
 }
 
 export interface WebpackResolverOptions {
-  config?: string | { resolve: ResolveOptions }
+  config?: string | { resolve: NapiResolveOptions }
   'config-index'?: number
   env?: Record<string, unknown>
   argv?: Record<string, unknown>
 }
 
-export interface TsResolverOptions extends ResolveOptions {
+export interface TsResolverOptions extends NapiResolveOptions {
   alwaysTryTypes?: boolean
   project?: string[] | string
   extensions?: string[]
 }
 
+export interface ResolveOptionsExtra {
+  tsconfig?: TsConfigJsonResolved
+}
+
+export interface ResolveOptions extends ResolveOptionsExtra {
+  context: ChildContext | RuleContext
+}
+
 // TODO: remove prefix New in the next major version
 export type NewResolverResolve = (
   modulePath: string,
   sourceFile: string,
+  options: ResolveOptions,
 ) => ResolvedResult
 
 // TODO: remove prefix New in the next major version
@@ -141,6 +151,7 @@ export interface ChildContext {
   parserOptions?: TSESLint.ParserOptions
   languageOptions?: TSESLint.FlatConfig.LanguageOptions
   path: string
+  cwd: string
   filename?: string
 }
 

src/utils/export-map.ts

@@ -90,6 +90,40 @@ const parseComment = (comment: string): commentParser.Block => {
   }
 }
 
+function getTsconfigInternal(context: ChildContext | RuleContext) {
+  const parserOptions = context.parserOptions || {}
+  let tsconfigRootDir = parserOptions.tsconfigRootDir
+  const project = parserOptions.project
+  const cacheKey = stableHash({ tsconfigRootDir, project })
+  let tsConfig: TsConfigJsonResolved | null | undefined
+
+  if (tsconfigCache.has(cacheKey)) {
+    tsConfig = tsconfigCache.get(cacheKey)!
+  } else {
+    tsconfigRootDir = tsconfigRootDir || process.cwd()
+    let tsconfigResult: TsConfigResult | null | undefined
+    if (project) {
+      const projects = Array.isArray(project) ? project : [project]
+      for (const project of projects) {
+        tsconfigResult = getTsconfig(
+          project === true
+            ? context.filename
+            : path.resolve(tsconfigRootDir, project),
+        )
+        if (tsconfigResult) {
+          break
+        }
+      }
+    } else {
+      tsconfigResult = getTsconfig(tsconfigRootDir)
+    }
+    tsConfig = tsconfigResult?.config
+    tsconfigCache.set(cacheKey, tsConfig)
+  }
+
+  return tsConfig
+}
+
 export class ExportMap {
   static for(context: ChildContext) {
     const filepath = context.path
@@ -161,7 +195,13 @@ export class ExportMap {
   }
 
   static get(source: string, context: RuleContext) {
-    const path = resolve(source, context)
+    const tsconfig = lazy(() => getTsconfigInternal(context))
+
+    const path = resolve(source, context, {
+      get tsconfig() {
+        return tsconfig()
+      },
+    })
     if (path == null) {
       return null
     }
@@ -171,7 +211,12 @@ export class ExportMap {
 
   static parse(filepath: string, content: string, context: ChildContext) {
     const m = new ExportMap(filepath)
-    const isEsModuleInteropTrue = lazy(isEsModuleInterop)
+
+    const tsconfig = lazy(() => getTsconfigInternal(context))
+
+    const isEsModuleInteropTrue = lazy(
+      () => tsconfig()?.compilerOptions?.esModuleInterop ?? false,
+    )
 
     let ast: TSESTree.Program
     let visitorKeys: TSESLint.SourceCode.VisitorKeys | null
@@ -243,7 +288,11 @@ export class ExportMap {
     const namespaces = new Map</* identifier */ string, /* source */ string>()
 
     function remotePath(value: string) {
-      return relative(value, filepath, context.settings)
+      return relative(value, filepath, context.settings, context, {
+        get tsconfig() {
+          return tsconfig()
+        },
+      })
     }
 
     function resolveImport(value: string) {
@@ -428,40 +477,6 @@ export class ExportMap {
 
     const source = new SourceCode({ text: content, ast: ast as AST.Program })
 
-    function isEsModuleInterop() {
-      const parserOptions = context.parserOptions || {}
-      let tsconfigRootDir = parserOptions.tsconfigRootDir
-      const project = parserOptions.project
-      const cacheKey = stableHash({ tsconfigRootDir, project })
-      let tsConfig: TsConfigJsonResolved | null | undefined
-
-      if (tsconfigCache.has(cacheKey)) {
-        tsConfig = tsconfigCache.get(cacheKey)!
-      } else {
-        tsconfigRootDir = tsconfigRootDir || process.cwd()
-        let tsconfigResult: TsConfigResult | null | undefined
-        if (project) {
-          const projects = Array.isArray(project) ? project : [project]
-          for (const project of projects) {
-            tsconfigResult = getTsconfig(
-              project === true
-                ? context.filename
-                : path.resolve(tsconfigRootDir, project),
-            )
-            if (tsconfigResult) {
-              break
-            }
-          }
-        } else {
-          tsconfigResult = getTsconfig(tsconfigRootDir)
-        }
-        tsConfig = tsconfigResult?.config
-        tsconfigCache.set(cacheKey, tsConfig)
-      }
-
-      return tsConfig?.compilerOptions?.esModuleInterop ?? false
-    }
-
     for (const n of ast.body) {
       if (n.type === 'ExportDefaultDeclaration') {
         const exportMeta = captureDoc(source, docStyleParsers, n)
@@ -1146,6 +1161,7 @@ function childContext(
     parserPath,
     languageOptions,
     path,
+    cwd: context.cwd,
     filename:
       'physicalFilename' in context
         ? context.physicalFilename

src/utils/legacy-resolver-settings.ts

@@ -7,8 +7,12 @@ import type { LiteralUnion } from 'type-fest'
 
 import { cjsRequire } from '../require.js'
 import type {
+  ChildContext,
   NodeResolverOptions,
   ResolvedResult,
+  ResolveOptions,
+  ResolveOptionsExtra,
+  RuleContext,
   TsResolverOptions,
   WebpackResolverOptions,
 } from '../types.js'
@@ -25,12 +29,16 @@ export type LegacyResolverResolveImport<T = unknown> = (
   modulePath: string,
   sourceFile: string,
   config: T,
+  _: undefined,
+  options: ResolveOptions,
 ) => string | undefined
 
 export type LegacyResolverResolve<T = unknown> = (
   modulePath: string,
   sourceFile: string,
   config: T,
+  _: undefined,
+  options: ResolveOptions,
 ) => ResolvedResult
 
 export interface LegacyResolver<T = unknown, U = T> {
@@ -77,13 +85,23 @@ export function resolveWithLegacyResolver(
   config: unknown,
   modulePath: string,
   sourceFile: string,
+  context: ChildContext | RuleContext,
+  extra: ResolveOptionsExtra,
 ): ResolvedResult {
+  const options = { context, ...extra }
+
   if (resolver.interfaceVersion === 2) {
-    return resolver.resolve(modulePath, sourceFile, config)
+    return resolver.resolve(modulePath, sourceFile, config, undefined, options)
   }
 
   try {
-    const resolved = resolver.resolveImport(modulePath, sourceFile, config)
+    const resolved = resolver.resolveImport(
+      modulePath,
+      sourceFile,
+      config,
+      undefined,
+      options,
+    )
     if (resolved === undefined) {
       return {
         found: false,