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;

lib/rules/no-wait-for-snapshot.ts

@@ -1,7 +1,7 @@
 // Copied from https://github.com/babel/babel/blob/b35c78f08dd854b08575fc66ebca323fdbc59dab/packages/babel-helpers/src/helpers.js#L615-L619
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 const interopRequireDefault = <T>(obj: any): { default: T } =>
-	// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access,@typescript-eslint/no-unsafe-assignment
+	// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access,@typescript-eslint/no-unsafe-assignment,@typescript-eslint/no-unsafe-return
 	obj?.__esModule ? obj : { default: obj };
 
 export const importDefault = <T>(moduleName: string): T =>

lib/utils/file-import.ts

@@ -1,7 +1,7 @@
 {
 	"name": "eslint-plugin-testing-library",
 	"version": "0.0.0-semantically-released",
-	"description": "ESLint rules for Testing Library",
+	"description": "ESLint plugin to follow best practices and anticipate common mistakes when writing tests with Testing Library",
 	"keywords": [
 		"eslint",
 		"eslintplugin",
@@ -21,16 +21,17 @@
 	"license": "MIT",
 	"author": {
 		"name": "Mario Beltrán Alarcón",
-		"email": "[email protected]",
+		"email": "[email protected]",
 		"url": "https://mario.dev/"
 	},
 	"main": "index.js",
 	"scripts": {
+		"prebuild": "del-cli dist",
 		"build": "tsc",
 		"postbuild": "cpy README.md ./dist && cpy package.json ./dist && cpy LICENSE ./dist",
-		"docs:gen": "run-p \"docs:gen:*\"",
-		"docs:gen:configs": "ts-node tools/generate-configs",
-		"docs:gen:rules-list": "npm run build && npm run rule-doc-generator && npm run format",
+		"generate-all": "run-p \"generate:*\"",
+		"generate:configs": "ts-node tools/generate-configs",
+		"generate:rules-doc": "npm run build && npm run rule-doc-generator",
 		"format": "npm run prettier-base -- --write",
 		"format:check": "npm run prettier-base -- --check",
 		"lint": "eslint . --max-warnings 0 --ext .js,.ts",
@@ -41,7 +42,6 @@
 		"semantic-release": "semantic-release",
 		"test": "jest",
 		"test:ci": "jest --ci --coverage",
-		"test:update": "npm run test -- --u",
 		"test:watch": "npm run test -- --watch",
 		"type-check": "tsc --noEmit"
 	},
@@ -59,6 +59,7 @@
 		"@typescript-eslint/eslint-plugin": "^5.43.0",
 		"@typescript-eslint/parser": "^5.43.0",
 		"cpy-cli": "^4.2.0",
+		"del-cli": "^5.0.0",
 		"eslint": "^8.28.0",
 		"eslint-config-kentcdodds": "^20.4.0",
 		"eslint-config-prettier": "^8.5.0",
@@ -70,13 +71,13 @@
 		"eslint-plugin-prettier": "^4.2.1",
 		"eslint-plugin-promise": "^6.1.1",
 		"eslint-remote-tester": "^3.0.0",
-		"eslint-remote-tester-repositories": "^0.0.7",
+		"eslint-remote-tester-repositories": "^1.0.0",
 		"husky": "^8.0.2",
 		"is-ci": "^3.0.1",
 		"jest": "^28.1.3",
 		"lint-staged": "^13.0.3",
 		"npm-run-all": "^4.1.5",
-		"prettier": "2.8.0",
+		"prettier": "2.8.1",
 		"semantic-release": "^19.0.5",
 		"ts-jest": "^28.0.8",
 		"ts-node": "^10.9.1",

package.json

@@ -67,6 +67,7 @@ it('should export configs that refer to actual rules', () => {
 		expect(rule.startsWith(ruleNamePrefix)).toBe(true);
 		expect(ruleNames).toContain(ruleName);
 
+		// eslint-disable-next-line @typescript-eslint/no-unsafe-return
 		expect(() => require(`../lib/rules/${ruleName}`)).not.toThrow();
 	});
 });