feat: bundle in CJS and ESM formats (#1130)

Author: Belco90

.eslint-doc-generatorrc.js

@@ -1,9 +1,7 @@
-const prettier = require('prettier');
-
-const prettierConfig = require('./.prettierrc.js');
+import * as prettier from 'prettier';
 
 /** @type {import('eslint-doc-generator').GenerateOptions} */
-const config = {
+export default {
 	ignoreConfig: [
 		'flat/angular',
 		'flat/dom',
@@ -12,8 +10,8 @@ const config = {
 		'flat/svelte',
 		'flat/vue',
 	],
-	postprocess: (content) =>
-		prettier.format(content, { ...prettierConfig, parser: 'markdown' }),
+	postprocess: async (content, path) => {
+		const prettierConfig = await prettier.resolveConfig(path);
+		return prettier.format(content, { ...prettierConfig, parser: 'markdown' });
+	},
 };
-
-module.exports = config;

.github/workflows/smoke-test.yml

@@ -1,12 +1,15 @@
 name: Smoke test
 
 on:
-  schedule:
+  schedule: # Every Sunday at midnight
     - cron: '0 0 * * SUN'
-  workflow_dispatch:
+  workflow_dispatch: # Manual trigger
   release:
     types: [published]
 
+permissions:
+  issues: write # To create issues for test results
+
 jobs:
   test:
     runs-on: ubuntu-latest
@@ -27,12 +30,8 @@ jobs:
           pnpm install
           pnpm run build
 
-      - run: pnpm link
-        working-directory: ./dist
-
-      - run: pnpm link eslint-plugin-testing-library
-
       - uses: AriPerkkio/eslint-remote-tester-run-action@v4
         with:
-          issue-title: 'Results of weekly scheduled smoke test'
-          eslint-remote-tester-config: tests/eslint-remote-tester.config.js
+          issue-title: 'Results of smoke test'
+          issue-label: 'smoke-test'
+          eslint-remote-tester-config: eslint-remote-tester.config.ts

.github/workflows/verifications.yml

@@ -14,7 +14,13 @@ jobs:
       fail-fast: false
       matrix:
         validation-script:
-          ['lint', 'type-check', 'format:check', 'generate-all:check']
+          [
+            'lint',
+            'type-check',
+            'format:check',
+            'validate-gen-all',
+            'bundle-check',
+          ]
     steps:
       - name: Checkout
         uses: actions/checkout@v6
@@ -41,8 +47,8 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        node: [18.18.0, 18, 20.9.0, 20, 21.1.0, 21, 22, 23]
-        eslint: [8.57.0, 8, 9]
+        node: [18, 20, 21, 22, 23]
+        eslint: [8, 9]
     steps:
       - name: Checkout
         uses: actions/checkout@v6

.releaserc.json

@@ -57,13 +57,13 @@ Based on [ESLint's Rule Naming Conventions](https://eslint.org/docs/developer-gu
 In the [same way as ESLint](https://eslint.org/docs/developer-guide/working-with-rules),
 each rule has three files named with its identifier (e.g. `no-debugging-utils`):
 
-- in the `lib/rules` directory: a source file (e.g. `no-debugging-utils.ts`)
-- in the `tests/lib/rules` directory: a test file (e.g. `no-debugging-utils.ts`)
+- in the `src/rules` directory: a source file (e.g. `no-debugging-utils.ts`)
+- in the `tests/rules` directory: a test file (e.g. `no-debugging-utils.ts`)
 - in the `docs/rules` directory: a Markdown documentation file (e.g. `no-debugging-utils.md`)
 
 Additionally, you need to do a couple of extra things:
 
-- Run `pnpm run generate:rules-doc` to include your rule in the "Supported Rules" table within the [README.md](./README.md)
+- Run `pnpm run generate:docs` to include your rule in the "Supported Rules" table within the [README.md](./README.md)
 
 ### Custom rule creator
 

CONTRIBUTING.md

@@ -1,3 +1,3 @@
-module.exports = {
+export default {
 	extends: ['@commitlint/config-conventional'],
 };

commitlint.config.js

@@ -0,0 +1,40 @@
+import {
+	getPathIgnorePattern,
+	getRepositories,
+} from 'eslint-remote-tester-repositories';
+import { parser } from 'typescript-eslint';
+
+import testingLibraryPlugin from './src';
+
+import type { Config } from 'eslint-remote-tester';
+
+const eslintRemoteTesterConfig: Config = {
+	repositories: getRepositories({ randomize: true }),
+	pathIgnorePattern: getPathIgnorePattern(),
+	extensions: ['js', 'jsx', 'ts', 'tsx'],
+	concurrentTasks: 3,
+	cache: false,
+	logLevel: 'info',
+	eslintConfig: [
+		{
+			plugins: { 'testing-library': testingLibraryPlugin },
+			rules: {
+				...Object.fromEntries(
+					Object.keys(testingLibraryPlugin.rules).map((rule) => [
+						`testing-library/${rule}`,
+						'error',
+					])
+				),
+
+				// Rules with required options without default values
+				'testing-library/consistent-data-testid': [
+					'error',
+					{ testIdPattern: '^{fileName}(__([A-Z]+[a-z]_?)+)_$' },
+				],
+			},
+		},
+		{ languageOptions: { parser } },
+	] as Config['eslintConfig'],
+};
+
+export default eslintRemoteTesterConfig;