refactor: use eslint-import-context package instead

Author: JounQin

.changeset/four-pumas-leave.md

@@ -99,7 +99,7 @@ export default config(
       'import-x/no-extraneous-dependencies': [
         'error',
         {
-          devDependencies: ['test/**'],
+          devDependencies: ['test/**', 'tsdown.config.ts'],
           optionalDependencies: false,
           peerDependencies: true,
           bundledDependencies: false,

eslint.config.js

@@ -4,6 +4,7 @@
   "type": "module",
   "description": "Import with sanity.",
   "repository": "https://github.com/un-ts/eslint-plugin-import-x",
+  "homepage": "https://github.com/un-ts/eslint-plugin-import-x#readme",
   "author": "JounQin <admin@1stg.me> (https://www.1stG.me)",
   "funding": "https://opencollective.com/eslint-plugin-import-x",
   "license": "MIT",
@@ -12,7 +13,7 @@
     "node": "^18.18.0 || ^20.9.0 || >=21.1.0"
   },
   "main": "lib/index.cjs",
-  "types": "index.d.cts",
+  "types": "lib/index.d.cts",
   "module": "lib/index.js",
   "exports": {
     ".": {
@@ -21,7 +22,7 @@
         "default": "./lib/index.js"
       },
       "require": {
-        "types": "./index.d.cts",
+        "types": "./lib/index.d.cts",
         "default": "./lib/index.cjs"
       }
     },
@@ -32,9 +33,7 @@
     "./*": "./lib/*.js"
   },
   "files": [
-    "index.d.cts",
-    "lib",
-    "!lib/*.tsbuildinfo"
+    "lib"
   ],
   "keywords": [
     "eslint",
@@ -48,9 +47,9 @@
   ],
   "scripts": {
     "build": "run-p 'build:*'",
-    "build:r": "r -f cjs -e named",
     "build:tsc": "tsc -p src",
-    "clean": "rimraf lib",
+    "build:tsdown": "tsdown --no-clean -d lib -f cjs src/index.ts",
+    "clean": "premove coverage lib context/lib .eslintcache",
     "format": "prettier --write .",
     "lint": "run-p 'lint:*'",
     "lint:docs": "yarn update:eslint-docs --check",
@@ -70,8 +69,8 @@
     "@typescript-eslint/utils": "^8.31.0",
     "comment-parser": "^1.4.1",
     "debug": "^4.4.0",
+    "eslint-import-context": "^0.1.3",
     "eslint-import-resolver-node": "^0.3.9",
-    "get-tsconfig": "^4.10.0",
     "is-glob": "^4.0.3",
     "minimatch": "^9.0.3 || ^10.0.1",
     "semver": "^7.7.1",
@@ -101,7 +100,6 @@
     "@commitlint/cli": "^19.8.0",
     "@eslint/import-test-order-redirect-scoped": "link:./test/fixtures/order-redirect-scoped",
     "@eslint/js": "^9.25.1",
-    "@pkgr/rollup": "^6.0.3",
     "@swc-node/jest": "^1.8.13",
     "@swc/core": "^1.11.22",
     "@swc/helpers": "^0.5.17",
@@ -145,12 +143,13 @@
     "nano-staged": "^0.8.0",
     "npm-run-all2": "^7.0.2",
     "path-serializer": "^0.4.0",
+    "premove": "^4.0.0",
     "prettier": "^3.5.3",
     "redux": "^5.0.1",
-    "rimraf": "^6.0.1",
     "simple-git-hooks": "^2.13.0",
     "tinyexec": "^1.0.1",
     "ts-node": "^10.9.2",
+    "tsdown": "^0.12.2",
     "type-fest": "^4.40.0",
     "typescript": "^5.8.3",
     "typescript-eslint": "^8.31.0",

index.d.cts

@@ -3,5 +3,6 @@
   "compilerOptions": {
     "rootDir": ".",
     "outDir": "../lib"
-  }
+  },
+  "include": ["."]
 }

package.json

@@ -1,15 +1,8 @@
 import type { TSESLint, TSESTree } from '@typescript-eslint/utils'
-import type { TsConfigJsonResolved } from 'get-tsconfig'
+import type { PluginName, PluginSettings } from 'eslint-import-context'
 import type { MinimatchOptions } from 'minimatch'
-import type { KebabCase } from 'type-fest'
-import type { NapiResolveOptions } from 'unrs-resolver'
 
-import type {
-  ImportType as ImportType_,
-  LegacyImportResolver,
-  LegacyResolver,
-  PluginName,
-} from './utils/index.js'
+import type { ImportType as ImportType_ } from './utils/index.js'
 
 export type {
   LegacyResolver,
@@ -31,97 +24,28 @@ export type {
   // ResolverObject
   LegacyResolverObject,
   LegacyResolverObject as ResolverObject,
-} from './utils/index.js'
+  NodeResolverOptions,
+  WebpackResolverOptions,
+  TsResolverOptions,
+  NewResolverResolve,
+  NewResolver,
+  FileExtension,
+  DocStyle,
+  ResultNotFound,
+  ResultFound,
+  Resolver,
+  ResolvedResult,
+  ImportSettings,
+  WithPluginName,
+  PluginSettings,
+  RuleContext,
+  ChildContext,
+} from 'eslint-import-context'
 
 export type ImportType = ImportType_ | 'object' | 'type'
 
-export interface NodeResolverOptions {
-  extensions?: readonly string[]
-  moduleDirectory?: string[]
-  paths?: string[]
-}
-
-export interface WebpackResolverOptions {
-  config?: string | { resolve: NapiResolveOptions }
-  'config-index'?: number
-  env?: Record<string, unknown>
-  argv?: Record<string, unknown>
-}
-
-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
-export interface NewResolver {
-  interfaceVersion: 3
-  /** Optional name for the resolver, this is used in logs/debug output */
-  name?: string
-  resolve: NewResolverResolve
-}
-
-export type FileExtension = `.${string}`
-
-export type DocStyle = 'jsdoc' | 'tomdoc'
-
 export type Arrayable<T> = T | readonly T[]
 
-export interface ResultNotFound {
-  found: false
-  path?: undefined
-}
-
-export interface ResultFound {
-  found: true
-  path: string | null
-}
-
-export type Resolver = LegacyResolver | NewResolver
-
-export type ResolvedResult = ResultNotFound | ResultFound
-
-export interface ImportSettings {
-  cache?: {
-    lifetime?: number | '∞' | 'Infinity'
-  }
-  coreModules?: string[]
-  docstyle?: DocStyle[]
-  extensions?: readonly FileExtension[]
-  externalModuleFolders?: string[]
-  ignore?: string[]
-  internalRegex?: string
-  parsers?: Record<string, readonly FileExtension[]>
-  resolve?: NodeResolverOptions
-  resolver?: LegacyImportResolver
-  'resolver-legacy'?: LegacyImportResolver
-  'resolver-next'?: NewResolver[] | NewResolver
-}
-
-export type WithPluginName<T extends string | object> = T extends string
-  ? `${PluginName}/${KebabCase<T>}`
-  : {
-      [K in keyof T as WithPluginName<`${KebabCase<K & string>}`>]: T[K]
-    }
-
-export type PluginSettings = WithPluginName<ImportSettings>
-
 export interface PluginConfig extends TSESLint.ClassicConfig.Config {
   plugins?: [PluginName]
   settings?: PluginSettings
@@ -137,25 +61,6 @@ export interface PluginFlatConfig extends PluginFlatBaseConfig {
   name?: `${PluginName}/${string}`
 }
 
-export interface RuleContext<
-  TMessageIds extends string = string,
-  TOptions extends readonly unknown[] = readonly unknown[],
-> extends Omit<TSESLint.RuleContext<TMessageIds, TOptions>, 'settings'> {
-  settings: PluginSettings
-}
-
-export interface ChildContext {
-  cacheKey: string
-  settings: PluginSettings
-  parserPath?: string | null
-  parserOptions?: TSESLint.ParserOptions
-  languageOptions?: TSESLint.FlatConfig.LanguageOptions
-  path: string
-  cwd: string
-  filename: string
-  physicalFilename: string
-}
-
 export interface ParseError extends Error {
   lineNumber: number
   column: number

src/tsconfig.json

@@ -1,13 +1,11 @@
 import fs from 'node:fs'
-import path from 'node:path'
 
 import type { TSESLint, TSESTree } from '@typescript-eslint/utils'
 import type * as commentParser from 'comment-parser'
 import debug from 'debug'
 import type { AST } from 'eslint'
 import { SourceCode } from 'eslint'
-import type { TsConfigJsonResolved, TsConfigResult } from 'get-tsconfig'
-import { getTsconfig } from 'get-tsconfig'
+import { getTsconfigWithContext } from 'eslint-import-context'
 import { stableHash } from 'stable-hash'
 
 import { cjsRequire } from '../require.js'
@@ -32,8 +30,6 @@ const log = debug('eslint-plugin-import-x:ExportMap')
 
 const exportCache = new Map<string, ExportMap | null>()
 
-const tsconfigCache = new Map<string, TsConfigJsonResolved | null | undefined>()
-
 export type DocStyleParsers = Record<
   DocStyle,
   (comments: TSESTree.Comment[]) => commentParser.Block | undefined
@@ -90,43 +86,6 @@ const parseComment = (comment: string): commentParser.Block => {
   }
 }
 
-export function getTsconfigWithContext(context: ChildContext | RuleContext) {
-  const parserOptions =
-    context.languageOptions?.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 ||
-      // TODO: uncomment in next major
-      // || context.cwd
-      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.physicalFilename
-            : 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
@@ -198,13 +157,8 @@ export class ExportMap {
   }
 
   static get(source: string, context: RuleContext) {
-    const tsconfig = lazy(() => getTsconfigWithContext(context))
+    const path = resolve(source, context)
 
-    const path = resolve(
-      source,
-      context,
-      defineLazyProperty({}, 'tsconfig', tsconfig),
-    )
     if (path == null) {
       return null
     }
@@ -291,13 +245,7 @@ export class ExportMap {
     const namespaces = new Map</* identifier */ string, /* source */ string>()
 
     function remotePath(value: string) {
-      return relative(
-        value,
-        filepath,
-        context.settings,
-        context,
-        defineLazyProperty({}, 'tsconfig', tsconfig),
-      )
+      return relative(value, filepath, context.settings, context)
     }
 
     function resolveImport(value: string) {

src/types.ts

@@ -1,4 +1,5 @@
-export * from './constants.js'
+export type * from 'eslint-import-context'
+
 export * from './create-rule.js'
 export * from './declared-scope.js'
 export * from './docs-url.js'