refactor: rework rule docs scripts (#694)

* refactor: rework rule docs scripts

* test: remove unnecessary config test

* style: avoid formatting after each gen command

* Revert "style: avoid formatting after each gen command"

This reverts commit c1bae58.

* refactor: remove node prefix imports

Co-authored-by: Michaël De Boey <info@michaeldeboey.be>
Signed-off-by: Mario Beltrán <belco90@gmail.com>

* test: remove old snapshot

* refactor: avoid format after doc gen

Signed-off-by: Mario Beltrán <belco90@gmail.com>
Co-authored-by: Michaël De Boey <info@michaeldeboey.be>

Author: Belco90

.github/pull_request_template.md

@@ -1,8 +1,6 @@
 ## Checks
 
 - [ ] I have read the [contributing guidelines](https://github.com/testing-library/eslint-plugin-testing-library/blob/main/CONTRIBUTING.md).
-- [ ] If some rule is added/updated/removed, I've regenerated the rules list (`npm run generate:rules-list`)
-- [ ] If some rule meta info is changed, I've regenerated the plugin shared configs (`npm run generate:configs`)
 
 ## Changes
 

.github/workflows/pipeline.yml

@@ -45,6 +45,9 @@ jobs:
       - name: Check format
         run: npm run format:check
 
+      - name: Check autogenerated docs
+        run: npm run docs:gen && npm run format && git diff --exit-code
+
   tests:
     name: Tests (Node v${{ matrix.node }} - ESLint v${{ matrix.eslint }})
     runs-on: ubuntu-latest

package.json

@@ -28,16 +28,16 @@
 	"scripts": {
 		"build": "tsc",
 		"postbuild": "cpy README.md ./dist && cpy package.json ./dist && cpy LICENSE ./dist",
-		"format": "prettier --write .",
-		"format:check": "prettier --check .",
-		"generate": "npm-run-all \"generate:*\"",
-		"generate:configs": "ts-node tools/generate-configs && npm run format",
-		"generate:rules-list": "npm run build && eslint-doc-generator --path-rule-list \"../README.md\" --path-rule-doc \"../docs/rules/{name}.md\" --url-rule-doc \"docs/rules/{name}.md\" dist/ && npm run format",
-		"lint": "npm-run-all \"lint:*\"",
-		"lint:generate": "npm run generate && git diff --exit-code",
-		"lint:js": "eslint . --max-warnings 0 --ext .js,.ts",
-		"lint:js:fix": "npm run lint:js -- --fix",
+		"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",
+		"format": "npm run prettier-base -- --write",
+		"format:check": "npm run prettier-base -- --check",
+		"lint": "eslint . --max-warnings 0 --ext .js,.ts",
+		"lint:fix": "npm run lint -- --fix",
 		"prepare": "is-ci || husky install",
+		"prettier-base": "prettier . --ignore-unknown --cache --loglevel warn",
+		"rule-doc-generator": "eslint-doc-generator --path-rule-list \"../README.md\" --path-rule-doc \"../docs/rules/{name}.md\" --url-rule-doc \"docs/rules/{name}.md\" dist/",
 		"semantic-release": "semantic-release",
 		"test": "jest",
 		"test:ci": "jest --ci --coverage",

tests/__snapshots__/index.test.ts.snap

@@ -1,13 +1,8 @@
-import { exec } from 'child_process';
 import { existsSync } from 'fs';
 import { resolve } from 'path';
-import util from 'util';
 
 import plugin from '../lib';
 
-const execAsync = util.promisify(exec);
-const generateConfigs = () => execAsync(`npm run generate:configs`);
-
 const numberOfRules = 27;
 const ruleNames = Object.keys(plugin.rules);
 
@@ -48,13 +43,6 @@ it('should have the correct amount of rules', () => {
 	}
 });
 
-it("should have run 'generate:configs' script when changing config rules", async () => {
-	await generateConfigs();
-
-	const allConfigs = plugin.configs;
-	expect(allConfigs).toMatchSnapshot();
-}, 20000);
-
 it('should export configs that refer to actual rules', () => {
 	const allConfigs = plugin.configs;