[Docs] Add infrastructure for auto-generating markdown table and list

- Add readme.yml file to ensure table and list markdown content is
auto-generated from rules folder
- Add md-magic dependency and scripts to package.json for updating
readme markdown
- Add markdown.config.js file to add transformation functions to the
transforms object
- Add scripts to README markdown to keep documentation content in sync
with readme
- Disable `no-console` rule in markdown.config file in .eslintrc
- Add errorOptions property to source files for rules with extra options

Closes jsx-eslint#836

Author: uncommon-type

.eslintrc

@@ -33,5 +33,11 @@
         "jest": true,
       },
     },
-  ],
+    {
+        "files": "markdown.config.js",
+        "rules": {
+          "no-console": 0,
+        },
+    },
+  ] 
 }

.github/workflows/readme.yml

@@ -0,0 +1,15 @@
+name: 'Tests: readme'
+
+on: [pull_request, push]
+
+jobs:
+  readme:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ljharb/actions/node/install@main
+        name: 'nvm install lts/* && npm install'
+        with:
+          node-version: 'lts/*'
+      - run: npm run generate-list-of-rules:check

README.md

@@ -0,0 +1,43 @@
+const { rules } = require('./lib');
+
+const ruleTableRows = Object.keys(rules)
+  .sort()
+  .map((id) => {
+    const { meta } = rules[id];
+    const { errorOptions } = meta;
+    return [
+      `[${id}](docs/rules/${id}.md)`,
+      errorOptions ? 'error, with options' : 'error',
+      'error',
+    ].join(' | ');
+  });
+
+const buildRulesTable = (rows) => {
+  const header = 'Rule | Recommended | Strict';
+  const separator = ':--- | :--- | :---';
+
+  return [header, separator, ...rows]
+    .map((row) => `| ${row} |`)
+    .join('\n');
+};
+
+const ruleList = Object.keys(rules)
+  .sort()
+  .map((id) => [
+    `- [${id}](docs/rules/${id}.md)`,
+  ].join(''));
+
+const buildRuleList = (listItems) => listItems.map((listItem) => `${listItem}`).join('\n');
+
+const LIST = () => buildRuleList(ruleList);
+const TABLE = () => buildRulesTable(ruleTableRows);
+
+module.exports = {
+  transforms: {
+    TABLE,
+    LIST,
+  },
+  callback: () => {
+    console.log('The auto-generating of rules finished!');
+  },
+};

markdown.config.js

@@ -28,7 +28,9 @@
     "test": "npm run jest",
     "posttest": "aud --production",
     "test:ci": "npm run jest -- --ci --runInBand",
-    "jest": "jest --coverage __tests__/**/*"
+    "jest": "jest --coverage __tests__/**/*",
+    "generate-list-of-rules": "md-magic --path '**/*.md' --ignore 'node_modules'",
+    "generate-list-of-rules:check": "npm run generate-list-of-rules && git diff --exit-code README.md"
   },
   "devDependencies": {
     "@babel/cli": "^7.17.0",
@@ -51,6 +53,7 @@
     "in-publish": "^2.0.1",
     "jest": "^24.9.0",
     "jscodeshift": "^0.7.1",
+    "markdown-magic": "^2.6.0",
     "minimist": "^1.2.5",
     "object.assign": "^4.1.2",
     "rimraf": "^3.0.2",

package.json

@@ -44,6 +44,7 @@ export default ({
         uniqueItems: true,
       },
     }],
+    errorOptions: true,
   },
 
   create: (context: ESLintContext): ESLintVisitorSelectorConfig => {

src/rules/no-interactive-element-to-noninteractive-role.js

@@ -48,6 +48,7 @@ export default ({
       url: 'https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/HEAD/docs/rules/no-noninteractive-element-interactions.md',
     },
     schema: [schema],
+    errorOptions: true,
   },
 
   create: (context: ESLintContext): ESLintVisitorSelectorConfig => {

src/rules/no-noninteractive-element-interactions.js

@@ -42,6 +42,7 @@ export default ({
         uniqueItems: true,
       },
     }],
+    errorOptions: true,
   },
 
   create: (context: ESLintContext): ESLintVisitorSelectorConfig => {

src/rules/no-noninteractive-element-to-interactive-role.js

@@ -42,6 +42,7 @@ export default ({
       url: 'https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/HEAD/docs/rules/no-noninteractive-tabindex.md',
     },
     schema: [schema],
+    errorOptions: true,
   },
 
   create: (context: ESLintContext): ESLintVisitorSelectorConfig => {

src/rules/no-noninteractive-tabindex.js

@@ -47,6 +47,7 @@ export default ({
       url: 'https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/HEAD/docs/rules/no-static-element-interactions.md',
     },
     schema: [schema],
+    errorOptions: true,
   },
 
   create: (context: ESLintContext): ESLintVisitorSelectorConfig => {

src/rules/no-static-element-interactions.js

@@ -21,6 +21,7 @@ export default {
       url: 'https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/HEAD/docs/rules/scope.md',
     },
     schema: [schema],
+    errorOptions: true,
   },
 
   create: (context) => ({