Merge remote-tracking branch 'origin/main' into alpha

Author: Belco90

.eslint-doc-generatorrc.js

@@ -0,0 +1,10 @@
+const prettier = require('prettier');
+const prettierConfig = require('./.prettierrc.js');
+
+/** @type {import('eslint-doc-generator').GenerateOptions} */
+const config = {
+	postprocess: (content) =>
+		prettier.format(content, { ...prettierConfig, parser: 'markdown' }),
+};
+
+module.exports = config;

.eslintrc.js

@@ -0,0 +1,60 @@
+module.exports = {
+	root: true,
+	extends: [
+		'kentcdodds',
+		'plugin:jest/recommended',
+		'plugin:jest-formatting/recommended',
+		'prettier',
+	],
+	rules: {
+		// Base
+		'max-lines-per-function': 'off',
+		'no-restricted-imports': [
+			'error',
+			{
+				patterns: [
+					{
+						group: ['@typescript-eslint/utils/dist/*'],
+						message: 'Import from `@typescript-eslint/utils` instead.',
+					},
+				],
+			},
+		],
+
+		// Import
+		'import/order': [
+			'warn',
+			{
+				groups: ['builtin', 'external', 'parent', 'sibling', 'index'],
+				'newlines-between': 'always',
+				alphabetize: {
+					order: 'asc',
+					caseInsensitive: false,
+				},
+			},
+		],
+	},
+	overrides: [
+		{
+			// TypeScript
+			files: ['**/*.ts?(x)'],
+			parser: '@typescript-eslint/parser',
+			parserOptions: {
+				tsconfigRootDir: __dirname,
+				project: ['./tsconfig.eslint.json'],
+			},
+			extends: [
+				'plugin:@typescript-eslint/recommended',
+				'plugin:@typescript-eslint/recommended-requiring-type-checking',
+			],
+			rules: {
+				'@typescript-eslint/explicit-function-return-type': 'off',
+				'@typescript-eslint/no-unused-vars': [
+					'warn',
+					{ argsIgnorePattern: '^_' },
+				],
+				'@typescript-eslint/no-use-before-define': 'off',
+			},
+		},
+	],
+};

.eslintrc.json

@@ -3,14 +3,13 @@ name: Pipeline
 on:
   push:
     branches:
-      # semantic-release valid branches, excluding all-contributors
+      # semantic-release valid branches
       - '+([0-9])?(.{+([0-9]),x}).x'
       - 'main'
       - 'next'
       - 'next-major'
       - 'beta'
       - 'alpha'
-      - '!all-contributors/**'
   pull_request:
     types: [opened, synchronize]
 
@@ -46,15 +45,16 @@ jobs:
         run: npm run format:check
 
       - name: Check autogenerated docs
-        run: npm run docs:gen && npm run format && git diff --exit-code
+        run: npm run generate-all && git diff --exit-code
 
   tests:
     name: Tests (Node v${{ matrix.node }} - ESLint v${{ matrix.eslint }})
     runs-on: ubuntu-latest
 
     strategy:
       matrix:
-        node: [12.22.0, 12, 14.17.0, 14, '16.0', 16, '18.0', 18]
+        # The .x indicates "the most recent one"
+        node: [19.x, 18.x, 17.x, 16.x, 14.x, 14.17.0, 12.x, 12.22.0]
         eslint: [7.5, 7, 8]
 
     steps:

.github/workflows/pipeline.yml

@@ -11,17 +11,23 @@ jobs:
   test:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Use Node
+        uses: actions/setup-node@v3
         with:
           node-version-file: '.nvmrc'
-          cache: 'npm'
+
       - run: |
           npm install
           npm run build
+
       - run: npm link
         working-directory: ./dist
+
       - run: npm link eslint-plugin-testing-library
+
       - uses: AriPerkkio/eslint-remote-tester-run-action@v3
         with:
           issue-title: 'Results of weekly scheduled smoke test'

.github/workflows/smoke-test.yml

@@ -1,2 +1,3 @@
 package-lock=false
 auto-install-peers=true
+enable-pre-post-scripts=true

.npmrc

@@ -38,8 +38,6 @@ The following will be run on every commit:
 - Check all tests are passing
 - Check commit message is following [Conventional Commit specification](https://www.conventionalcommits.org/en/v1.0.0/)
 
-If you ever need to update a snapshot, you can run `npm run test:update`
-
 ## Rule naming conventions
 
 Based on [ESLint's Rule Naming Conventions](https://eslint.org/docs/developer-guide/working-with-rules#rule-naming-conventions), you must follow these rules:
@@ -65,7 +63,7 @@ each rule has three files named with its identifier (e.g. `no-debugging-utils`):
 
 Additionally, you need to do a couple of extra things:
 
-- Run `npm run generate:rules-list` to include your rule in the "Supported Rules" table within the [README.md](./README.md)
+- Run `npm run generate:rules-doc` to include your rule in the "Supported Rules" table within the [README.md](./README.md)
 
 ### Custom rule creator
 

CONTRIBUTING.md

@@ -151,13 +151,16 @@ export default createTestingLibraryRule<Options, MessageIds>({
 					return;
 				}
 
+				const eventModuleName = getPropertyIdentifierNode(node)?.name;
+				const eventFullName = eventModuleName
+					? `${eventModuleName}.${simulateEventFunctionName}`
+					: simulateEventFunctionName;
+
 				context.report({
 					node,
 					messageId: 'noAwaitSyncEvents',
 					data: {
-						name: `${
-							getPropertyIdentifierNode(node)?.name
-						}.${simulateEventFunctionName}`,
+						name: eventFullName,
 					},
 				});
 			},

lib/rules/no-await-sync-events.ts

@@ -12,13 +12,22 @@ const DOM_TESTING_LIBRARY_MODULES = [
 	'@testing-library/dom',
 ];
 
-const correctModuleNameByFramework = {
+const CORRECT_MODULE_NAME_BY_FRAMEWORK: Record<
+	'angular' | 'marko' | string,
+	string | undefined
+> = {
 	angular: '@testing-library/angular', // ATL is *always* called `@testing-library/angular`
 	marko: '@marko/testing-library', // Marko TL is called `@marko/testing-library`
 };
-const getCorrectModuleName = (moduleName: string, framework: string): string =>
-	correctModuleNameByFramework[framework] ||
-	moduleName.replace('dom', framework);
+const getCorrectModuleName = (
+	moduleName: string,
+	framework: string
+): string => {
+	return (
+		CORRECT_MODULE_NAME_BY_FRAMEWORK[framework] ??
+		moduleName.replace('dom', framework)
+	);
+};
 
 export default createTestingLibraryRule<Options, MessageIds>({
 	name: RULE_NAME,

lib/rules/no-dom-import.ts

@@ -68,7 +68,9 @@ export default createTestingLibraryRule<Options, MessageIds>({
 		}
 
 		return {
-			[`Identifier[name=${SNAPSHOT_REGEXP}]`](node: TSESTree.Identifier) {
+			[`Identifier[name=${String(SNAPSHOT_REGEXP)}]`](
+				node: TSESTree.Identifier
+			) {
 				const closestAsyncUtil = getClosestAsyncUtil(node);
 				if (closestAsyncUtil === null) {
 					return;