@foray1010/eslint-config 12.2.3 → 12.3.0

package/CHANGELOG.md

@@ -3,6 +3,23 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [12.3.0](https://github.com/foray1010/common-presets/compare/@foray1010/eslint-config@12.2.4...@foray1010/eslint-config@12.3.0) (2024-07-21)
+
+### Features
+
+- **eslint-config:** migrate eslint plugin from import to import-x ([ae44cee](https://github.com/foray1010/common-presets/commit/ae44ceefa797f0afbe690c337baf7ecd58420ea9))
+
+### Bug Fixes
+
+- **deps:** update dependency eslint-plugin-compat to v6 ([e7676b2](https://github.com/foray1010/common-presets/commit/e7676b2b3506cb4d92e512d40f487e007f64bd30))
+
+## [12.2.4](https://github.com/foray1010/common-presets/compare/@foray1010/eslint-config@12.2.3...@foray1010/eslint-config@12.2.4) (2024-06-15)
+
+### Bug Fixes
+
+- **deps:** update dependency eslint-plugin-compat to v5 ([d9743af](https://github.com/foray1010/common-presets/commit/d9743af383e66d3365db4024cbf7c40572eb50d4))
+- **deps:** update dependency eslint-plugin-unicorn to v54 ([33438db](https://github.com/foray1010/common-presets/commit/33438db1de6efc74a90510b5003e6464bcfd630f))
+
 ## [12.2.3](https://github.com/foray1010/common-presets/compare/@foray1010/eslint-config@12.2.2...@foray1010/eslint-config@12.2.3) (2024-06-09)
 
 ### Bug Fixes

package/bases/base.mjs

@@ -1,12 +1,14 @@
 import js from '@eslint/js'
 import eslintPluginEslintComments from '@eslint-community/eslint-plugin-eslint-comments'
 import { hasDep, isESM } from '@foray1010/common-presets-utils'
-import eslintPluginImport from 'eslint-plugin-import'
+import eslintPluginImportX from 'eslint-plugin-import-x'
 import eslintPluginJest from 'eslint-plugin-jest'
 import eslintPluginRegexp from 'eslint-plugin-regexp'
 import eslintPluginSimpleImportSort from 'eslint-plugin-simple-import-sort'
 import eslintPluginUnicorn from 'eslint-plugin-unicorn'
 import globals from 'globals'
+// eslint-disable-next-line import-x/no-unresolved
+import tseslint from 'typescript-eslint'
 
 import {
   testFileGlobs,
@@ -21,23 +23,21 @@ async function generateTypeScriptConfig() {
   // typescript plugins are depended on `typescript` package
   if (!hasDep('typescript')) return []
 
-  /* eslint-disable import/no-unresolved */
-  const eslintPluginTypescriptEslint = (
-    await import('@typescript-eslint/eslint-plugin')
-  ).default
-  const typescriptEslintParser = (await import('@typescript-eslint/parser'))
-    .default
-  /* eslint-enable import/no-unresolved */
   const eslintPluginDeprecation = (await import('eslint-plugin-deprecation'))
     .default
   const eslintPluginFunctional = (await import('eslint-plugin-functional'))
     .default
 
   return [
-    {
+    // @ts-expect-error `Type 'Config' is not assignable to type 'Readonly<FlatConfig<RulesRecord>>' with 'exactOptionalPropertyTypes: true'`
+    ...tseslint.config({
       files: typeScriptFileGlobs,
+      extends: [
+        tseslint.configs.eslintRecommended,
+        ...tseslint.configs.recommendedTypeChecked,
+        esmConfig,
+      ],
       languageOptions: {
-        parser: typescriptEslintParser,
         parserOptions: {
           // faster linting on cli
           // https://github.com/typescript-eslint/typescript-eslint/issues/3528
@@ -47,30 +47,16 @@ async function generateTypeScriptConfig() {
         },
       },
       settings: {
-        'import/resolver': {
+        'import-x/resolver': {
           typescript: true,
         },
       },
       plugins: {
-        // @ts-expect-error
-        '@typescript-eslint': eslintPluginTypescriptEslint,
-        // @ts-expect-error
         deprecation: eslintPluginDeprecation,
-        // @ts-expect-error
         functional: eslintPluginFunctional,
       },
       rules: {
-        ...eslintPluginTypescriptEslint.configs[
-          'eslint-recommended'
-        ]?.overrides?.reduce(
-          (acc, override) => ({ ...acc, ...override.rules }),
-          {},
-        ),
-        ...eslintPluginTypescriptEslint.configs['recommended']?.rules,
-        ...eslintPluginTypescriptEslint.configs[
-          'recommended-requiring-type-checking'
-        ]?.rules,
-        ...eslintPluginImport.configs['typescript']?.rules,
+        ...eslintPluginImportX.configs['typescript']?.rules,
         // extend existing rule
         '@typescript-eslint/ban-types': [
           'error',
@@ -230,14 +216,10 @@ async function generateTypeScriptConfig() {
         // It is disabled in recommended config but re-enabled here to enforce a subset of global variables that supported by both node.js and browsers
         'no-undef': 'error',
       },
-    },
+    }),
+    // @ts-expect-error As previous item's type is not correct, this item is affected too
     {
       files: typeScriptTestFileGlobs,
-      plugins: {
-        // @ts-expect-error
-        '@typescript-eslint': eslintPluginTypescriptEslint,
-        jest: eslintPluginJest,
-      },
       rules: {
         // doesn't work with jest.fn<void>()
         '@typescript-eslint/no-invalid-void-type': 'off',
@@ -247,10 +229,6 @@ async function generateTypeScriptConfig() {
         'jest/unbound-method': ['error', { ignoreStatic: true }],
       },
     },
-    {
-      files: typeScriptFileGlobs,
-      ...esmConfig,
-    },
   ]
 }
 
@@ -285,12 +263,12 @@ const esmConfig = {
 /** @type {EslintConfig} */
 const baseConfig = [
   js.configs.recommended,
+  eslintPluginRegexp.configs['flat/recommended'],
   {
     languageOptions: {
       ecmaVersion: 2023,
       globals: {
-        // No es2022/es2023 preset yet
-        ...globals.es2021,
+        ...globals.es2023,
         /* Not using `node` to explicitly import node.js only built-in modules, e.g.
          * import { Buffer } from 'node:buffer'
          * import process from 'node:process'
@@ -300,19 +278,13 @@ const baseConfig = [
     },
     plugins: {
       '@eslint-community/eslint-comments': eslintPluginEslintComments,
-      import: eslintPluginImport,
-      regexp: eslintPluginRegexp,
+      // @ts-expect-error Type is not compact with flat config
+      'import-x': eslintPluginImportX,
       unicorn: eslintPluginUnicorn,
     },
     rules: {
       ...eslintPluginEslintComments.configs['recommended']?.rules,
-      ...eslintPluginImport.configs['recommended']?.rules,
-      ...(() => {
-        const rules = eslintPluginRegexp.configs['recommended']?.rules
-        return /** @type {import('eslint').Linter.RulesRecord} */ (
-          /** @type {unknown} */ (rules)
-        )
-      })(),
+      ...eslintPluginImportX.configs['recommended']?.rules,
       ...Object.fromEntries(
         Object.entries(
           eslintPluginUnicorn.configs['flat/recommended']?.rules ?? {},
@@ -334,9 +306,9 @@ const baseConfig = [
       // always use named function for easier to debug via stack trace
       'func-names': ['error', 'as-needed'],
       // this rule doesn't support commonjs, some dependencies are using commonjs
-      'import/default': 'off',
+      'import-x/default': 'off',
       // enforce extensions for both cjs and esm
-      'import/extensions': [
+      'import-x/extensions': [
         'error',
         // https://nodejs.org/docs/latest-v14.x/api/esm.html#esm_mandatory_file_extensions
         'always',
@@ -351,12 +323,12 @@ const baseConfig = [
         },
       ],
       // make sure import statements above the others
-      'import/first': 'error',
+      'import-x/first': 'error',
       // separate import statements from the others
-      'import/newline-after-import': 'error',
+      'import-x/newline-after-import': 'error',
       // avoid anonymous function or class for easier to debug via stack trace
       // for other types, enforcing named data can improve autocomplete when importing
-      'import/no-anonymous-default-export': [
+      'import-x/no-anonymous-default-export': [
         'error',
         {
           allowArray: false,
@@ -369,7 +341,7 @@ const baseConfig = [
         },
       ],
       // no circular dependency
-      'import/no-cycle': [
+      'import-x/no-cycle': [
         'error',
         {
           // speed up linting time
@@ -377,7 +349,7 @@ const baseConfig = [
         },
       ],
       // do not allow import packages that are not listed in dependencies or peerDependencies
-      'import/no-extraneous-dependencies': [
+      'import-x/no-extraneous-dependencies': [
         'error',
         {
           devDependencies: [
@@ -388,9 +360,9 @@ const baseConfig = [
         },
       ],
       // forbid a module from importing itself
-      'import/no-self-import': 'error',
+      'import-x/no-self-import': 'error',
       // use the shortest path in import statement, but allow /index because it will be standard to omit index as default file in directory
-      'import/no-useless-path-segments': [
+      'import-x/no-useless-path-segments': [
         'error',
         {
           commonjs: true,
@@ -398,9 +370,10 @@ const baseConfig = [
         },
       ],
       // turn off these rules as they do not support flat config: https://github.com/import-js/eslint-plugin-import/issues/2556
-      'import/namespace': 'off',
-      'import/no-named-as-default': 'off',
-      'import/no-named-as-default-member': 'off',
+      // Getting this error for eslint-plugin-import-x: `sourceType 'module' is not supported when ecmaVersion < 2015. Consider adding `{ ecmaVersion: 2015 }` to the parser options. (undefined:undefined)`
+      'import-x/namespace': 'off',
+      'import-x/no-named-as-default': 'off',
+      'import-x/no-named-as-default-member': 'off',
       // prefer explicitly convert type for readability
       'no-implicit-coercion': 'error',
       // make sure private class members are in-use
@@ -448,15 +421,12 @@ const baseConfig = [
   },
   {
     files: testFileGlobs,
-    languageOptions: {
-      globals: globals.jest,
-    },
-    plugins: {
-      jest: eslintPluginJest,
-    },
+    ...eslintPluginJest.configs['flat/recommended'],
+    ...eslintPluginJest.configs['flat/style'],
+  },
+  {
+    files: testFileGlobs,
     rules: {
-      ...eslintPluginJest.configs['recommended']?.rules,
-      ...eslintPluginJest.configs['style']?.rules,
       // make sure lifecycle hooks on the top for readability
       'jest/prefer-hooks-on-top': 'error',
     },

package/bases/browser.mjs

@@ -1,7 +1,7 @@
 import { hasDep } from '@foray1010/common-presets-utils'
 import restrictedGlobals from 'confusing-browser-globals'
 import eslintPluginCompat from 'eslint-plugin-compat'
-import eslintPluginImport from 'eslint-plugin-import'
+import eslintPluginImportX from 'eslint-plugin-import-x'
 import eslintPluginTestingLibrary from 'eslint-plugin-testing-library'
 import globals from 'globals'
 
@@ -19,12 +19,7 @@ async function generateJestDomConfig() {
   return [
     {
       files: testFileGlobs,
-      plugins: {
-        'jest-dom': eslintPluginJestDom,
-      },
-      rules: {
-        ...eslintPluginJestDom.configs['recommended']?.rules,
-      },
+      ...eslintPluginJestDom.configs['flat/recommended'],
     },
   ]
 }
@@ -42,12 +37,13 @@ const browserConfig = [
     },
     plugins: {
       compat: eslintPluginCompat,
-      import: eslintPluginImport,
+      // @ts-expect-error Type is not compact with flat config
+      'import-x': eslintPluginImportX,
     },
     rules: {
       'compat/compat': 'error',
       // frontend environment doesn't support node.js modules
-      'import/no-nodejs-modules': 'error',
+      'import-x/no-nodejs-modules': 'error',
       'no-restricted-globals': ['error', ...restrictedGlobals],
     },
   },
@@ -60,7 +56,7 @@ const browserConfig = [
     rules: {
       ...eslintPluginTestingLibrary.configs['dom']?.rules,
       // allow to use nodejs modules in tests
-      'import/no-nodejs-modules': 'off',
+      'import-x/no-nodejs-modules': 'off',
     },
   },
 ]

package/bases/prettier.mjs

@@ -1,19 +1,12 @@
-import eslintConfigPrettier from 'eslint-config-prettier'
-import eslintPluginPrettier from 'eslint-plugin-prettier'
+// eslint-disable-next-line import-x/extensions
+import eslintPluginPrettierRecommended from 'eslint-plugin-prettier/recommended'
 
 /** @typedef {import('../types/internal.d.ts').EslintConfig} EslintConfig */
 
 /** @type {EslintConfig} */
+// should be placed at the end to override other configs
 const prettierConfig = [
-  // should be placed at the end to override other configs
-  {
-    plugins: {
-      prettier: eslintPluginPrettier,
-    },
-    rules: {
-      ...eslintConfigPrettier.rules,
-      ...eslintPluginPrettier.configs['recommended']?.rules,
-    },
-  },
+  // This includes `eslint-config-prettier` as peer dependency
+  eslintPluginPrettierRecommended,
 ]
 export default prettierConfig

package/bases/react.mjs

@@ -8,28 +8,18 @@ import { testFileGlobs } from '../constants.mjs'
 
 /** @type {EslintConfig} */
 const reactConfig = [
+  eslintPluginReact.configs.flat.recommended,
+  eslintPluginReact.configs.flat['jsx-runtime'],
   {
-    languageOptions: {
-      parserOptions: {
-        ecmaFeatures: {
-          jsx: true,
-        },
-        // copied from `eslintPluginReact.configs['jsx-runtime']`
-        jsxPragma: null, // for @typescript-eslint/parser
-      },
-    },
     settings: {
       react: {
         version: 'detect',
       },
     },
     plugins: {
-      react: eslintPluginReact,
       'react-hooks': eslintPluginReactHooks,
     },
     rules: {
-      ...eslintPluginReact.configs['recommended']?.rules,
-      ...eslintPluginReact.configs['jsx-runtime']?.rules,
       ...eslintPluginReactHooks.configs['recommended']?.rules,
       // avoid unexpected form submits
       'react/button-has-type': 'error',

package/package.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json.schemastore.org/package",
   "name": "@foray1010/eslint-config",
-  "version": "12.2.3",
+  "version": "12.3.0",
   "homepage": "https://github.com/foray1010/common-presets/tree/master/packages/eslint-config#readme",
   "bugs": "https://github.com/foray1010/common-presets/issues",
   "repository": {
@@ -23,26 +23,25 @@
     "@eslint-community/eslint-plugin-eslint-comments": "^4.1.0",
     "@eslint/js": "^8.53.0",
     "@foray1010/common-presets-utils": "^8.0.0",
-    "@typescript-eslint/eslint-plugin": "^7.0.0",
-    "@typescript-eslint/parser": "^7.0.0",
     "confusing-browser-globals": "^1.0.11",
-    "eslint-config-prettier": "^9.0.0",
+    "eslint-config-prettier": "^9.1.0",
     "eslint-import-resolver-typescript": "^3.6.1",
-    "eslint-plugin-compat": "^4.2.0",
+    "eslint-plugin-compat": "^6.0.0",
     "eslint-plugin-deprecation": "^3.0.0",
     "eslint-plugin-functional": "^6.0.0",
-    "eslint-plugin-import": "^2.29.0",
-    "eslint-plugin-jest": "^28.0.0",
-    "eslint-plugin-jest-dom": "^5.1.0",
+    "eslint-plugin-import-x": "^3.0.1",
+    "eslint-plugin-jest": "^28.6.0",
+    "eslint-plugin-jest-dom": "^5.4.0",
     "eslint-plugin-n": "^17.0.0",
-    "eslint-plugin-prettier": "^5.0.1",
-    "eslint-plugin-react": "^7.33.2",
+    "eslint-plugin-prettier": "^5.2.1",
+    "eslint-plugin-react": "^7.35.0",
     "eslint-plugin-react-hooks": "^4.6.0",
-    "eslint-plugin-regexp": "^2.1.1",
+    "eslint-plugin-regexp": "^2.6.0",
     "eslint-plugin-simple-import-sort": "^12.0.0",
     "eslint-plugin-testing-library": "^6.1.2",
-    "eslint-plugin-unicorn": "^53.0.0",
-    "globals": "^15.0.0"
+    "eslint-plugin-unicorn": "^54.0.0",
+    "globals": "^15.4.0",
+    "typescript-eslint": "^7.16.1"
   },
   "devDependencies": {
     "@types/confusing-browser-globals": "1.0.3",
@@ -69,5 +68,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "174cbacf95dbe42da4b06de9a009096c2eb7a196"
+  "gitHead": "e751b4ba48732b04545e8f4b99e682cf5ba74dab"
 }