feat: integrate eslint-import-context to get rule context without additional params (#335)

Author: JounQin

.changeset/tired-lizards-talk.md

@@ -0,0 +1,5 @@
+---
+"eslint-plugin-import-x": minor
+---
+
+feat: integrate `eslint-import-context` to get rule context without additional params

.github/workflows/ci.yml

@@ -63,7 +63,7 @@ jobs:
           PARSER_NO_WATCH: true
 
       - name: Codecov
-        uses: codecov/codecov-action@ad3126e916f78f00edff4ed0317cf185271ccc2d # v5.4.2
+        uses: codecov/codecov-action@18283e04ce6e62d37312384ff67231eb8fd56d24 # v5.4.3
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
 

.prettierignore

@@ -1,4 +1,5 @@
 .yarn
+.pnp.*
 test/fixtures/just-json-files/invalid.json
 test/fixtures/malformed.js
 test/fixtures/with-syntax-error/package.json

index.d.cts

@@ -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 <[email protected]> (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,7 +33,6 @@
     "./*": "./lib/*.js"
   },
   "files": [
-    "index.d.cts",
     "lib",
     "!lib/*.tsbuildinfo"
   ],
@@ -48,9 +48,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 +70,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 +101,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 +144,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",

package.json

@@ -7,6 +7,7 @@ Currently, version 1 is assumed if no `interfaceVersion` is available. (didn't t
 - [v3](#v3)
   - [Required `interfaceVersion: number`](#required-interfaceversion-number)
   - [Required `resolve`](#required-resolve)
+    - [`useRuleContext` and `getTsconfigWithContext`](#userulecontext-and-gettsconfigwithcontext)
     - [Arguments](#arguments)
       - [`source`](#source)
       - [`file`](#file)
@@ -15,6 +16,7 @@ Currently, version 1 is assumed if no `interfaceVersion` is available. (didn't t
 - [v2](#v2)
   - [`interfaceVersion: number`](#interfaceversion-number)
   - [`resolve`](#resolve)
+    - [`useRuleContext` and `getTsconfigWithContext`](#userulecontext-and-gettsconfigwithcontext-1)
     - [Arguments](#arguments-1)
       - [`source`](#source-1)
       - [`file`](#file-1)
@@ -55,6 +57,7 @@ and
 
 ```js
 // eslint.config.js
+import { useRuleContext, getTsconfigWithContext } from 'eslint-import-context'
 import { createNodeResolver } from 'eslint-plugin-import-x'
 
 export default [
@@ -65,6 +68,8 @@ export default [
           name: 'my-cool-resolver',
           interfaceVersion: 3,
           resolve(source, file) {
+            const ruleContext = useRuleContext()
+            const tsconfig = getTsconfigWithContext(ruleContext)
             // use a factory to get config outside of the resolver
           },
         },
@@ -77,6 +82,10 @@ export default [
 ]
 ```
 
+#### `useRuleContext` and `getTsconfigWithContext`
+
+They are powered by [eslint-import-context] in the above example, but they are not required to be used, and please be aware that `useRuleContext（）` could be `undefined` when using [eslint-plugin-import] or old versions of [eslint-plugin-import-x].
+
 #### Arguments
 
 The arguments provided will be:
@@ -187,6 +196,10 @@ settings:
     node: { paths: [a, b, c] }
 ```
 
+#### `useRuleContext` and `getTsconfigWithContext`
+
+They are also available via [eslint-import-context] in the `my-cool-resolver` example, same as [v3](#userulecontext-and-gettsconfigwithcontext).
+
 #### Arguments
 
 The arguments provided will be:
@@ -209,11 +222,13 @@ an object provided via the `import/resolver` setting. `my-cool-resolver` will ge
 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]:
 
 ```js
-var resolve = require('resolve/sync')
-var isCoreModule = require('is-core-module')
+const resolve = require('resolve/sync')
+const isCoreModule = require('is-core-module')
 
 exports.resolve = function (source, file, config) {
-  if (isCoreModule(source)) return { found: true, path: null }
+  if (isCoreModule(source)) {
+    return { found: true, path: null }
+  }
   try {
     return { found: true, path: resolve(source, opts(file, config)) }
   } catch (err) {
@@ -235,5 +250,8 @@ If the resolver cannot resolve `source` relative to `file`, it should just retur
 
 [New Node resolver]: https://github.com/un-ts/eslint-plugin-import-x/blob/master/src/node-resolver.ts
 [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
+[eslint-import-context]: https://github.com/un-ts/eslint-import-context
+[eslint-plugin-import]: https://github.com/import-js/eslint-plugin-import
+[eslint-plugin-import-x]: https://github.com/un-ts/eslint-plugin-import-x
+[resolve]: https://github.com/browserify/resolve
+[unrs-resolver]: https://github.com/unrs/unrs-resolver

resolvers/README.md

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

src/tsconfig.json

@@ -1,14 +1,8 @@
 import type { TSESLint, TSESTree } from '@typescript-eslint/utils'
+import type { PluginName, PluginSettings } from 'eslint-import-context'
 import type { MinimatchOptions } from 'minimatch'
-import type { KebabCase } from 'type-fest'
-import type { NapiResolveOptions as ResolveOptions } 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,
@@ -30,88 +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: ResolveOptions }
-  'config-index'?: number
-  env?: Record<string, unknown>
-  argv?: Record<string, unknown>
-}
-
-export interface TsResolverOptions extends ResolveOptions {
-  alwaysTryTypes?: boolean
-  project?: string[] | string
-  extensions?: string[]
-}
-
-// TODO: remove prefix New in the next major version
-export type NewResolverResolve = (
-  modulePath: string,
-  sourceFile: string,
-) => 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
@@ -127,23 +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
-  filename?: string
-}
-
 export interface ParseError extends Error {
   lineNumber: number
   column: number