Add ESLint 9 support and flat/recommended config

maks-rafalko · maks-rafalko · commit 4213cbe84752 · 2025-04-17T00:37:36.000+02:00
diff --git a/.eslint-doc-generatorrc.js b/.eslint-doc-generatorrc.js
@@ -0,0 +1,6 @@
+/** @type {import('eslint-doc-generator').GenerateOptions} */
+const config = {
+  configEmoji: [['flat/recommended', '☑️']],
+};
+
+module.exports = config;
diff --git a/README.md b/README.md
@@ -13,7 +13,9 @@ npm install -D eslint-plugin-proper-tests
 ```
 
 > [!NOTE]  
-> For `@typescript-eslint` v7 use version ^1.0.0 of this plugin. For `@typescript-eslint` v8 use version ^2.0.0 of this plugin.
+> For `@typescript-eslint` v7 use version ^1.0.0 of this plugin.
+> For `@typescript-eslint` v8 use version ^2.0.0 of this plugin.
+> For `@typescript-eslint` v9 use version ^2.1.0 of this plugin.
 
 ## Usage
 
@@ -109,14 +111,15 @@ and you are done, no other configuration is needed.
 <!-- begin auto-generated rules list -->
 
 💼 Configurations enabled in.\
+☑️ Set in the `flat/recommended` configuration.\
 ✅ Set in the `recommended` configuration.
 
-| Name                                                                               | Description                                                                                                     | 💼 |
-| :--------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------- | :- |
-| [no-long-arrays-in-test-each](docs/rules/no-long-arrays-in-test-each.md)           | Disallow using long arrays with objects inside `test.each()` or `it.each()`. Force moving them out of the file. | ✅  |
-| [no-mixed-expectation-groups](docs/rules/no-mixed-expectation-groups.md)           | Disallow mixing expectations for different variables between each other.                                        | ✅  |
-| [no-useless-matcher-to-be-defined](docs/rules/no-useless-matcher-to-be-defined.md) | Disallow using `.toBeDefined()` matcher when it is known that variable is always defined.                       | ✅  |
-| [no-useless-matcher-to-be-null](docs/rules/no-useless-matcher-to-be-null.md)       | Disallow using `.toBeNull()` when TypeScript types conflict with it.                                            | ✅  |
+| Name                                                                               | Description                                                                                                     | 💼   |
+| :--------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------- | :--- |
+| [no-long-arrays-in-test-each](docs/rules/no-long-arrays-in-test-each.md)           | Disallow using long arrays with objects inside `test.each()` or `it.each()`. Force moving them out of the file. | ☑️ ✅ |
+| [no-mixed-expectation-groups](docs/rules/no-mixed-expectation-groups.md)           | Disallow mixing expectations for different variables between each other.                                        | ☑️ ✅ |
+| [no-useless-matcher-to-be-defined](docs/rules/no-useless-matcher-to-be-defined.md) | Disallow using `.toBeDefined()` matcher when it is known that variable is always defined.                       | ☑️ ✅ |
+| [no-useless-matcher-to-be-null](docs/rules/no-useless-matcher-to-be-null.md)       | Disallow using `.toBeNull()` when TypeScript types conflict with it.                                            | ☑️ ✅ |
 
 <!-- end auto-generated rules list -->
 
diff --git a/docs/rules/no-long-arrays-in-test-each.md b/docs/rules/no-long-arrays-in-test-each.md
@@ -1,6 +1,6 @@
 # Disallow using long arrays with objects inside `test.each()` or `it.each()`. Force moving them out of the file (`proper-tests/no-long-arrays-in-test-each`)
 
-💼 This rule is enabled in the ✅ `recommended` config.
+💼 This rule is enabled in the following configs: ☑️ `flat/recommended`, ✅ `recommended`.
 
 <!-- end auto-generated rule header -->
 
diff --git a/docs/rules/no-mixed-expectation-groups.md b/docs/rules/no-mixed-expectation-groups.md
@@ -1,6 +1,6 @@
 # Disallow mixing expectations for different variables between each other (`proper-tests/no-mixed-expectation-groups`)
 
-💼 This rule is enabled in the ✅ `recommended` config.
+💼 This rule is enabled in the following configs: ☑️ `flat/recommended`, ✅ `recommended`.
 
 <!-- end auto-generated rule header -->
 
diff --git a/docs/rules/no-useless-matcher-to-be-defined.md b/docs/rules/no-useless-matcher-to-be-defined.md
@@ -1,6 +1,6 @@
 # Disallow using `.toBeDefined()` matcher when it is known that variable is always defined (`proper-tests/no-useless-matcher-to-be-defined`)
 
-💼 This rule is enabled in the ✅ `recommended` config.
+💼 This rule is enabled in the following configs: ☑️ `flat/recommended`, ✅ `recommended`.
 
 <!-- end auto-generated rule header -->
 
diff --git a/docs/rules/no-useless-matcher-to-be-null.md b/docs/rules/no-useless-matcher-to-be-null.md
@@ -1,6 +1,6 @@
 # Disallow using `.toBeNull()` when TypeScript types conflict with it (`proper-tests/no-useless-matcher-to-be-null`)
 
-💼 This rule is enabled in the ✅ `recommended` config.
+💼 This rule is enabled in the following configs: ☑️ `flat/recommended`, ✅ `recommended`.
 
 <!-- end auto-generated rule header -->
 
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-proper-tests",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "ESLint rules for writing more proper tests.",
   "keywords": [
     "eslint",
@@ -34,7 +34,8 @@
     "lint:docs": "markdownlint \"**/*.md\"",
     "lint:eslint-docs": "npm run update:eslint-docs -- --check",
     "update:eslint-docs": "npm run build && eslint-doc-generator",
-    "build": "tsc --build ./tsconfig.build.json"
+    "build": "tsc --build ./tsconfig.build.json",
+    "ci:build": "npm run build"
   },
   "dependencies": {
     "@typescript-eslint/eslint-plugin": "^8.8.1",
@@ -66,7 +67,7 @@
     "dist"
   ],
   "peerDependencies": {
-    "eslint": ">= 8",
+    "eslint": "^8.0.0 || ^9.0.0",
     "typescript": "*"
   },
   "peerDependenciesMeta": {
diff --git a/src/configs/recommended.ts b/src/configs/recommended.ts
diff --git a/src/plugin.spec.ts b/src/plugin.spec.ts
@@ -11,6 +11,6 @@ describe('proper tests plugin', (): void => {
   });
 
   test('it exposes recommended plugin', (): void => {
-    expect(Object.keys(plugin.configs)).toEqual(['recommended']);
+    expect(Object.keys(plugin.configs)).toEqual(['recommended', 'flat/recommended']);
   });
 });
diff --git a/src/plugin.ts b/src/plugin.ts
@@ -1,19 +1,40 @@
-import type { Linter } from '@typescript-eslint/utils/ts-eslint';
+import type { TSESLint } from '@typescript-eslint/utils';
 
-import recommended from './configs/recommended';
 import { noLongArraysInTestEach } from './custom-rules/no-long-arrays-in-test-each';
 import { noMixedExpectationGroups } from './custom-rules/no-mixed-expectation-groups';
 import { noUselessMatcherToBeDefined } from './custom-rules/no-useless-matcher-to-be-defined';
 import { noUselessMatcherToBeNull } from './custom-rules/no-useless-matcher-to-be-null';
 
-export = {
-  configs: {
-    recommended: recommended,
-  },
+const plugin = {
+  configs: {} as Record<'recommended' | 'flat/recommended', TSESLint.Linter.ConfigType>,
   rules: {
     'no-useless-matcher-to-be-defined': noUselessMatcherToBeDefined,
     'no-useless-matcher-to-be-null': noUselessMatcherToBeNull,
     'no-mixed-expectation-groups': noMixedExpectationGroups,
     'no-long-arrays-in-test-each': noLongArraysInTestEach,
   },
-} satisfies Linter.Plugin;
+};
+
+const recommendedRules = {
+  'proper-tests/no-useless-matcher-to-be-defined': 'error',
+  'proper-tests/no-useless-matcher-to-be-null': 'error',
+  'proper-tests/no-mixed-expectation-groups': 'error',
+  'proper-tests/no-long-arrays-in-test-each': 'error',
+} satisfies Record<string, TSESLint.Linter.RuleLevel>;
+
+const createRCConfig = (rules: Record<string, TSESLint.Linter.RuleLevel>): TSESLint.Linter.ConfigType => ({
+  plugins: ['proper-tests'],
+  rules,
+});
+
+const createFlatConfig = (rules: Record<string, TSESLint.Linter.RuleLevel>): TSESLint.Linter.ConfigType => ({
+  plugins: { 'proper-tests': plugin },
+  rules,
+});
+
+plugin.configs = {
+  recommended: createRCConfig(recommendedRules),
+  'flat/recommended': createFlatConfig(recommendedRules),
+};
+
+export = plugin;
