chore: migrate dev dependency ESLint to v9 (#1078)

Author: Belco90

.eslint-doc-generatorrc.js

@@ -1,4 +1,5 @@
 const prettier = require('prettier');
+
 const prettierConfig = require('./.prettierrc.js');
 
 /** @type {import('eslint-doc-generator').GenerateOptions} */

.eslintignore

@@ -0,0 +1,114 @@
+// @ts-check
+
+import js from '@eslint/js';
+import { defineConfig, globalIgnores } from 'eslint/config';
+import prettierConfig from 'eslint-config-prettier/flat';
+import { importX } from 'eslint-plugin-import-x';
+import jest from 'eslint-plugin-jest';
+import * as jestFormatting from 'eslint-plugin-jest-formatting';
+import globals from 'globals';
+import tseslint from 'typescript-eslint';
+
+const config = defineConfig(
+	js.configs.recommended,
+	tseslint.configs.recommendedTypeChecked,
+	importX.flatConfigs.recommended,
+	importX.flatConfigs.typescript,
+	{
+		name: 'Language options',
+		files: ['**/*.{js,mjs,cjs,ts,mts}'],
+		languageOptions: {
+			globals: {
+				...globals.node,
+			},
+			ecmaVersion: 'latest',
+			sourceType: 'module',
+			parser: tseslint.parser,
+			parserOptions: {
+				projectService: true,
+				tsconfigRootDir: import.meta.dirname,
+			},
+		},
+	},
+	{
+		name: 'Rules overrides for all files',
+		rules: {
+			// Base
+			'max-lines-per-function': 'off',
+			'no-console': 'warn',
+
+			// TypeScript
+			'@typescript-eslint/consistent-type-imports': 'error',
+			'@typescript-eslint/explicit-function-return-type': 'off',
+			'@typescript-eslint/no-unused-vars': [
+				'warn',
+				{
+					argsIgnorePattern: '^_',
+				},
+			],
+			'@typescript-eslint/no-use-before-define': 'off',
+
+			// Import
+			'import-x/order': [
+				'warn',
+				{
+					groups: [
+						'builtin',
+						'external',
+						'internal',
+						['parent', 'sibling', 'index'],
+						'object',
+						'type',
+					],
+					'newlines-between': 'always',
+
+					alphabetize: {
+						order: 'asc',
+						caseInsensitive: false,
+					},
+				},
+			],
+			'import-x/first': 'error',
+			'import-x/no-empty-named-blocks': 'error',
+			'import-x/no-extraneous-dependencies': 'error',
+			'import-x/no-mutable-exports': 'error',
+			'import-x/no-named-default': 'error',
+			'import-x/no-relative-packages': 'warn',
+		},
+	},
+	{
+		name: 'Rule overrides only for TypeScript files',
+		files: ['**/*.{ts,mts}'],
+		rules: {
+			// Rules enabled by `import-x/recommended` but are better handled by
+			// TypeScript and typescript-eslint.
+			'import-x/default': 'off',
+			'import-x/export': 'off',
+			'import-x/namespace': 'off',
+			'import-x/no-unresolved': 'off',
+		},
+	},
+	{
+		name: 'Jest config',
+		files: ['**/*.test.ts', '**/*.test.js'],
+		...jest.configs['flat/recommended'],
+		...jestFormatting.configs['flat/recommended'],
+	},
+	{
+		name: 'Plain JS',
+		files: ['**/*.{js,mjs,cjs}'],
+		extends: [tseslint.configs.disableTypeChecked],
+	},
+	{
+		name: 'Config files',
+		files: ['**/*rc*.{js,mjs,cjs}', '**/*.config.{js,cjs,mjs,ts}'],
+		rules: {
+			'@typescript-eslint/no-require-imports': 'off',
+			'import-x/no-named-as-default-member': 'off',
+		},
+	},
+	globalIgnores(['**/coverage/', '**/dist/']),
+	prettierConfig // must always be the last one
+);
+
+export default config;

.eslintrc.js

@@ -1,12 +1,9 @@
 import { join } from 'path';
 
-import type { TSESLint } from '@typescript-eslint/utils';
+import { importDefault, SUPPORTED_TESTING_FRAMEWORKS } from '../utils';
 
-import {
-	importDefault,
-	SUPPORTED_TESTING_FRAMEWORKS,
-	SupportedTestingFramework,
-} from '../utils';
+import type { SupportedTestingFramework } from '../utils';
+import type { TSESLint } from '@typescript-eslint/utils';
 
 const configsDir = __dirname;
 

eslint.config.mjs

@@ -1,4 +1,4 @@
-import { ASTUtils, TSESLint, TSESTree } from '@typescript-eslint/utils';
+import { ASTUtils } from '@typescript-eslint/utils';
 
 import {
 	findClosestVariableDeclaratorNode,
@@ -9,7 +9,6 @@ import {
 	getPropertyIdentifierNode,
 	getReferenceNode,
 	hasImportMatch,
-	ImportModuleNode,
 	isCallExpression,
 	isImportDeclaration,
 	isImportDefaultSpecifier,
@@ -31,6 +30,9 @@ import {
 	isTestingLibraryModule,
 } from '../utils/is-testing-library-module';
 
+import type { ImportModuleNode } from '../node-utils';
+import type { TSESLint, TSESTree } from '@typescript-eslint/utils';
+
 const SETTING_OPTION_OFF = 'off';
 
 export type TestingLibrarySettings = {
@@ -490,7 +492,6 @@ export function detectTestingLibraryUtils<
 		/**
 		 * Determines whether a given node is fireEvent method or not
 		 */
-		// eslint-disable-next-line complexity
 		const isFireEventMethod: IsFireEventMethodFn = (node) => {
 			const fireEventUtil =
 				findImportedTestingLibraryUtilSpecifier(FIRE_EVENT_NAME);
@@ -527,7 +528,6 @@ export function detectTestingLibraryUtils<
 
 			// we know it's defined at this point, but TS seems to think it is not
 			// so here I'm enforcing it once in order to avoid using "!" operator every time
-			// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
 			const definedParentMemberExpression = parentMemberExpression!;
 
 			// check fireEvent.click() usage

lib/configs/index.ts

@@ -1,14 +1,14 @@
 import { ESLintUtils } from '@typescript-eslint/utils';
 
-import {
-	getDocsUrl,
+import { getDocsUrl } from '../utils';
+import { detectTestingLibraryUtils } from './detect-testing-library-utils';
+
+import type {
 	TestingLibraryPluginDocs,
 	TestingLibraryPluginRuleModule,
 } from '../utils';
-
-import {
+import type {
 	DetectionOptions,
-	detectTestingLibraryUtils,
 	EnhancedRuleCreate,
 } from './detect-testing-library-utils';
 

lib/create-testing-library-rule/detect-testing-library-utils.ts

@@ -1,8 +1,8 @@
-import type { TSESLint } from '@typescript-eslint/utils';
-
 import configs from './configs';
 import rules from './rules';
-import { SupportedTestingFramework } from './utils';
+
+import type { SupportedTestingFramework } from './utils';
+import type { TSESLint } from '@typescript-eslint/utils';
 
 // we can't natively import package.json as tsc will copy it into dist/
 const {

lib/create-testing-library-rule/index.ts

@@ -1,13 +1,7 @@
-import { FunctionScope, ScopeType } from '@typescript-eslint/scope-manager';
-import {
-	AST_NODE_TYPES,
-	ASTUtils,
-	TSESLint,
-	TSESTree,
-} from '@typescript-eslint/utils';
+import { ScopeType } from '@typescript-eslint/scope-manager';
+import { AST_NODE_TYPES, ASTUtils } from '@typescript-eslint/utils';
 
 import { getDeclaredVariables, getScope } from '../utils';
-
 import {
 	isArrayExpression,
 	isArrowFunctionExpression,
@@ -28,6 +22,9 @@ import {
 	isVariableDeclaration,
 } from './is-node-of-type';
 
+import type { FunctionScope } from '@typescript-eslint/scope-manager';
+import type { TSESLint, TSESTree } from '@typescript-eslint/utils';
+
 export * from './is-node-of-type';
 
 const ValidLeftHandSideExpressions = [
@@ -301,7 +298,6 @@ export function getVariableReferences(
 	node: TSESTree.Node
 ): TSESLint.Scope.Reference[] {
 	if (ASTUtils.isVariableDeclarator(node)) {
-		// eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
 		return getDeclaredVariables(context, node)[0]?.references?.slice(1) ?? [];
 	}
 

lib/index.ts

@@ -1,4 +1,4 @@
-import { ASTUtils, TSESLint, TSESTree } from '@typescript-eslint/utils';
+import { ASTUtils } from '@typescript-eslint/utils';
 
 import { createTestingLibraryRule } from '../create-testing-library-rule';
 import {
@@ -12,6 +12,8 @@ import {
 } from '../node-utils';
 import { EVENTS_SIMULATORS } from '../utils';
 
+import type { TSESLint, TSESTree } from '@typescript-eslint/utils';
+
 export const RULE_NAME = 'await-async-events';
 export type MessageIds = 'awaitAsyncEvent' | 'awaitAsyncEventWrapper';
 const FIRE_EVENT_NAME = 'fireEvent';