Automate docs with eslint-doc-generator (#493)

* docs: automate docs with eslint-doc-generator

* docs: update to eslint-doc-generator 0.28

* docs: update to eslint-doc-generator 1.0

* docs: update to eslint-doc-generator 1.2 with new ruleListSplit function

* use config-format option

* urlRuleDoc function

* tweak config

* fix relative rule paths

* remove deprecated column

Co-authored-by: Yosuke Ota <[email protected]>

Author: bmish

.eslint-doc-generatorrc.js

@@ -0,0 +1,54 @@
+/** @type {import('eslint-doc-generator').GenerateOptions} */
+const config = {
+  configFormat: 'plugin-colon-prefix-name',
+  ignoreConfig: ['all'],
+  pathRuleList: ['README.md', 'docs/rules/index.md'],
+  ruleDocSectionInclude: ['Rule Details', 'Version', 'Implementation'],
+  ruleDocSectionOptions: false,
+  ruleDocTitleFormat: 'prefix-name',
+  ruleListColumns: [
+    // All standard columns except `deprecated` since we split the list such that there's a dedicated "Deprecated" section.
+    'name',
+    'description',
+    'configsError',
+    'configsWarn',
+    'configsOff',
+    'fixable',
+    'hasSuggestions',
+    'requiresTypeChecking',
+  ],
+  ruleListSplit(rules) {
+    return [
+      {
+        title: 'Possible Errors',
+        rules: rules.filter(
+          ([, rule]) => rule.meta.docs.category === 'Possible Errors' && !rule.meta.deprecated
+        ),
+      },
+      {
+        title: 'Best Practices',
+        rules: rules.filter(
+          ([, rule]) => rule.meta.docs.category === 'Best Practices' && !rule.meta.deprecated
+        ),
+      },
+      {
+        title: 'Stylistic Issues',
+        rules: rules.filter(
+          ([, rule]) => rule.meta.docs.category === 'Stylistic Issues' && !rule.meta.deprecated
+        ),
+      },
+      {
+        title: 'Deprecated',
+        rules: rules.filter(([, rule]) => rule.meta.deprecated),
+      },
+    ];
+  },
+  urlRuleDoc(name, page) {
+    if (page === 'README.md') {
+      // Use URLs only in the README to link to the vitepress SPA. Otherwise, fallback to relative URLs.
+      return `https://ota-meshi.github.io/eslint-plugin-regexp/rules/${name}.html`;
+    }
+  },
+};
+
+module.exports = config;

README.md

@@ -7,9 +7,11 @@ since: "v0.8.0"
 ---
 # regexp/confusing-quantifier
 
-> disallow confusing quantifiers
+⚠️ This rule _warns_ in the ✅ `plugin:regexp/recommended` config.
+
+<!-- end auto-generated rule header -->
 
-- :gear: This rule is included in `"plugin:regexp/recommended"`.
+> disallow confusing quantifiers
 
 ## :book: Rule Details
 

docs/rules/confusing-quantifier.md

@@ -7,10 +7,13 @@ since: "v0.9.0"
 ---
 # regexp/control-character-escape
 
-> enforce consistent escaping of control characters
+💼 This rule is enabled in the ✅ `plugin:regexp/recommended` config.
+
+🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
 
-- :gear: This rule is included in `"plugin:regexp/recommended"`.
-- :wrench: The `--fix` option on the [command line](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems) can automatically fix some of the problems reported by this rule.
+<!-- end auto-generated rule header -->
+
+> enforce consistent escaping of control characters
 
 ## :book: Rule Details
 

docs/rules/control-character-escape.md

@@ -7,9 +7,11 @@ since: "v0.9.0"
 ---
 # regexp/hexadecimal-escape
 
-> enforce consistent usage of hexadecimal escape
+🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
+
+<!-- end auto-generated rule header -->
 
-- :wrench: The `--fix` option on the [command line](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems) can automatically fix some of the problems reported by this rule.
+> enforce consistent usage of hexadecimal escape
 
 ## :book: Rule Details
 

docs/rules/hexadecimal-escape.md

@@ -7,9 +7,11 @@ since: "v0.3.0"
 ---
 # regexp/letter-case
 
-> enforce into your favorite case
+🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
+
+<!-- end auto-generated rule header -->
 
-- :wrench: The `--fix` option on the [command line](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems) can automatically fix some of the problems reported by this rule.
+> enforce into your favorite case
 
 ## :book: Rule Details
 

docs/rules/index.md

@@ -7,10 +7,13 @@ since: "v0.1.0"
 ---
 # regexp/match-any
 
-> enforce match any character style
+💼 This rule is enabled in the ✅ `plugin:regexp/recommended` config.
+
+🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
 
-- :gear: This rule is included in `"plugin:regexp/recommended"`.
-- :wrench: The `--fix` option on the [command line](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems) can automatically fix some of the problems reported by this rule.
+<!-- end auto-generated rule header -->
+
+> enforce match any character style
 
 ## :book: Rule Details
 

docs/rules/letter-case.md

@@ -7,10 +7,13 @@ since: "v0.4.0"
 ---
 # regexp/negation
 
-> enforce use of escapes on negation
+💼 This rule is enabled in the ✅ `plugin:regexp/recommended` config.
+
+🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
 
-- :gear: This rule is included in `"plugin:regexp/recommended"`.
-- :wrench: The `--fix` option on the [command line](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems) can automatically fix some of the problems reported by this rule.
+<!-- end auto-generated rule header -->
+
+> enforce use of escapes on negation
 
 ## :book: Rule Details
 

docs/rules/match-any.md

@@ -7,9 +7,11 @@ since: "v0.1.0"
 ---
 # regexp/no-assertion-capturing-group
 
-> disallow capturing group that captures empty.
+❌ This rule is deprecated. It was replaced by [`regexp/no-empty-capturing-group`](no-empty-capturing-group.md).
+
+<!-- end auto-generated rule header -->
 
-- :warning: This rule was **deprecated** and replaced by [regexp/no-empty-capturing-group](no-empty-capturing-group.md) rule.
+> disallow capturing group that captures empty.
 
 ## :book: Rule Details