docs: automater docs with eslint-doc-generator

Author: bmish

README.md

@@ -44,10 +44,18 @@ Then configure the rules you want to use under the rules section.
 
 ## Rules
 
-- [`no-const-outside-module-scope`](./docs/rules/no-const-outside-module-scope.md)
-- [`no-empty-yuidoc-code-blocks`](./docs/rules/no-empty-yuidoc-code-blocks.md)
-- [`require-yuidoc-access`](./docs/rules/require-yuidoc-access.md)
-- [`require-yuidoc-code-block-type`](./docs/rules/require-yuidoc-code-block-type.md)
+<!-- begin auto-generated rules list -->
+
+🔧 Automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/user-guide/command-line-interface#--fix).
+
+| Name                                                                           | Description                                                                          | 🔧 |
+| :----------------------------------------------------------------------------- | :----------------------------------------------------------------------------------- | :- |
+| [no-const-outside-module-scope](docs/rules/no-const-outside-module-scope.md)   | disallow `const` from being used outside of the module scope (e.g. in functions)     | 🔧 |
+| [no-empty-yuidoc-code-blocks](docs/rules/no-empty-yuidoc-code-blocks.md)       | disallow empty code blocks in YUIDoc comments                                        |    |
+| [require-yuidoc-access](docs/rules/require-yuidoc-access.md)                   | require that every YUIDoc comment has `@public`, `@protected` or `@private` declared |    |
+| [require-yuidoc-code-block-type](docs/rules/require-yuidoc-code-block-type.md) | require that every code blocks in YUIDoc comments has a type associated              |    |
+
+<!-- end auto-generated rules list -->
 
 ## Related
 

docs/rules/no-const-outside-module-scope.md

@@ -1,3 +1,5 @@
-# no-const-outside-module-scope
+# Disallow `const` from being used outside of the module scope (e.g. in functions) (`ember-internal/no-const-outside-module-scope`)
 
-Prevent `const` from being used outside of the module scope (e.g. in functions).
+🔧 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 -->

docs/rules/no-empty-yuidoc-code-blocks.md

@@ -1,6 +1,8 @@
-# no-empty-yuidoc-code-blocks
+# Disallow empty code blocks in YUIDoc comments (`ember-internal/no-empty-yuidoc-code-blocks`)
 
-Prevents empty code blocks in YUIDoc comments, e.g.
+<!-- end auto-generated rule header -->
+
+## Examples
 
 ```js
 /**

docs/rules/require-yuidoc-access.md

@@ -1,3 +1,3 @@
-# require-yuidoc-access
+# Require that every YUIDoc comment has `@public`, `@protected` or `@private` declared (`ember-internal/require-yuidoc-access`)
 
-Ensures that every YUIDoc comment has `@public`, `@protected` or `@private` declared.
+<!-- end auto-generated rule header -->

docs/rules/require-yuidoc-code-block-type.md

@@ -1,6 +1,8 @@
-# require-yuidoc-code-block-type
+# Require that every code blocks in YUIDoc comments has a type associated (`ember-internal/require-yuidoc-code-block-type`)
 
-Ensures that every code blocks in YUIDoc comments has a type associated.
+<!-- end auto-generated rule header -->
+
+## Examples
 
 ```js
 /**

package.json

@@ -14,9 +14,11 @@
     "lint": "npm-run-all \"lint:*\"",
     "lint:docs": "markdownlint \"**/*.md\"",
     "lint:docs:fix": "yarn lint:docs --fix",
+    "lint:eslint-docs": "yarn update:eslint-docs --check",
     "lint:js": "eslint .",
     "lint:js:fix": "yarn lint:js --fix",
-    "test": "mocha tests --recursive"
+    "test": "mocha tests --recursive",
+    "update:eslint-docs": "eslint-doc-generator"
   },
   "dependencies": {
     "line-column": "^1.0.2",
@@ -25,6 +27,7 @@
   "devDependencies": {
     "eslint": "^8.0.0",
     "eslint-config-prettier": "^8.0.0",
+    "eslint-doc-generator": "^1.0.2",
     "eslint-plugin-eslint-plugin": "^5.0.0",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-prettier": "^4.0.0",