Add auto-generated rules table to the readme (#1155)

Author: bmish

.github/workflows/main.yml

@@ -47,3 +47,4 @@ jobs:
           node-version: 14
       - run: npm install
       - run: npm run integration
+      - run: npm run generate-rules-table && git diff --exit-code

package.json

@@ -15,10 +15,11 @@
 	},
 	"scripts": {
 		"test": "xo && nyc ava",
-		"create-rule": "node ./scripts/create-rule.js",
+		"create-rule": "node ./scripts/create-rule.js && npm run generate-rules-table",
 		"run-rules-on-codebase": "node ./test/run-rules-on-codebase/lint.mjs",
 		"integration": "node ./test/integration/test.js",
-		"smoke": "eslint-remote-tester --config ./test/smoke/eslint-remote-tester.config.js"
+		"smoke": "eslint-remote-tester --config ./test/smoke/eslint-remote-tester.config.js",
+		"generate-rules-table": "node ./scripts/generate-rules-table.mjs"
 	},
 	"files": [
 		"index.js",

readme.md

@@ -109,6 +109,7 @@ module.exports = {
 	meta: {
 		type: 'suggestion',
 		docs: {
+			description: 'Improve regexes by making them shorter, consistent, and safer.',
 			url: getDocumentationUrl(__filename)
 		},
 		fixable: 'code',

rules/better-regex.js

@@ -130,6 +130,7 @@ module.exports = {
 	meta: {
 		type: 'suggestion',
 		docs: {
+			description: 'Enforce a specific parameter name in catch clauses.',
 			url: getDocumentationUrl(__filename)
 		},
 		fixable: 'code',

rules/catch-error-name.js

@@ -163,6 +163,7 @@ module.exports = {
 	meta: {
 		type: 'suggestion',
 		docs: {
+			description: 'Use destructured variables over properties.',
 			url: getDocumentationUrl(__filename)
 		},
 		fixable: 'code',

rules/consistent-destructuring.js

@@ -211,6 +211,7 @@ module.exports = {
 	meta: {
 		type: 'suggestion',
 		docs: {
+			description: 'Move function definitions to the highest possible scope.',
 			url: getDocumentationUrl(__filename)
 		},
 		schema,

rules/consistent-function-scoping.js

@@ -207,6 +207,7 @@ module.exports = {
 	meta: {
 		type: 'problem',
 		docs: {
+			description: 'Enforce correct `Error` subclassing.',
 			url: getDocumentationUrl(__filename)
 		},
 		fixable: 'code',

rules/custom-error-definition.js

@@ -43,6 +43,7 @@ module.exports = {
 	meta: {
 		type: 'layout',
 		docs: {
+			description: 'Enforce no spaces between braces.',
 			url: getDocumentationUrl(__filename)
 		},
 		fixable: 'whitespace',

rules/empty-brace-spaces.js

@@ -86,6 +86,7 @@ module.exports = {
 	meta: {
 		type: 'problem',
 		docs: {
+			description: 'Enforce passing a `message` value when creating a built-in error.',
 			url: getDocumentationUrl(__filename)
 		},
 		messages