feat: support ESLint flat config

jest.config.js

@@ -1,5 +1,5 @@
 module.exports = {
-	testMatch: ['**/tests/**/*.test.ts'],
+	roots: ['<rootDir>/tests/'],
 	transform: {
 		'^.+\\.ts$': '@swc/jest',
 	},

lib/configs/angular.ts

@@ -3,7 +3,6 @@
 // YOU CAN REGENERATE IT USING npm run generate:configs
 
 export = {
-	plugins: ['testing-library'],
 	rules: {
 		'testing-library/await-async-events': [
 			'error',

lib/configs/dom.ts

@@ -3,7 +3,6 @@
 // YOU CAN REGENERATE IT USING npm run generate:configs
 
 export = {
-	plugins: ['testing-library'],
 	rules: {
 		'testing-library/await-async-events': [
 			'error',

lib/configs/marko.ts

@@ -3,7 +3,6 @@
 // YOU CAN REGENERATE IT USING npm run generate:configs
 
 export = {
-	plugins: ['testing-library'],
 	rules: {
 		'testing-library/await-async-events': [
 			'error',

lib/configs/react.ts

@@ -3,7 +3,6 @@
 // YOU CAN REGENERATE IT USING npm run generate:configs
 
 export = {
-	plugins: ['testing-library'],
 	rules: {
 		'testing-library/await-async-events': [
 			'error',

lib/configs/vue.ts

@@ -3,7 +3,6 @@
 // YOU CAN REGENERATE IT USING npm run generate:configs
 
 export = {
-	plugins: ['testing-library'],
 	rules: {
 		'testing-library/await-async-events': [
 			'error',

lib/index.ts

@@ -1,7 +1,30 @@
+import {
+	name as packageName,
+	version as packageVersion,
+} from '../package.json';
+
 import configs from './configs';
 import rules from './rules';
+import { type SupportedTestingFramework } from './utils';
 
-export = {
+// TODO: type properly when upgraded to ESLint v9
+const plugin = {
+	meta: {
+		name: packageName,
+		version: packageVersion,
+	},
 	configs,
 	rules,
 };
+
+// TODO: type this with TSESLint.Linter.RuleEntry when upgraded to ESLint v9
+Object.keys(plugin.configs).forEach((configKey) => {
+	plugin.configs[configKey as SupportedTestingFramework].plugins = {
+		// TODO: remove ignored error when properly typed with ESLint v9
+		// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+		// @ts-ignore
+		'testing-library': plugin,
+	};
+});
+
+export = plugin;

package.json

@@ -29,7 +29,7 @@
 		"README.md",
 		"LICENSE"
 	],
-	"main": "./dist/index.js",
+	"main": "./dist/lib/index.js",
 	"scripts": {
 		"prebuild": "del-cli dist",
 		"build": "tsc",

tests/index.test.ts

@@ -43,6 +43,12 @@ it('should have the correct amount of rules', () => {
 	}
 });
 
+it('should refer to the plugin itself on each config', () => {
+	Object.entries(plugin.configs).forEach(([_, config]) => {
+		expect(config.plugins).toEqual({ 'testing-library': plugin });
+	});
+});
+
 it('should export configs that refer to actual rules', () => {
 	const allConfigs = plugin.configs;
 

tools/generate-configs/index.ts

@@ -33,7 +33,8 @@ const getRecommendedRulesForTestingFramework = (
 
 SUPPORTED_TESTING_FRAMEWORKS.forEach((framework) => {
 	const specificFrameworkConfig: LinterConfig = {
-		plugins: ['testing-library'],
+		// "plugins" property must be assigned after defining the plugin variable in the "lib/index.ts"
+		// https://eslint.org/docs/latest/extend/plugin-migration-flat-config#migrating-configs-for-flat-config
 		rules: getRecommendedRulesForTestingFramework(framework),
 	};