fix: swap to import-x/ to improve TS resolver (#231)

voxpelli · web-flow · commit 10bf1abd9498 · 2024-12-09T17:27:31.000+01:00
* fix: swap to `import-x/` to improve TS resolver Makes use of `createTypeScriptImportResolver` with `'import-x/resolver-next'` Fixes #226 * docs: update reference to import module
diff --git a/.knip.jsonc b/.knip.jsonc
@@ -4,9 +4,6 @@
     "index.js",
     "index.d.ts"
   ],
-  "ignoreDependencies": [
-    "eslint-import-resolver-typescript"
-  ],
   "ignore": [
     "test/should-*/**/*",
     "test/ts-extension-eslint.config.mjs"
diff --git a/README.md b/README.md
@@ -159,7 +159,7 @@ module.exports = require('neostandard')({
 #### List of exported plugins
 
 * `@stylistic` - export of [`@stylistic/eslint-plugin`](https://npmjs.com/package/@stylistic/eslint-plugin)
-* `import` - export of [`eslint-plugin-import`](https://npmjs.com/package/eslint-plugin-import)
+* `import-x` - export of [`eslint-plugin-import-x`](https://npmjs.com/package/eslint-plugin-import-x)
 * `n` - export of [`eslint-plugin-n`](https://npmjs.com/package/eslint-plugin-n)
 * `promise` - export of [`eslint-plugin-promise`](https://npmjs.com/package/eslint-plugin-promise)
 * `react` - export of [`eslint-plugin-react`](https://npmjs.com/package/eslint-plugin-react)
diff --git a/index.js b/index.js
@@ -10,9 +10,8 @@ module.exports.plugins = /** @type {const} */ ({
   get '@stylistic' () {
     return require('@stylistic/eslint-plugin')
   },
-  get import () {
-    // @ts-ignore
-    return require('eslint-plugin-import')
+  get 'import-x' () {
+    return require('eslint-plugin-import-x')
   },
   get n () {
     return require('eslint-plugin-n')
@@ -22,7 +21,6 @@ module.exports.plugins = /** @type {const} */ ({
     return require('eslint-plugin-promise')
   },
   get react () {
-    // @ts-ignore
     return require('eslint-plugin-react')
   },
   get 'typescript-eslint' () {
diff --git a/lib/configs/base.js b/lib/configs/base.js
@@ -1,8 +1,7 @@
 'use strict'
 
 const globals = require('globals')
-// @ts-ignore
-const eslintPluginImport = require('eslint-plugin-import')
+const eslintPluginImportX = require('eslint-plugin-import-x')
 const eslintPluginN = require('eslint-plugin-n')
 // @ts-ignore
 const eslintPluginPromise = require('eslint-plugin-promise')
@@ -23,7 +22,7 @@ module.exports = /** @satisfies {import('eslint').Linter.Config} */ ({
   },
 
   plugins: {
-    import: eslintPluginImport,
+    'import-x': /** @type {import('eslint').ESLint.Plugin} */ (/** @type {unknown} */ (eslintPluginImportX)),
     n: eslintPluginN,
     promise: eslintPluginPromise,
   },
@@ -150,12 +149,12 @@ module.exports = /** @satisfies {import('eslint').Linter.Config} */ ({
     'valid-typeof': ['error', { requireStringLiterals: true }],
     yoda: ['error', 'never'],
 
-    'import/export': 'error',
-    'import/first': 'error',
-    'import/no-absolute-path': ['error', { esmodule: true, commonjs: true, amd: false }],
-    'import/no-duplicates': 'error',
-    'import/no-named-default': 'error',
-    'import/no-webpack-loader-syntax': 'error',
+    'import-x/export': 'error',
+    'import-x/first': 'error',
+    'import-x/no-absolute-path': ['error', { esmodule: true, commonjs: true, amd: false }],
+    'import-x/no-duplicates': 'error',
+    'import-x/no-named-default': 'error',
+    'import-x/no-webpack-loader-syntax': 'error',
 
     // TODO: Should only be active for server side scripts
     'n/handle-callback-err': ['error', '^(err|error)$'],
diff --git a/lib/ts.js b/lib/ts.js
@@ -1,5 +1,7 @@
 'use strict'
 
+// @ts-ignore
+const { createTypeScriptImportResolver } = require('eslint-import-resolver-typescript')
 const { parser, plugin } = require('typescript-eslint')
 
 const tsRedundant = require('./configs/ts-redundant')
@@ -89,10 +91,13 @@ function typescriptify (configs, options) {
       '@typescript-eslint': plugin,
     },
     settings: {
-      'import/resolver': {
-        typescript: true,
-        node: true,
-      },
+      'import-x/resolver-next': [
+        createTypeScriptImportResolver(
+          (Array.isArray(project) || typeof project === 'string')
+            ? { project }
+            : {}
+        ),
+      ],
     },
     rules: {
       ...deactivatedRules,
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -82,8 +82,8 @@
   "dependencies": {
     "@humanwhocodes/gitignore-to-minimatch": "^1.0.2",
     "@stylistic/eslint-plugin": "2.11.0",
-    "eslint-import-resolver-typescript": "^3.6.3",
-    "eslint-plugin-import": "^2.31.0",
+    "eslint-import-resolver-typescript": "^3.7.0",
+    "eslint-plugin-import-x": "^4.5.0",
     "eslint-plugin-n": "^17.14.0",
     "eslint-plugin-promise": "^7.2.1",
     "eslint-plugin-react": "^7.37.2",
