@gitlab/eslint-plugin 22.0.0 → 23.0.0

package/CHANGELOG.md

@@ -1,5 +1,87 @@
 # @gitlab/eslint-plugin
 
+## 23.0.0
+
+### Major Changes
+
+- 8dfb811: Replace `eslint-plugin-import` with `eslint-plugin-import-x`.
+
+  `eslint-plugin-import` does not support ESLint 10. `eslint-plugin-import-x` is a maintained fork with
+  the same rules that supports ESLint 8, 9 and 10. Every config this package exports now registers
+  `eslint-plugin-import-x` under the `import-x` namespace instead of `eslint-plugin-import` under
+  `import`. The rules we enable and their options are unchanged; only their names and the settings
+  that drive them move.
+
+  ## Breaking changes
+
+  1. **Every import rule is renamed from `import/<rule>` to `import-x/<rule>`.** Rule overrides in
+     your `eslint.config.js` must be renamed:
+
+     ```diff
+      module.exports = [
+        ...gitlab.configs.default,
+        {
+          rules: {
+     -      'import/no-cycle': 'off',
+     +      'import-x/no-cycle': 'off',
+          },
+        },
+      ];
+     ```
+
+  2. **Disable comments must be renamed too.** An `// eslint-disable-next-line import/no-cycle`
+     comment now refers to a rule ESLint cannot find, which it reports as an error. Rename them to
+     `import-x/...`. This rewrites `import/` to `import-x/` on ESLint directive lines only, leaving
+     import paths alone (review the diff before committing):
+
+     ```bash
+     git grep -lE 'eslint-(disable|enable)|/\* *eslint ' -- '*.js' '*.mjs' '*.cjs' '*.ts' '*.vue' \
+       | xargs perl -pi -e 's#(?<=[\s,])import/(?=[a-z])#import-x/#g if m{eslint-(disable|enable)|/\*\s*eslint\s}'
+     ```
+
+  3. **Import settings are renamed from `import/*` to `import-x/*`.** `eslint-plugin-import-x` only
+     reads `import-x/`-prefixed settings and silently ignores the old names, so a leftover
+     `import/resolver`, `import/core-modules`, `import/ignore` or `import/internal-regex` stops having
+     any effect without an error. Rename each key.
+
+  4. **In the `typescript` config, custom resolvers must go in `import-x/resolver-next`.** That config
+     sets `import-x/resolver-next` so `.ts` and `.tsx` files resolve, and when that key is present
+     `eslint-plugin-import-x` ignores `import-x/resolver`. ESLint also replaces arrays in `settings`
+     rather than merging them, so your `import-x/resolver-next` replaces ours. If you need `tsconfig.json`
+     `paths` aliases, use `eslint-import-resolver-typescript`, which also resolves everything ours does:
+
+     ```js
+     const { createTypeScriptImportResolver } = require('eslint-import-resolver-typescript');
+
+     module.exports = [
+       ...gitlab.configs.typescript,
+       {
+         settings: {
+           'import-x/resolver-next': [createTypeScriptImportResolver()],
+         },
+       },
+     ];
+     ```
+
+     The other configs set no resolver, so a custom one there only needs its key renamed (point 3).
+
+  ## Other changes
+
+  - The configs other than `typescript` no longer set a resolver and rely on `eslint-plugin-import-x`'s
+    default node resolver. It resolves the same files as before, plus `.cjs` and `.node`.
+  - `import-x/core-modules` and the stylesheet/asset patterns in `import-x/ignore` are no longer set.
+    Neither had an effect: the first was the default value, and files with those extensions were
+    already skipped because they aren't listed in `import-x/extensions`. `node_modules` is still
+    ignored.
+  - `import/imports-first` is no longer configured. It was already disabled, and it is deprecated in
+    favour of `import-x/first`, which stays enabled.
+  - The `typescript` config no longer relies on `eslint-plugin-import`'s TypeScript preset. It sets the
+    equivalent settings itself: `.ts`, `.cts`, `.mts` and `.tsx` files are resolved by the node
+    resolver, `node_modules/@types` is treated as external, and `import-x/named` is disabled for
+    TypeScript files as before.
+  - If your own config also uses `eslint-plugin-import`, it can now coexist with this package: the two
+    plugins register under different names.
+
 ## 22.0.0
 
 ### Major Changes

package/lib/configs/base/es6.js

@@ -48,7 +48,7 @@ module.exports = {
 
     // disallow importing from the same path more than once
     // https://eslint.org/docs/rules/no-duplicate-imports
-    // replaced by https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-duplicates.md
+    // replaced by https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/no-duplicates.md
     'no-duplicate-imports': 'off',
 
     // disallow symbol constructor

package/lib/configs/base/imports.js

@@ -1,55 +1,49 @@
 module.exports = {
   settings: {
-    'import/resolver': {
-      node: {
-        extensions: ['.mjs', '.js', '.json'],
-      },
-    },
-    'import/extensions': ['.js', '.mjs', '.jsx'],
-    'import/core-modules': [],
-    'import/ignore': ['node_modules', '\\.(coffee|scss|css|less|hbs|svg|json)$'],
+    'import-x/extensions': ['.js', '.mjs', '.jsx'],
+    'import-x/ignore': ['node_modules'],
   },
 
   rules: {
     // Static analysis:
 
     // ensure imports point to files/modules that can be resolved
-    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-unresolved.md
-    'import/no-unresolved': ['error', { commonjs: true, caseSensitive: true }],
+    // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/no-unresolved.md
+    'import-x/no-unresolved': ['error', { commonjs: true, caseSensitive: true }],
 
     // ensure named imports coupled with named exports
-    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/named.md#when-not-to-use-it
-    'import/named': 'error',
+    // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/named.md#when-not-to-use-it
+    'import-x/named': 'error',
 
     // ensure default import coupled with default export
-    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/default.md#when-not-to-use-it
-    'import/default': 'off',
+    // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/default.md#when-not-to-use-it
+    'import-x/default': 'off',
 
-    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/namespace.md
-    'import/namespace': 'off',
+    // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/namespace.md
+    'import-x/namespace': 'off',
 
     // Helpful warnings:
 
     // disallow invalid exports, e.g. multiple defaults
-    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/export.md
-    'import/export': 'error',
+    // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/export.md
+    'import-x/export': 'error',
 
     // do not allow a default import name to match a named export
-    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-named-as-default.md
-    'import/no-named-as-default': 'error',
+    // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/no-named-as-default.md
+    'import-x/no-named-as-default': 'error',
 
     // warn on accessing default export property names that are also named exports
-    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-named-as-default-member.md
-    'import/no-named-as-default-member': 'error',
+    // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/no-named-as-default-member.md
+    'import-x/no-named-as-default-member': 'error',
 
     // disallow use of jsdoc-marked-deprecated imports
-    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-deprecated.md
-    'import/no-deprecated': 'off',
+    // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/no-deprecated.md
+    'import-x/no-deprecated': 'off',
 
     // Forbid the use of extraneous packages
-    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-extraneous-dependencies.md
+    // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/no-extraneous-dependencies.md
     // paths are treated both as absolute paths, and relative to process.cwd()
-    'import/no-extraneous-dependencies': [
+    'import-x/no-extraneous-dependencies': [
       'error',
       {
         devDependencies: [
@@ -81,47 +75,42 @@ module.exports = {
     ],
 
     // Forbid mutable exports
-    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-mutable-exports.md
-    'import/no-mutable-exports': 'error',
+    // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/no-mutable-exports.md
+    'import-x/no-mutable-exports': 'error',
 
     // Module systems:
 
     // disallow require()
-    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-commonjs.md
-    'import/no-commonjs': 'off',
+    // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/no-commonjs.md
+    'import-x/no-commonjs': 'off',
 
     // disallow AMD require/define
-    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-amd.md
-    'import/no-amd': 'error',
+    // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/no-amd.md
+    'import-x/no-amd': 'error',
 
     // No Node.js builtin modules
-    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-nodejs-modules.md
+    // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/no-nodejs-modules.md
     // TODO: enable?
-    'import/no-nodejs-modules': 'off',
+    'import-x/no-nodejs-modules': 'off',
 
     // Style guide:
 
     // disallow non-import statements appearing before import statements
-    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/first.md
-    'import/first': 'error',
-
-    // disallow non-import statements appearing before import statements
-    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/imports-first.md
-    // deprecated: use `import/first`
-    'import/imports-first': 'off',
+    // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/first.md
+    'import-x/first': 'error',
 
     // disallow duplicate imports
-    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-duplicates.md
-    'import/no-duplicates': 'error',
+    // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/no-duplicates.md
+    'import-x/no-duplicates': 'error',
 
     // disallow namespace imports
     // TODO: enable?
-    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-namespace.md
-    'import/no-namespace': 'off',
+    // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/no-namespace.md
+    'import-x/no-namespace': 'off',
 
     // Ensure consistent use of file extension within the import path
-    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/extensions.md
-    'import/extensions': [
+    // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/extensions.md
+    'import-x/extensions': [
       'error',
       'ignorePackages',
       {
@@ -132,37 +121,37 @@ module.exports = {
     ],
 
     // ensure absolute imports are above relative imports and that unassigned imports are ignored
-    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/order.md
+    // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/order.md
     // TODO: enforce a stricter convention in module import order?
-    'import/order': ['error', { groups: [['builtin', 'external', 'internal']] }],
+    'import-x/order': ['error', { groups: [['builtin', 'external', 'internal']] }],
 
     // Require a newline after the last import/require in a group
-    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/newline-after-import.md
-    'import/newline-after-import': 'error',
+    // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/newline-after-import.md
+    'import-x/newline-after-import': 'error',
 
     // Require modules with a single export to use a default export
-    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/prefer-default-export.md
-    'import/prefer-default-export': 'error',
+    // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/prefer-default-export.md
+    'import-x/prefer-default-export': 'error',
 
     // Restrict which files can be imported in a given folder
-    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-restricted-paths.md
-    'import/no-restricted-paths': 'off',
+    // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/no-restricted-paths.md
+    'import-x/no-restricted-paths': 'off',
 
     // Forbid modules to have too many dependencies
-    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/max-dependencies.md
-    'import/max-dependencies': ['off', { max: 10 }],
+    // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/max-dependencies.md
+    'import-x/max-dependencies': ['off', { max: 10 }],
 
     // Forbid import of modules using absolute paths
-    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-absolute-path.md
-    'import/no-absolute-path': 'error',
+    // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/no-absolute-path.md
+    'import-x/no-absolute-path': 'error',
 
     // Forbid require() calls with expressions
-    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-dynamic-require.md
-    'import/no-dynamic-require': 'error',
+    // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/no-dynamic-require.md
+    'import-x/no-dynamic-require': 'error',
 
     // prevent importing the submodules of other modules
-    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-internal-modules.md
-    'import/no-internal-modules': [
+    // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/no-internal-modules.md
+    'import-x/no-internal-modules': [
       'off',
       {
         allow: [],
@@ -171,27 +160,27 @@ module.exports = {
 
     // Warn if a module could be mistakenly parsed as a script by a consumer
     // leveraging Unambiguous JavaScript Grammar
-    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/unambiguous.md
+    // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/unambiguous.md
     // this should not be enabled until this proposal has at least been *presented* to TC39.
     // At the moment, it's not a thing.
-    'import/unambiguous': 'off',
+    'import-x/unambiguous': 'off',
 
     // Forbid Webpack loader syntax in imports
-    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-webpack-loader-syntax.md
-    'import/no-webpack-loader-syntax': 'error',
+    // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/no-webpack-loader-syntax.md
+    'import-x/no-webpack-loader-syntax': 'error',
 
     // Prevent unassigned imports
-    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-unassigned-import.md
+    // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/no-unassigned-import.md
     // importing for side effects is perfectly acceptable, if you need side effects.
-    'import/no-unassigned-import': 'off',
+    'import-x/no-unassigned-import': 'off',
 
     // Prevent importing the default as if it were named
-    // https://github.com/benmosher/eslint-plugin-import/blob/master/docs/rules/no-named-default.md
-    'import/no-named-default': 'error',
+    // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/no-named-default.md
+    'import-x/no-named-default': 'error',
 
     // Reports if a module's default export is unnamed
-    // https://github.com/benmosher/eslint-plugin-import/blob/d9b712ac7fd1fddc391f7b234827925c160d956f/docs/rules/no-anonymous-default-export.md
-    'import/no-anonymous-default-export': [
+    // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/no-anonymous-default-export.md
+    'import-x/no-anonymous-default-export': [
       'off',
       {
         allowArray: false,
@@ -204,39 +193,39 @@ module.exports = {
     ],
 
     // This rule enforces that all exports are declared at the bottom of the file.
-    // https://github.com/benmosher/eslint-plugin-import/blob/98acd6afd04dcb6920b81330114e146dc8532ea4/docs/rules/exports-last.md
+    // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/exports-last.md
     // TODO: enable?
-    'import/exports-last': 'off',
+    'import-x/exports-last': 'off',
 
     // Reports when named exports are not grouped together in a single export declaration
     // or when multiple assignments to CommonJS module.exports or exports object are present
     // in a single file.
-    // https://github.com/benmosher/eslint-plugin-import/blob/44a038c06487964394b1e15b64f3bd34e5d40cde/docs/rules/group-exports.md
-    'import/group-exports': 'off',
+    // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/group-exports.md
+    'import-x/group-exports': 'off',
 
     // forbid default exports. this is a terrible rule, do not use it.
-    // https://github.com/benmosher/eslint-plugin-import/blob/44a038c06487964394b1e15b64f3bd34e5d40cde/docs/rules/no-default-export.md
-    'import/no-default-export': 'off',
+    // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/no-default-export.md
+    'import-x/no-default-export': 'off',
 
     // Prohibit named exports. this is a terrible rule, do not use it.
-    // https://github.com/benmosher/eslint-plugin-import/blob/1ec80fa35fa1819e2d35a70e68fb6a149fb57c5e/docs/rules/no-named-export.md
-    'import/no-named-export': 'off',
+    // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/no-named-export.md
+    'import-x/no-named-export': 'off',
 
     // Forbid a module from importing itself
-    // https://github.com/benmosher/eslint-plugin-import/blob/44a038c06487964394b1e15b64f3bd34e5d40cde/docs/rules/no-self-import.md
-    'import/no-self-import': 'error',
+    // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/no-self-import.md
+    'import-x/no-self-import': 'error',
 
     // Forbid cyclical dependencies between modules
-    // https://github.com/benmosher/eslint-plugin-import/blob/d81f48a2506182738409805f5272eff4d77c9348/docs/rules/no-cycle.md
-    'import/no-cycle': ['error', { maxDepth: '∞' }],
+    // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/no-cycle.md
+    'import-x/no-cycle': ['error', { maxDepth: '∞' }],
 
     // Ensures that there are no useless path segments
-    // https://github.com/benmosher/eslint-plugin-import/blob/ebafcbf59ec9f653b2ac2a0156ca3bcba0a7cf57/docs/rules/no-useless-path-segments.md
-    'import/no-useless-path-segments': ['error', { commonjs: true }],
+    // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/no-useless-path-segments.md
+    'import-x/no-useless-path-segments': ['error', { commonjs: true }],
 
     // dynamic imports require a leading comment with a webpackChunkName
-    // https://github.com/benmosher/eslint-plugin-import/blob/ebafcbf59ec9f653b2ac2a0156ca3bcba0a7cf57/docs/rules/dynamic-import-chunkname.md
-    'import/dynamic-import-chunkname': [
+    // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/dynamic-import-chunkname.md
+    'import-x/dynamic-import-chunkname': [
       'off',
       {
         importFunctions: [],
@@ -245,13 +234,13 @@ module.exports = {
     ],
 
     // Use this rule to prevent imports to folders in relative parent paths.
-    // https://github.com/benmosher/eslint-plugin-import/blob/c34f14f67f077acd5a61b3da9c0b0de298d20059/docs/rules/no-relative-parent-imports.md
-    'import/no-relative-parent-imports': 'off',
+    // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/no-relative-parent-imports.md
+    'import-x/no-relative-parent-imports': 'off',
 
     // Reports modules without any exports, or with unused exports
-    // https://github.com/benmosher/eslint-plugin-import/blob/f63dd261809de6883b13b6b5b960e6d7f42a7813/docs/rules/no-unused-modules.md
+    // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/no-unused-modules.md
     // TODO: enable once it supports CJS
-    'import/no-unused-modules': [
+    'import-x/no-unused-modules': [
       'off',
       {
         ignoreExports: [],
@@ -261,8 +250,8 @@ module.exports = {
     ],
 
     // Reports the use of import declarations with CommonJS exports in any module except for the main module.
-    // https://github.com/benmosher/eslint-plugin-import/blob/1012eb951767279ce3b540a4ec4f29236104bb5b/docs/rules/no-import-module-exports.md
-    'import/no-import-module-exports': [
+    // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/no-import-module-exports.md
+    'import-x/no-import-module-exports': [
       'error',
       {
         exceptions: [],
@@ -270,7 +259,7 @@ module.exports = {
     ],
 
     // Use this rule to prevent importing packages through relative paths.
-    // https://github.com/benmosher/eslint-plugin-import/blob/1012eb951767279ce3b540a4ec4f29236104bb5b/docs/rules/no-relative-packages.md
-    'import/no-relative-packages': 'error',
+    // https://github.com/un-ts/eslint-plugin-import-x/blob/master/docs/rules/no-relative-packages.md
+    'import-x/no-relative-packages': 'error',
   },
 };

package/lib/flat-configs/base.js

@@ -1,7 +1,7 @@
 const globals = require('globals');
 const unicornPlugin = require('eslint-plugin-unicorn');
 const promisePlugin = require('eslint-plugin-promise');
-const importPlugin = require('eslint-plugin-import');
+const importPlugin = require('eslint-plugin-import-x');
 
 const confusingBrowserGlobals = require('../confusing-browser-globals');
 const gitlabPlugin = require('../plugin.js');
@@ -35,7 +35,7 @@ module.exports = [
     plugins: {
       unicorn: unicornPlugin,
       promise: promisePlugin,
-      import: importPlugin,
+      'import-x': importPlugin,
       '@gitlab': gitlabPlugin,
     },
     settings: imports.settings,
@@ -63,10 +63,10 @@ module.exports = [
       'arrow-body-style': 'off',
       'unicorn/filename-case': ['error', { case: 'snakeCase' }],
       'unicorn/no-array-callback-reference': 'error',
-      'import/prefer-default-export': 'off',
-      'import/no-default-export': 'error',
-      'import/no-deprecated': 'error',
-      'import/no-dynamic-require': ['error', { esmodule: true }],
+      'import-x/prefer-default-export': 'off',
+      'import-x/no-default-export': 'error',
+      'import-x/no-deprecated': 'error',
+      'import-x/no-dynamic-require': ['error', { esmodule: true }],
       'no-implicit-coercion': ['error', { boolean: true, number: true, string: true }],
       'no-param-reassign': [
         'error',
@@ -109,7 +109,7 @@ module.exports = [
             "The global `unescape` function is unsafe. Did you mean to use `decodeURI`, `decodeURIComponent` or lodash's `unescape` instead?",
         },
       ].concat(confusingBrowserGlobals),
-      'import/order': [
+      'import-x/order': [
         'error',
         {
           groups: ['builtin', 'external', 'internal', 'parent', 'sibling', 'index'],

package/lib/flat-configs/typescript.js

@@ -1,7 +1,7 @@
 const js = require('@eslint/js');
 const tsPlugin = require('@typescript-eslint/eslint-plugin');
 const tsParser = require('@typescript-eslint/parser');
-const importPlugin = require('eslint-plugin-import');
+const importPlugin = require('eslint-plugin-import-x');
 const globals = require('globals');
 
 const base = require('./base');
@@ -23,7 +23,24 @@ const base = require('./base');
 */
 const tsEslintRecommended = tsPlugin.configs['flat/eslint-recommended'];
 const tsStrict = tsPlugin.configs.strict;
-const importTypescript = importPlugin.flatConfigs.typescript;
+/*
+  Mirrors eslint-plugin-import's `typescript` preset. import-x's own
+  `flatConfigs.typescript` isn't used because its resolver needs
+  eslint-import-resolver-typescript.
+
+  Unlike base, this sets a resolver: import-x's default one doesn't know the
+  TypeScript extensions, so `import './foo'` wouldn't find `foo.ts`. Consumers
+  who need `paths` aliases replace it with eslint-import-resolver-typescript,
+  which also resolves everything this one does.
+*/
+const TS_EXTENSIONS = ['.ts', '.cts', '.mts', '.tsx'];
+const ALL_EXTENSIONS = [...TS_EXTENSIONS, '.js', '.jsx', '.mjs', '.cjs'];
+const importTypescriptSettings = {
+  'import-x/extensions': ALL_EXTENSIONS,
+  'import-x/external-module-folders': ['node_modules', 'node_modules/@types'],
+  'import-x/parsers': { '@typescript-eslint/parser': TS_EXTENSIONS },
+  'import-x/resolver-next': [importPlugin.createNodeResolver({ extensions: ALL_EXTENSIONS })],
+};
 
 module.exports = [
   ...base,
@@ -36,7 +53,7 @@ module.exports = [
       },
     },
     rules: {
-      'import/extensions': [
+      'import-x/extensions': [
         'error',
         'ignorePackages',
         { js: 'never', jsx: 'never', ts: 'never', tsx: 'never' },
@@ -54,17 +71,17 @@ module.exports = [
     },
     plugins: {
       '@typescript-eslint': tsPlugin,
-      import: importPlugin,
+      'import-x': importPlugin,
     },
     linterOptions: {
       reportUnusedDisableDirectives: true,
     },
-    settings: importTypescript.settings,
+    settings: importTypescriptSettings,
     rules: {
       ...js.configs.recommended.rules,
       ...tsEslintRecommended.rules,
       ...tsStrict.rules,
-      ...importTypescript.rules,
+      'import-x/named': 'off',
       semi: [2, 'always'],
       'max-params': 'off',
       'no-throw-literal': 'off',
@@ -79,7 +96,7 @@ module.exports = [
       '@typescript-eslint/no-floating-promises': 'error',
       '@typescript-eslint/explicit-member-accessibility': ['error', { accessibility: 'no-public' }],
       'class-methods-use-this': 'off',
-      'import/no-cycle': 'error',
+      'import-x/no-cycle': 'error',
       'promise/param-names': 'off',
       'no-use-before-define': ['warn', 'nofunc'],
       'no-restricted-syntax': [

package/lib/rules/no-runtime-template-compiler.js

@@ -46,7 +46,7 @@ module.exports = {
           hasRenderFn,
         });
       }),
-      'Program:exit'(node) {
+      'Program:exit'() {
         for (const { node, templateOption, hasRenderFn } of vues) {
           if (templateOption) {
             // Components can define a render function _and_ a template option,

package/lib/rules/require-i18n-strings.js

@@ -92,7 +92,7 @@ module.exports = {
     }
 
     function stripVariables(value) {
-      return value ? value.replace(/(\%{[\w-]+})/g, '') : '';
+      return value ? value.replace(/(%{[\w-]+})/g, '') : '';
     }
 
     function getCallExpressionString(node, callee) {
@@ -143,7 +143,7 @@ module.exports = {
 
     function isMemberExpressionIdentifier(expression) {
       if (expression.type !== 'MemberExpression') return false;
-      if (!!expression.property.quasis) {
+      if (expression.property.quasis) {
         return /^\w+$/.test(getTemplateLiteralString(expression.property));
       }
       return /^\w+$/.test(expression.property.value);
@@ -164,14 +164,14 @@ module.exports = {
     }
 
     function isObjectMethod(node) {
-      if (!!node.callee.property) {
+      if (node.callee.property) {
         return objectMethods.has(node.callee.property.name);
       }
       return false;
     }
 
     function isHtmlCall(node) {
-      if (!!node.callee.property) {
+      if (node.callee.property) {
         return htmlCalls.has(node.callee.property.name);
       }
       return htmlCalls.has(node.callee.name);

package/lib/rules/vtu-no-explicit-wrapper-destroy.js

@@ -13,7 +13,7 @@ class Rule {
   #context;
 
   constructor(context, options) {
-    this.#vmWrapperNameParts = options.wrapperNames || commonVmWrapperNameParts;
+    this.#vmWrapperNameParts = options.wrapperNames;
     this.#context = context;
   }
 

package/lib/rules/vue-slot-name-casing.js

@@ -24,7 +24,6 @@ module.exports = {
   },
 
   create(context) {
-    const sourceCode = context.getSourceCode();
     const caseType = 'kebab-case';
 
     let hasInvalidEOF = false;

package/lib/utils/hardcoded-urls.js

@@ -96,7 +96,7 @@ function isHardCodedUrl(context, value) {
 
   // Check for path-like patterns:
   // Starts with / followed by word characters
-  const urlPathPattern = /^\/(?![#?])[\/\.a-zA-Z0-9_-]+/;
+  const urlPathPattern = /^\/(?![#?])[/.a-zA-Z0-9_-]+/;
 
   return urlPathPattern.test(value);
 }

package/lib/utils/string-utils.js

@@ -6,13 +6,11 @@ function isFileName(value) {
 }
 
 function isPath(value) {
-  return /^([\w-_]*|\.{1,2})[\/\~]+[\w-_\/]*/.test(value);
+  return /^([\w-_]*|\.{1,2})[/~]+[\w-_/]*/.test(value);
 }
 
 function isUrl(value) {
-  return (
-    /[a-zA-Z0-9]*(:\/\/)+[a-zA-Z0-9\.]*/.test(value) || /(http){1}[s:\/a-zA-Z0-9.]*/.test(value)
-  );
+  return /[a-zA-Z0-9]*(:\/\/)+[a-zA-Z0-9.]*/.test(value) || /(http){1}[s:/a-zA-Z0-9.]*/.test(value);
 }
 
 function isMailto(str) {
@@ -39,11 +37,11 @@ function isListOfCssProperties(value) {
 
 function isCssSelector(value) {
   return (
-    /^,?\s?[\.\#\*\@]\w+.*/.test(value) ||
-    /^[a-zA-Z]+[a-zA-Z-]*[\.\#\*]+[a-zA-Z]+[a-zA-Z-]*/.test(value) ||
+    /^,?\s?[.#*@]\w+.*/.test(value) ||
+    /^[a-zA-Z]+[a-zA-Z-]*[.#*]+[a-zA-Z]+[a-zA-Z-]*/.test(value) ||
     /[a-zA-Z][a-zA-Z-]+[a-zA-Z]\.\w/.test(value) ||
     /([a-zA-Z]+[a-zA-Z-]*|\*)\[.*\]/.test(value) ||
-    /^[a-zA-Z]+[a-zA-Z-]*[\#\*]$/.test(value) ||
+    /^[a-zA-Z]+[a-zA-Z-]*[#*]$/.test(value) ||
     /^(?:[0-9]+[a-z]|[a-z]+[0-9])[a-z0-9]*\s[a-z0-9][a-z0-9]+-[a-z0-9-]*$/.test(value) ||
     isListOfCssProperties(value) ||
     isListOfHtmlElements(value)
@@ -104,7 +102,7 @@ function containsAssignment(value) {
 }
 
 function isSpecial(value) {
-  return /^[\:\%\_\&\#\?\[\$].*[^.]/.test(value) || /.*[\*\+]+$/.test(value);
+  return /^[:%_&#?[$].*[^.]/.test(value) || /.*[*+]+$/.test(value);
 }
 
 function isVariableName(value) {

package/lib/vue-fragments.js

@@ -3,7 +3,7 @@ const vueParser = require('vue-eslint-parser');
 const globals = require('globals');
 const unicornPlugin = require('eslint-plugin-unicorn');
 const promisePlugin = require('eslint-plugin-promise');
-const importPlugin = require('eslint-plugin-import');
+const importPlugin = require('eslint-plugin-import-x');
 
 const gitlabPlugin = require('./plugin.js');
 
@@ -36,7 +36,7 @@ const presetAndSetup = [
     plugins: {
       unicorn: unicornPlugin,
       promise: promisePlugin,
-      import: importPlugin,
+      'import-x': importPlugin,
       '@gitlab': gitlabPlugin,
     },
   },
@@ -66,7 +66,7 @@ const gitlabRules = [
       '@gitlab/vue-prefer-dollar-scopedslots': 'error',
       '@gitlab/vue-slot-name-casing': 'error',
       '@gitlab/no-runtime-template-compiler': 'error',
-      'import/order': [
+      'import-x/order': [
         'error',
         {
           groups: ['builtin', 'external', 'internal', 'parent', 'sibling', 'index'],
@@ -103,7 +103,7 @@ const gitlabRules = [
     name: '@gitlab/vue/sfc-overrides',
     files: ['**/*.vue'],
     rules: {
-      'import/no-default-export': 'off',
+      'import-x/no-default-export': 'off',
     },
   },
 ];

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "@gitlab/eslint-plugin",
-  "version": "22.0.0",
+  "version": "23.0.0",
   "description": "GitLab package for our custom eslint rules",
   "main": "lib/index.js",
   "scripts": {
     "createRule": "./scripts/createRule.js && yarn update",
     "update": "./scripts/updateFiles.js && prettier --write lib/plugin.js lib/index.js",
     "commit": "npx git-cz",
+    "lint": "eslint .",
     "test": "mocha"
   },
   "repository": "https://gitlab.com/gitlab-org/frontend/eslint-plugin.git",
@@ -32,7 +33,7 @@
   "dependencies": {
     "@eslint/js": "^9.0.0",
     "eslint-config-prettier": "^10.0.0",
-    "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-import-x": "^4.17.1",
     "eslint-plugin-jest": "^29.0.0",
     "eslint-plugin-promise": "^7.0.0",
     "eslint-plugin-tailwindcss": "^3.18.3",

package/scripts/benchmarking/checkAllStrings.js

@@ -37,7 +37,7 @@ for (let i = 0, len = allStrings.length; i < len; i++) {
 
   try {
     result = testFn(allStrings[i]) ? 'TRUE' : 'FALSE';
-  } catch (e) {
+  } catch {
     result = 'TIMEOUT';
   }
 

package/scripts/helpers/getConfigs.js

@@ -6,8 +6,10 @@ const configsDir = path.join(__dirname, '../../lib/flat-configs');
 /*
   lib/flat-configs/ is a closed set: this glob decides what `yarn update`
   publishes as `plugin.configs[<basename>]`, so a shared helper dropped in that
-  directory becomes a bogus public config. That is why lib/prettier-rules.js and
-  lib/vue-fragments.js sit at the lib/ root instead; put new shared code there.
+  directory becomes a bogus public config, which tests/lib/configs/exports.spec.js
+  fails on once `yarn update` has regenerated lib/index.js. That is why
+  lib/prettier-rules.js and lib/vue-fragments.js sit at the lib/ root instead;
+  put new shared code there.
 
   No `.meta` spread, unlike getRules.js: a flat config exports an array.
 */

package/scripts/publish_npm_package.mjs

@@ -170,7 +170,6 @@ async function createReleases({ changesets, releases }) {
 
       if (type) {
         releaseDescriptionObject[type].push(
-          // eslint-disable-next-line no-await-in-loop
           await defaultChangelogFunctions.getReleaseLine(changeset, type),
         );
       }
@@ -181,7 +180,6 @@ async function createReleases({ changesets, releases }) {
       .map(([type, lines]) => releaseSection(type, lines))
       .join('\n\n');
 
-    // eslint-disable-next-line no-await-in-loop
     await createRelease({ tag: `v${release.newVersion}`, description });
   }
 }

package/scripts/generateRuleMapFixtures.js

@@ -1,75 +0,0 @@
-#!/usr/bin/env node
-/**
- * ONE-SHOT generator. Resolves each eslintrc config in lib/configs/ into a
- * flat map of rule -> [severity, ...options] and writes it to
- * tests/fixtures/rule-maps/. Run once, on ESLint 8, BEFORE the flat-config
- * migration. Committed for reviewability; not wired into CI.
- *
- * Its inputs are gone and it no longer runs. Kept only as the provenance of
- * the frozen fixtures; deleted at the end of this stack.
- */
-const fs = require('fs');
-const path = require('path');
-const { ESLint } = require('eslint');
-
-const CONFIG_DIR = path.join(__dirname, '../lib/configs');
-const OUT_DIR = path.join(__dirname, '../tests/fixtures/rule-maps');
-
-// Top level only: lib/configs/base/ holds rule fragments, not configs.
-const CONFIGS = fs
-  .readdirSync(CONFIG_DIR)
-  .filter((file) => file.endsWith('.js'))
-  .map((file) => path.basename(file, '.js'));
-const SAMPLES = ['sample.js', 'sample.vue', 'sample.ts', 'sample.test.ts'];
-
-const SEVERITIES = ['off', 'warn', 'error'];
-
-/** Normalise [2, opts] / 'error' / ['error', opts] into 'error' or ['error', ...opts]. */
-function normalizeEntry(entry) {
-  const value = Array.isArray(entry) ? entry : [entry];
-  const [severity, ...options] = value;
-  const name = typeof severity === 'number' ? SEVERITIES[severity] : severity;
-  return options.length > 0 ? [name, ...options] : name;
-}
-
-function normalizeRules(rules) {
-  return Object.fromEntries(
-    Object.keys(rules)
-      .sort()
-      .map((name) => [name, normalizeEntry(rules[name])]),
-  );
-}
-
-async function mapForConfig(configName) {
-  const configPath = require.resolve(`../lib/configs/${configName}.js`);
-  const eslint = new ESLint({
-    useEslintrc: false,
-    // The plugin cannot resolve itself by name from inside its own repo.
-    plugins: { '@gitlab': require('../lib/index.js') },
-    baseConfig: { extends: [configPath] },
-  });
-
-  const resolved = await Promise.all(
-    SAMPLES.map((sample) => eslint.calculateConfigForFile(path.join(process.cwd(), sample))),
-  );
-  return Object.fromEntries(
-    SAMPLES.map((sample, index) => [sample, normalizeRules(resolved[index].rules || {})]),
-  );
-}
-
-async function main() {
-  fs.mkdirSync(OUT_DIR, { recursive: true });
-  for (const name of CONFIGS) {
-    // eslint-disable-next-line no-await-in-loop
-    const map = await mapForConfig(name);
-    const file = path.join(OUT_DIR, `${name}.json`);
-    fs.writeFileSync(file, `${JSON.stringify(map, null, 2)}\n`);
-    const counts = SAMPLES.map((sample) => `${sample} ${Object.keys(map[sample]).length}`);
-    console.log(`Wrote ${path.relative(process.cwd(), file)} (${counts.join(', ')})`);
-  }
-}
-
-main().catch((error) => {
-  console.error(error);
-  process.exit(1);
-});