eslint-config-beslogic 4.0.2 → 4.1.0

package/CHANGELOG.md

@@ -1,9 +1,32 @@
 # Changelog
 
+## 4.1.0
+
+- Migrated from `eslint-plugin-import` to `eslint-plugin-import-x@^4.2.1` for performance and better support.
+
+## 4.0.3
+
+- Allow `^8.56 || ^9.12` for the ESLint version range. But v9 is completely untested.
+
 ## 4.0.2
 
-- Initial support for Flat Configs. v4 will only support Flat Configs (`eslint.config.js`), please use v3 for Legacy Configs (`.eslintrc`).
+### Important migration notes
+
+- You'll have to migrate your configs to use Flat Config
+  - We recommend `eslint.config.mjs` to use configs as ES Modules and be explicit about it.
+  - The README has been updated with basic configuration examples
+  - See <https://eslint.org/docs/latest/use/configure/migration-guide> for further help
+- You can remove `--ignore-path .gitignore` from your lint command.
 - `angular-eslint` won't work on HTML files on ESLint v8 due to parser configuration issues.
+- Nested configuration files autodiscovery won't work until [ESLint v9.12](https://github.com/eslint/eslint/pull/18742).\
+  In the mean time, you can extend your child configs in your parent with a `files` restriction.
+- `@eslint-community/eslint-comments/no-unused-disable` does not currently work with Flat Configs,
+  so unused disable comments are no longer reported.
+  See <https://github.com/eslint-community/eslint-plugin-eslint-comments/issues/244>
+
+### Rest of the changes
+
+- Initial support for Flat Configs. v4 will only support Flat Configs (`eslint.config.js`), please use v3 for Legacy Configs (`.eslintrc`).
 - Autodetection of `.gitignore` using `eslint-config-flat-gitignore`
 - Updated dependencies:
   - Using the combined `typescript-eslint` package instead of `@typescript-eslint/eslint-plugin` + `@typescript-eslint/parser`
@@ -16,6 +39,35 @@
   - Bumped `eslint-plugin-react` to `^7.37.1`
   - Added dependency on `@eslint/compat` and `eslint-config-flat-gitignore`
 
+## 3.2.0
+
+- Migrated from `eslint-plugin-import` to `eslint-plugin-import-x@^4.2.1` for performance and better support.
+  - This also forces `eslint` to version `8.57` or above
+
+## 3.1.4
+
+- Pinned `eslint-plugin-unicorn` to `>=49.0 && <57`
+
+## 3.1.3
+
+- Bumped `"@typescript-eslint` to `^8.15.0`
+- Disabled `sonarjs/fixme-tag`
+- Disabled `@typescript-eslint/no-unsafe-type-assertion` and `@typescript-eslint/related-getter-setter-pairs` in non-`extra-strict` presets.
+- Added `"checkTypePredicates": true` to `@typescript-eslint/no-unnecessary-condition`
+- Configured `@typescript-eslint/prefer-nullish-coalescing` as
+  <!-- markdownlint-disable-next-line MD031 -->
+  ```js
+  [
+    "error",
+    {
+      // > If you're looking to enforce stricter conditional tests,
+      // > you should consider using the strict-boolean-expressions rule.
+      "ignoreConditionalTests": true,
+      "ignoreBooleanCoercion": true
+    }
+  ],
+  ```
+
 ## 3.1.2
 
 - Removed `globalThis` from `no-restricted-globals` as the adoption is now much wider (no more IE11) and it conflicts with `unicorn/prefer-global-this`

package/README.md

@@ -6,7 +6,7 @@ Run `npm i  --save-dev eslint-config-beslogic`
 
 Depending on your needs, you will need to also install other peer dependencies for linting.
 
-In your `eslint.config.[cm]?js` file, simply [extend](https://typescript-eslint.io/getting-started#step-2-configuration) our [presets](#presets) appropriate for your project.
+In your `eslint.config.[cm]?js` file, simply [extend](https://typescript-eslint.io/packages/typescript-eslint#config) our [presets](#presets) appropriate for your project.
 
 For stylistic rules, it is highly recommended to use a dedicated formatter over ESLint. Read more here: <https://typescript-eslint.io/docs/linting/troubleshooting/formatting/>\
 We assume [dprint](https://dprint.dev/) and don't enable any rules it covers by default. If you're not using a formatter, a [stylistic.mjs](#stylisticmjs) configuration is offered below.

package/eslint.config.mjs

@@ -47,7 +47,7 @@ export default tseslint.config(
       "@stylistic/indent": "off",
 
       // We're using typescript (tsconfig) for that
-      "import/no-unresolved": "off",
+      "import-x/no-unresolved": "off",
 
       // TODO: Remove these config once we're no longer using the pre-flat-config compatibility layer
       "no-shadow": [
@@ -71,10 +71,10 @@ export default tseslint.config(
   },
   // We need to explicitely set these paths because
   // ESLint flat configs doesn't do automated config lookup until 9.12
-  { "files": ["static-tests/*"], "extends": [...staticTestsRoot] },
-  { "files": ["static-tests/angular/**"], "extends": [...staticTestsAngular] },
-  { "files": ["static-tests/javascript/**"], "extends": [...staticTestsJavascript] },
-  { "files": ["static-tests/react-typescript/**"], "extends": [...staticTestsReactTypeScript] },
-  { "files": ["static-tests/storybook/**"], "extends": [...staticTestsStorybook] },
-  { "files": ["static-tests/typescript/**"], "extends": [...staticTestsTypeScript] }
+  { "files": ["static-tests/*"], "extends": staticTestsRoot },
+  { "files": ["static-tests/angular/**"], "extends": staticTestsAngular },
+  { "files": ["static-tests/javascript/**"], "extends": staticTestsJavascript },
+  { "files": ["static-tests/react-typescript/**"], "extends": staticTestsReactTypeScript },
+  { "files": ["static-tests/storybook/**"], "extends": staticTestsStorybook },
+  { "files": ["static-tests/typescript/**"], "extends": staticTestsTypeScript }
 )

package/javascript.mjs

@@ -8,7 +8,7 @@ import restrictedGlobals from "confusing-browser-globals"
 import gitignore from "eslint-config-flat-gitignore"
 import autofix from "eslint-plugin-autofix"
 import extraRules from "eslint-plugin-extra-rules"
-import importPlugin from "eslint-plugin-import"
+import eslintPluginImportX from "eslint-plugin-import-x"
 import noAutofix from "eslint-plugin-no-autofix"
 import noRelativeImportPaths from "eslint-plugin-no-relative-import-paths"
 import preferArrow from "eslint-plugin-prefer-arrow"
@@ -118,7 +118,8 @@ export const noRestrictedImportsConfig = {
         "default",
         "React"
       ],
-      "message": "Please don't use the default React import."
+      "message": "Please don't use the default React import. "
+        + "You can configure `\"compilerOptions.jsx\": \"react-jsx\"` in tsconfig.json instead."
     },
     {
       // From https://github.com/angular-eslint/angular-eslint/blob/master/packages/eslint-plugin/src/configs/recommended--extra.json
@@ -178,7 +179,9 @@ export default tseslint.config(
   sonarjs.configs.recommended,
   unicorn.configs["flat/all"],
   regexp.configs["flat/recommended"],
-  importPlugin.flatConfigs.recommended,
+  /* eslint-disable-next-line import-x/no-named-as-default-member
+  -- https://github.com/un-ts/eslint-plugin-import-x/issues/285 */
+  eslintPluginImportX.flatConfigs.recommended,
   comments.recommended,
   {
     "plugins": {
@@ -329,30 +332,30 @@ export default tseslint.config(
       /*
        * import settings (https://github.com/import-js/eslint-plugin-import#rules)
        */
-      "import/consistent-type-specifier-style": [
+      "import-x/consistent-type-specifier-style": [
         "error",
         "prefer-top-level"
       ],
-      "import/newline-after-import": [
+      "import-x/newline-after-import": [
         "error",
         {
           "exactCount": true,
           "considerComments": true
         }
       ],
-      "import/no-duplicates": [
+      "import-x/no-duplicates": [
         "error",
         { "considerQueryString": true }
       ],
-      "import/no-empty-named-blocks": "error",
-      "import/no-named-as-default": "error",
-      "import/no-named-as-default-member": "error",
+      "import-x/no-empty-named-blocks": "error",
+      "import-x/no-named-as-default": "error",
+      "import-x/no-named-as-default-member": "error",
       // Extracted restricted import into its own rule so it's easier for projects to override/ignore
       "no-autofix/no-relative-import-paths/no-relative-import-paths": [
         "error",
         { "allowSameFolder": true }
       ],
-      "import/no-unresolved": [
+      "import-x/no-unresolved": [
         "error",
         // https://github.com/import-js/eslint-plugin-import/issues/3140
         { "ignore": ["typescript-eslint"] }
@@ -722,7 +725,7 @@ export default tseslint.config(
       "no-constant-binary-expression": "error",
       "no-constructor-return": "error",
       "no-dupe-else-if": "error",
-      // Obsoleted by import/no-duplicates
+      // Obsoleted by import-x/no-duplicates
       "no-duplicate-imports": "off",
       "no-extend-native": "error",
       "no-implied-eval": "error",

package/lib/patch-dependencies.mjs

@@ -143,7 +143,6 @@ const patches = [
           "to": "false"
         },
         {
-          // eslint-disable-next-line regexp/no-super-linear-move -- Is it really?
           "from": /.+?devkit_1\.ensurePackage\)\('prettier'.+?[\n;]/gu,
           "to": ""
         }

package/lib/utils.mjs

@@ -7,7 +7,6 @@ const getModuleVersion = (
   /** @type {number} */ fallbackVersion
 ) => {
   try {
-    // eslint-disable-next-line n/global-require -- Dynamic loading
     return Number.parseFloat(require(`${nodeModule}/package.json`).version)
   } catch (error) {
     if (

package/node-js.mjs

@@ -20,6 +20,11 @@ export default tseslint.config(
   // @ts-expect-error: TODO: Raise upstream
   n.configs["flat/recommended-script"],
   {
+    "settings": {
+      "import-x/resolver": {
+        "node": true
+      }
+    },
     "languageOptions": {
       "ecmaVersion": "latest", // Will be default in ESLint 9
       "sourceType": "module", // Will be default in ESLint 9

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "eslint-config-beslogic",
-  "version": "4.0.2",
+  "version": "4.1.0",
   "description": "ESLint rules, plugins and configs used at Beslogic",
   "main": "index.js",
   "// dependencies": "Run for ourselves when we install dependencies w/o running npm i afterward",
   "scripts": {
     "eslint": "set TIMING=1 && eslint .",
     "lint": "dprint check && npm run eslint",
-    "lint:fix": "dprint fmt && npm run eslint -- --fix",
+    "lint:fix": "npm run eslint -- --fix && dprint fmt",
     "upgrade": "npx npm-check-updates -u & npm i",
     "yalc": "yalc publish",
     "prepack": "type .gitignore* > .npmignore",
@@ -49,13 +49,13 @@
     "@types/eslint": "^8.56",
     "confusing-browser-globals": "^1.0",
     "dprint": "^0.40.2",
-    "eslint": "^8.56",
+    "eslint": "^8.56 || ^9.12",
     "eslint-config-flat-gitignore": "^1.0.0",
     "eslint-import-resolver-typescript": "^3.2.6",
     "eslint-plugin-autofix": "^1.1 || ^2.0",
     "eslint-plugin-etc": "^2.0",
     "eslint-plugin-extra-rules": "^0.0.0-development",
-    "eslint-plugin-import": "^2.30",
+    "eslint-plugin-import-x": "^4.2.1",
     "eslint-plugin-jest": "^28.7",
     "eslint-plugin-jest-formatting": "^3.1",
     "eslint-plugin-no-autofix": "^2.0",
@@ -84,20 +84,22 @@
     "eslint-plugin-storybook": "^0.10"
   },
   "// jest": "Don't install it, so that we test failure to specify jest version",
+  "// eslint": "v9 support is untested",
   "devDependencies": {
     "@angular/core": ">=18.0",
     "@types/node": "^18.0",
+    "@types/react": "^18.3.3",
     "eslint-plugin-eslint-plugin": "^6.0",
     "react": "^18.3.1",
     "yalc": "^1.0.0-pre.53"
   },
-  "// @eslint/compat": "Declares itself as ESLint 9 compatible only, but we need it for flat config compat",
+  "// eslint overrides": "Deps that declare themselves as ESLint 9 compatible only, but we need it for flat config compat",
   "overrides": {
     "@eslint/compat": {
-      "eslint": "^8.56"
+      "eslint": "^8.56 || ^9.12"
     },
     "eslint-config-flat-gitignore": {
-      "eslint": "^8.56"
+      "eslint": "^8.56 || ^9.12"
     }
   }
 }

package/tsconfig.json

@@ -9,7 +9,7 @@
     "allowSyntheticDefaultImports": true,
     "noUncheckedIndexedAccess": false,
     "noEmit": true,
-    "jsx": "react",
+    "jsx": "react-jsx",
     "allowJs": true,
     "checkJs": true,
     "noImplicitAny": false

package/typescript.mjs

@@ -7,7 +7,8 @@ import { fileURLToPath } from "node:url"
 import { fixupConfigRules } from "@eslint/compat"
 import { FlatCompat } from "@eslint/eslintrc"
 import js from "@eslint/js"
-import importPlugin from "eslint-plugin-import"
+import tsParser from "@typescript-eslint/parser"
+import eslintPluginImportX from "eslint-plugin-import-x"
 import globals from "globals"
 import tseslint from "typescript-eslint"
 
@@ -15,8 +16,6 @@ import { maxParams, noMagicNumbersConfig as noMagicNumbersConfigJS, noRestricted
 import beslogicJest from "./jest.mjs"
 import { jestFilePatterns, jestNoRestrictedSyntax } from "./lib/utils.mjs"
 
-// import tsParser from "@typescript-eslint/parser"
-
 const __filename = fileURLToPath(import.meta.url)
 const __dirname = path.dirname(__filename)
 const compat = new FlatCompat({
@@ -75,10 +74,12 @@ export default tseslint.config(
       ...tseslint.configs.all,
       // https://github.com/cartant/eslint-plugin-etc/issues/74
       fixupConfigRules(compat.extends("plugin:etc/recommended")),
-      importPlugin.flatConfigs.typescript
+      /* eslint-disable-next-line import-x/no-named-as-default-member
+      -- https://github.com/un-ts/eslint-plugin-import-x/issues/285 */
+      eslintPluginImportX.flatConfigs.typescript
     ],
     "languageOptions": {
-      // "parser": tsParser,
+      "parser": tsParser,
       "parserOptions": {
         "project": ["tsconfig?(.*).json"],
         // "useProjectService": true,
@@ -98,7 +99,7 @@ export default tseslint.config(
       }
     },
     "settings": {
-      "import/resolver": {
+      "import-x/resolver": {
         "typescript": {
           // Recommended by eslint-import-resolver-typescript
           // Always try to resolve types under `<root>@types` directory even it doesn't contain any source code, like `@types/unist`
@@ -111,25 +112,25 @@ export default tseslint.config(
           ]
         }
       },
-      "import/parsers": {
+      "import-x/parsers": {
         "@typescript-eslint/parser": [
           ".ts",
           ".tsx"
         ]
       },
-      // Required even with plugin:import/typescript
-      "import/extensions": [
+      // Required even with plugin:import-x/typescript
+      "import-x/extensions": [
         ".ts",
         ".tsx"
       ]
     },
     "rules": {
       // Slow and not as useful with TypeScript: https://github.com/import-js/eslint-plugin-import/issues/2340
-      "import/namespace": "off",
+      "import-x/namespace": "off",
       // TypeScript already ensures imports resolve
-      "import/no-unresolved": "off",
+      "import-x/no-unresolved": "off",
       // Already checked by @typescript-eslint/no-import-type-side-effects
-      "import/consistent-type-specifier-style": "off",
+      "import-x/consistent-type-specifier-style": "off",
 
       /*
        * Cartant's etc rules