feat(deps): update to @typescript-eslint/* v8 (#955)

Author: MichaelDeBoey

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

@@ -36,23 +36,22 @@ export type TestingLibrarySettings = {
 };
 
 export type TestingLibraryContext<
-	TOptions extends readonly unknown[],
 	TMessageIds extends string,
+	TOptions extends readonly unknown[],
 > = Readonly<
 	TSESLint.RuleContext<TMessageIds, TOptions> & {
 		settings: TestingLibrarySettings;
 	}
 >;
 
 export type EnhancedRuleCreate<
-	TOptions extends readonly unknown[],
 	TMessageIds extends string,
-	TRuleListener extends TSESLint.RuleListener = TSESLint.RuleListener,
+	TOptions extends readonly unknown[],
 > = (
-	context: TestingLibraryContext<TOptions, TMessageIds>,
+	context: TestingLibraryContext<TMessageIds, TOptions>,
 	optionsWithDefault: Readonly<TOptions>,
 	detectionHelpers: Readonly<DetectionHelpers>
-) => TRuleListener;
+) => TSESLint.RuleListener;
 
 // Helpers methods
 type GetTestingLibraryImportNodeFn = () => ImportModuleNode | null;
@@ -156,15 +155,14 @@ export type DetectionOptions = {
  * Enhances a given rule `create` with helpers to detect Testing Library utils.
  */
 export function detectTestingLibraryUtils<
-	TOptions extends readonly unknown[],
 	TMessageIds extends string,
-	TRuleListener extends TSESLint.RuleListener = TSESLint.RuleListener,
+	TOptions extends readonly unknown[],
 >(
-	ruleCreate: EnhancedRuleCreate<TOptions, TMessageIds, TRuleListener>,
+	ruleCreate: EnhancedRuleCreate<TMessageIds, TOptions>,
 	{ skipRuleReportingCheck = false }: Partial<DetectionOptions> = {}
 ) {
 	return (
-		context: TestingLibraryContext<TOptions, TMessageIds>,
+		context: TestingLibraryContext<TMessageIds, TOptions>,
 		optionsWithDefault: Readonly<TOptions>
 	): TSESLint.RuleListener => {
 		const importedTestingLibraryNodes: ImportModuleNode[] = [];
@@ -214,6 +212,7 @@ export function detectTestingLibraryUtils<
 
 			const originalNodeName =
 				isImportSpecifier(importedUtilSpecifier) &&
+				ASTUtils.isIdentifier(importedUtilSpecifier.imported) &&
 				importedUtilSpecifier.local.name !== importedUtilSpecifier.imported.name
 					? importedUtilSpecifier.imported.name
 					: undefined;

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

@@ -1,6 +1,6 @@
-import { ESLintUtils, TSESLint } from '@typescript-eslint/utils';
+import { ESLintUtils } from '@typescript-eslint/utils';
 
-import { getDocsUrl, TestingLibraryRuleMeta } from '../utils';
+import { getDocsUrl, TestingLibraryPluginDocs } from '../utils';
 
 import {
 	DetectionOptions,
@@ -11,32 +11,27 @@ import {
 export const createTestingLibraryRule = <
 	TOptions extends readonly unknown[],
 	TMessageIds extends string,
-	TRuleListener extends TSESLint.RuleListener = TSESLint.RuleListener,
 >({
 	create,
 	detectionOptions = {},
-	meta,
 	...remainingConfig
-}: Readonly<{
-	name: string;
-	meta: TestingLibraryRuleMeta<TMessageIds, TOptions>;
-	defaultOptions: Readonly<TOptions>;
-	detectionOptions?: Partial<DetectionOptions>;
-	create: EnhancedRuleCreate<TOptions, TMessageIds, TRuleListener>;
-}>): TSESLint.RuleModule<TMessageIds, TOptions> =>
-	ESLintUtils.RuleCreator(getDocsUrl)({
+}: Readonly<
+	Omit<
+		ESLintUtils.RuleWithMetaAndName<
+			TOptions,
+			TMessageIds,
+			TestingLibraryPluginDocs<TOptions>
+		>,
+		'create'
+	> & {
+		create: EnhancedRuleCreate<TMessageIds, TOptions>;
+		detectionOptions?: Partial<DetectionOptions>;
+	}
+>) =>
+	ESLintUtils.RuleCreator<TestingLibraryPluginDocs<TOptions>>(getDocsUrl)({
 		...remainingConfig,
-		create: detectTestingLibraryUtils<TOptions, TMessageIds, TRuleListener>(
+		create: detectTestingLibraryUtils<TMessageIds, TOptions>(
 			create,
 			detectionOptions
 		),
-		meta: {
-			...meta,
-			docs: {
-				...meta.docs,
-				// We're using our own recommendedConfig meta to tell our build tools
-				// if the rule is recommended on a config basis
-				recommended: undefined,
-			},
-		},
 	});

lib/index.ts

@@ -8,7 +8,7 @@ import { SupportedTestingFramework } from './utils';
 const {
 	name: packageName,
 	version: packageVersion,
-	// eslint-disable-next-line @typescript-eslint/no-var-requires
+	// eslint-disable-next-line @typescript-eslint/no-require-imports
 } = require('../package.json') as { name: string; version: string };
 
 const plugin = {

lib/node-utils/index.ts

@@ -665,6 +665,7 @@ export function findImportSpecifier(
 		const namedExport = node.specifiers.find((n) => {
 			return (
 				isImportSpecifier(n) &&
+				ASTUtils.isIdentifier(n.imported) &&
 				[n.imported.name, n.local.name].includes(specifierName)
 			);
 		});

lib/rules/index.ts

@@ -1,26 +1,20 @@
 import { readdirSync } from 'fs';
 import { join, parse } from 'path';
 
-import { TSESLint } from '@typescript-eslint/utils';
-
-import { importDefault, TestingLibraryRuleMeta } from '../utils';
-
-type RuleModule = TSESLint.RuleModule<string, unknown[]> & {
-	meta: TestingLibraryRuleMeta<string, unknown[]> & {
-		recommended: false;
-	};
-};
+import { importDefault, TestingLibraryPluginRuleModule } from '../utils';
 
 const rulesDir = __dirname;
 const excludedFiles = ['index'];
 
 export default readdirSync(rulesDir)
 	.map((rule) => parse(rule).name)
 	.filter((ruleName) => !excludedFiles.includes(ruleName))
-	.reduce<Record<string, RuleModule>>(
+	.reduce<Record<string, TestingLibraryPluginRuleModule<string, unknown[]>>>(
 		(allRules, ruleName) => ({
 			...allRules,
-			[ruleName]: importDefault<RuleModule>(join(rulesDir, ruleName)),
+			[ruleName]: importDefault<
+				TestingLibraryPluginRuleModule<string, unknown[]>
+			>(join(rulesDir, ruleName)),
 		}),
 		{}
 	);

lib/rules/no-manual-cleanup.ts

@@ -75,6 +75,7 @@ export default createTestingLibraryRule<Options, MessageIds>({
 				const cleanupSpecifier = moduleNode.specifiers.find(
 					(specifier) =>
 						isImportSpecifier(specifier) &&
+						ASTUtils.isIdentifier(specifier.imported) &&
 						specifier.imported.name === 'cleanup'
 				);
 

lib/utils/file-import.ts

@@ -5,5 +5,5 @@ const interopRequireDefault = <T>(obj: any): { default: T } =>
 	obj?.__esModule ? obj : { default: obj };
 
 export const importDefault = <T>(moduleName: string): T =>
-	// eslint-disable-next-line @typescript-eslint/no-var-requires
+	// eslint-disable-next-line @typescript-eslint/no-require-imports
 	interopRequireDefault<T>(require(moduleName)).default;

lib/utils/types.ts

@@ -1,30 +1,30 @@
-import { type TSESLint } from '@typescript-eslint/utils';
+import { TSESLint } from '@typescript-eslint/utils';
 
 type Recommended = 'error' | 'warn' | false;
 type RecommendedConfig<TOptions extends readonly unknown[]> =
 	| Recommended
 	| [Recommended, ...TOptions];
 
-// These 2 types are copied from `@typescript-eslint/utils`' `CreateRuleMeta`
-// and modified to our needs
-export type TestingLibraryRuleMetaDocs<TOptions extends readonly unknown[]> =
-	Omit<TSESLint.RuleMetaDataDocs<TOptions>, 'recommended' | 'url'> & {
-		/**
-		 * The recommendation level for the rule on a framework basis.
-		 * Used by the build tools to generate the framework config.
-		 * Set to `false` to not include it the config
-		 */
-		recommendedConfig: Record<
-			SupportedTestingFramework,
-			RecommendedConfig<TOptions>
-		>;
-	};
-export type TestingLibraryRuleMeta<
+export type TestingLibraryPluginDocs<TOptions extends readonly unknown[]> = {
+	/**
+	 * The recommendation level for the rule on a framework basis.
+	 * Used by the build tools to generate the framework config.
+	 * Set to `false` to not include it the config
+	 */
+	recommendedConfig: Record<
+		SupportedTestingFramework,
+		RecommendedConfig<TOptions>
+	>;
+};
+
+export type TestingLibraryPluginRuleModule<
 	TMessageIds extends string,
 	TOptions extends readonly unknown[],
-> = Omit<TSESLint.RuleMetaData<TMessageIds, TOptions>, 'docs'> & {
-	docs: TestingLibraryRuleMetaDocs<TOptions>;
-};
+> = TSESLint.RuleModuleWithMetaDocs<
+	TMessageIds,
+	TOptions,
+	TestingLibraryPluginDocs<TOptions>
+>;
 
 export const SUPPORTED_TESTING_FRAMEWORKS = [
 	'dom',

lint-staged.config.js

@@ -1,4 +1,4 @@
-//eslint-disable-next-line @typescript-eslint/no-var-requires
+//eslint-disable-next-line @typescript-eslint/no-require-imports
 const { ESLint } = require('eslint');
 
 const removeIgnoredFiles = async (files) => {