IMTF ESLint 10 configurations

This package contains the ESLint configurations for the IMTF javascript / typescript projects.

Installation

npm install --save-dev @imtf/eslint-config

Usage

Create a eslint.config.js file in the root of your project and extend the desired configuration.

import { react, recommended, defineConfig } from "@imtf/eslint-config";

export default defineConfig([
  ...recommended,
  // If your project uses React, then also use specific rules
  ...react,
]);

And voilà, you are good to go !

Additional setup for typescript / react projects

If your project uses typescript, you will have to configure the @typescript-eslint/parser parser in your eslint.config.js file. You can do this by adding the following code to your configuration file:

import { react, recommended, defineConfig } from "@imtf/eslint-config";
import { createTypeScriptImportResolver } from "eslint-import-resolver-typescript";

export default defineConfig([
  ...recommended,
  ...react,
  {
    languageOptions: {
      parserOptions: {
        projectService: true,
        tsconfigRootDir: import.meta.dirname,
      },
    },
    settings: {
      react: {
        // Set this to your project's installed React version. Do not use
        // "detect": eslint-plugin-react's auto-detection relies on an
        // ESLint API removed in ESLint 10 and will crash your lint run.
        version: "19.2.8",
      },
      "import-x/resolver-next": [
        createTypeScriptImportResolver({
          project: import.meta.dirname,
        }),
      ],
    },
  },
]);

Rules

For more details about the rules, please refer to the GitHub repository.

As there is some new rule that has been enforced, you might have a lot of warnings / errors not showing up before in your project. As such, you might want to disable some of them and fix them progressively.

Migrate from @imtf/eslint-config-react

If you were using the @imtf/eslint-config-react package, you can easily migrate to the new package by following these steps:

1. Remove the @imtf/eslint-config-react package from your project:

npm uninstall @imtf/eslint-config-react

2. Also remove eslint and prettier

They where previously peer dependencies of the @imtf/eslint-config-react package, but are now direct dependencies of the @imtf/eslint-config package.

npm uninstall eslint prettier

3. Install the new @imtf/eslint-config package:

npm install --save-dev @imtf/eslint-config

4. Create a eslint.config.js file:

Have a look at the Usage section for more details. You will also probably want to reapply the custom rules you had in your previous configuration.

5. Remove the old .eslintrc config file.

Or any other ESLint < 9 configuration file you had.

Migrate from v1.6 to v2.0

Breaking change: TypeScript import resolver

v2.0 drops support for the legacy import-x/resolver setting in favour of the new import-x/resolver-next API introduced in [email protected].

1. Install eslint-import-resolver-typescript as a direct dev dependency:

npm install --save-dev eslint-import-resolver-typescript

2. Replace import-x/resolver with import-x/resolver-next in your eslint.config.js:

+import { createTypeScriptImportResolver } from "eslint-import-resolver-typescript";

 export default defineConfig([
   ...recommended,
   {
     settings: {
-      "import-x/resolver": {
-        typescript: {
-          project: import.meta.dirname,
-        },
-      },
+      "import-x/resolver-next": [
+        createTypeScriptImportResolver({
+          project: import.meta.dirname,
+        }),
+      ],
     },
   },
 ]);

Breaking change: ESLint 10 and the react.version setting

v2.0 upgrades ESLint from v9 to v10, along with the plugins it bundles (@typescript-eslint, typescript-eslint, eslint-plugin-import-x, eslint-plugin-react, eslint-plugin-react-hooks, etc.).

1. Make sure your project's Node.js version satisfies ESLint 10's requirement:

node: ^20.19.0 || ^22.13.0 || >=24

2. Stop setting settings.react.version to "detect".

eslint-plugin-react's "detect" auto-detection calls an ESLint API (context.getFilename()) that was removed in ESLint 10 — using it will crash your entire lint run, not just report a rule error. The react preset no longer sets "detect" itself; it sets a defaultVersion fallback instead, so your project keeps linting even if you configure nothing.

That fallback targets IMTF's own React version though, so for accurate rule behavior you should set settings.react.version explicitly to your project's actual installed React version, in a config placed after the react preset:

 export default defineConfig([
   ...recommended,
   ...react,
   {
     settings: {
-      react: {
-        version: "detect",
-      },
+      react: {
+        version: "19.2.8", // use your project's installed React version
+      },
     },
   },
 ]);

Breaking change: typescript is no longer a peer dependency

v2.0 drops the typescript peer dependency (previously ^4 || ^5). typescript is now a direct dependency of this package, pinned to a TypeScript 6 release.

This is intentional, not an oversight: @typescript-eslint's typed linting does not yet support TypeScript 7 (its main package export dropped the classic compiler API required for type-aware rules). Bundling a compatible TypeScript 6 copy lets this package's typed ESLint rules keep working even if your project itself has already moved to TypeScript 7 for its own build — the two are fully independent, since the parser resolves its own typescript dependency rather than your project's.

What to do: nothing lint-config-specific. If you previously installed typescript only to satisfy this package's peer dependency requirement, you can remove that reasoning — it's no longer required. You still need typescript installed for your own project's build/compile step, at whatever version you actually use (including TypeScript 7).