Merge pull request #398 from bmish/eslint-doc-generator

Automate docs with eslint-doc-generator
github · Mar 16, 2023 · 0e7012a · 0e7012a
2 parents 428fd29 + 03d9cdc
commit 0e7012a
Show file tree

Hide file tree

Showing 25 changed files with 1,584 additions and 64 deletions.
diff --git a/.eslint-doc-generatorrc.js b/.eslint-doc-generatorrc.js
@@ -0,0 +1,9 @@
+/** @type {import('eslint-doc-generator').GenerateOptions} */
+module.exports = {
+  configEmoji: [
+    ['browser', '🔍'],
+    ['internal', '🔐'],
+    ['react', '⚛️']
+  ],
+  ruleDocSectionInclude: ['Rule Details', 'Version'],
+};
diff --git a/README.md b/README.md
@@ -3,7 +3,7 @@
 ## Installation
 
 ```sh
-$ npm install --save-dev eslint eslint-plugin-github
+npm install --save-dev eslint eslint-plugin-github
 ```
 
 ## Setup
@@ -72,25 +72,37 @@ This config will be interpreted in the following way:
 
 ### Rules
 
-- [Array Foreach](./docs/rules/array-foreach.md)
-- [Async Currenttarget](./docs/rules/async-currenttarget.md)
-- [Async Preventdefault](./docs/rules/async-preventdefault.md)
-- [Authenticity Token](./docs/rules/authenticity-token.md)
-- [Get Attribute](./docs/rules/get-attribute.md)
-- [JS Class Name](./docs/rules/js-class-name.md)
-- [No Blur](./docs/rules/no-blur.md)
-- [No D None](./docs/rules/no-d-none.md)
-- [No Dataset](./docs/rules/no-dataset.md)
-- [No Dynamic Script Tag](./docs/rules/no-dynamic-script-tag.md)
-- [No Implicit Buggy Globals](./docs/rules/no-implicit-buggy-globals.md)
-- [No Inner HTML](./docs/rules/no-inner-html.md)
-- [No InnerText](./docs/rules/no-innerText.md)
-- [No Then](./docs/rules/no-then.md)
-- [No Useless Passive](./docs/rules/no-useless-passive.md)
-- [Prefer Observers](./docs/rules/prefer-observers.md)
-- [Require Passive Events](./docs/rules/require-passive-events.md)
-- [Unescaped HTML Literal](./docs/rules/unescaped-html-literal.md)
-
-#### Accessibility-focused rules (prefixed with a11y)
-
-- [Role Supports ARIA Props](./docs/rules/role-supports-aria-props.md)
+<!-- begin auto-generated rules list -->
+
+💼 Configurations enabled in.\
+🔍 Set in the `browser` configuration.\
+🔐 Set in the `internal` configuration.\
+⚛️ Set in the `react` configuration.\
+✅ Set in the `recommended` configuration.\
+🔧 Automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/user-guide/command-line-interface#--fix).\
+❌ Deprecated.
+
+| Name                                                                 | Description                                                                                                              | 💼 | 🔧 | ❌  |
+| :------------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------- | :- | :- | :- |
+| [a11y-no-generic-link-text](docs/rules/a11y-no-generic-link-text.md) | disallow generic link text                                                                                               |    |    | ❌  |
+| [array-foreach](docs/rules/array-foreach.md)                         | enforce `for..of` loops over `Array.forEach`                                                                             | ✅  |    |    |
+| [async-currenttarget](docs/rules/async-currenttarget.md)             | disallow `event.currentTarget` calls inside of async functions                                                           | 🔍 |    |    |
+| [async-preventdefault](docs/rules/async-preventdefault.md)           | disallow `event.preventDefault` calls inside of async functions                                                          | 🔍 |    |    |
+| [authenticity-token](docs/rules/authenticity-token.md)               | disallow usage of CSRF tokens in JavaScript                                                                              | 🔐 |    |    |
+| [get-attribute](docs/rules/get-attribute.md)                         | disallow wrong usage of attribute names                                                                                  | 🔍 | 🔧 |    |
+| [js-class-name](docs/rules/js-class-name.md)                         | enforce a naming convention for js- prefixed classes                                                                     | 🔐 |    |    |
+| [no-blur](docs/rules/no-blur.md)                                     | disallow usage of `Element.prototype.blur()`                                                                             | 🔍 |    |    |
+| [no-d-none](docs/rules/no-d-none.md)                                 | disallow usage the `d-none` CSS class                                                                                    | 🔐 |    |    |
+| [no-dataset](docs/rules/no-dataset.md)                               | enforce usage of `Element.prototype.getAttribute` instead of `Element.prototype.datalist`                                | 🔍 |    |    |
+| [no-dynamic-script-tag](docs/rules/no-dynamic-script-tag.md)         | disallow creating dynamic script tags                                                                                    | ✅  |    |    |
+| [no-implicit-buggy-globals](docs/rules/no-implicit-buggy-globals.md) | disallow implicit global variables                                                                                       | ✅  |    |    |
+| [no-inner-html](docs/rules/no-inner-html.md)                         | disallow `Element.prototype.innerHTML` in favor of `Element.prototype.textContent`                                       | 🔍 |    |    |
+| [no-innerText](docs/rules/no-innerText.md)                           | disallow `Element.prototype.innerText` in favor of `Element.prototype.textContent`                                       | 🔍 | 🔧 |    |
+| [no-then](docs/rules/no-then.md)                                     | enforce using `async/await` syntax over Promises                                                                         | ✅  |    |    |
+| [no-useless-passive](docs/rules/no-useless-passive.md)               | disallow marking a event handler as passive when it has no effect                                                        | 🔍 | 🔧 |    |
+| [prefer-observers](docs/rules/prefer-observers.md)                   | disallow poorly performing event listeners                                                                               | 🔍 |    |    |
+| [require-passive-events](docs/rules/require-passive-events.md)       | enforce marking high frequency event handlers as passive                                                                 | 🔍 |    |    |
+| [role-supports-aria-props](docs/rules/role-supports-aria-props.md)   | Enforce that elements with explicit or implicit roles defined contain only `aria-*` properties supported by that `role`. | ⚛️ |    |    |
+| [unescaped-html-literal](docs/rules/unescaped-html-literal.md)       | disallow unescaped HTML literals                                                                                         | 🔍 |    |    |
+
+<!-- end auto-generated rules list -->
diff --git a/docs/rules/a11y-no-generic-link-text.md b/docs/rules/a11y-no-generic-link-text.md
@@ -1,6 +1,8 @@
-# No Generic Link Text [Deprecated]
+# Disallow generic link text (`github/a11y-no-generic-link-text`)
 
-_This rule has been deprecated in favor of `anchor-ambiguous-text` in `eslint-plugin-jsx-a11y`._
+❌ This rule is deprecated. It was replaced by `jsx-a11y/anchor-ambiguous-text`.
+
+<!-- end auto-generated rule header -->
 
 ## Rule Details
 

diff --git a/docs/rules/array-foreach.md b/docs/rules/array-foreach.md
@@ -1,4 +1,8 @@
-# Array Foreach
+# Enforce `for..of` loops over `Array.forEach` (`github/array-foreach`)
+
+💼 This rule is enabled in the ✅ `recommended` config.
+
+<!-- end auto-generated rule header -->
 
 Prefer `for...of` statement instead of `Array.forEach`.
 

diff --git a/docs/rules/async-currenttarget.md b/docs/rules/async-currenttarget.md
@@ -1,4 +1,8 @@
-# Async Currenttarget
+# Disallow `event.currentTarget` calls inside of async functions (`github/async-currenttarget`)
+
+💼 This rule is enabled in the 🔍 `browser` config.
+
+<!-- end auto-generated rule header -->
 
 ## Rule Details
 

diff --git a/docs/rules/async-preventdefault.md b/docs/rules/async-preventdefault.md
@@ -1,4 +1,8 @@
-# Async Preventdefault
+# Disallow `event.preventDefault` calls inside of async functions (`github/async-preventdefault`)
+
+💼 This rule is enabled in the 🔍 `browser` config.
+
+<!-- end auto-generated rule header -->
 
 Using `event.preventDefault()` inside an `async function()` won't likely work as you'd expect because synchronous nature of event dispatch.
 

diff --git a/docs/rules/authenticity-token.md b/docs/rules/authenticity-token.md
@@ -1,4 +1,8 @@
-# Authenticity Token
+# Disallow usage of CSRF tokens in JavaScript (`github/authenticity-token`)
+
+💼 This rule is enabled in the 🔐 `internal` config.
+
+<!-- end auto-generated rule header -->
 
 ## Rule Details
 

diff --git a/docs/rules/get-attribute.md b/docs/rules/get-attribute.md
@@ -1,4 +1,10 @@
-# Get Attribute
+# Disallow wrong usage of attribute names (`github/get-attribute`)
+
+💼 This rule is enabled in the 🔍 `browser` config.
+
+🔧 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 -->
 
 ## Rule Details
 

diff --git a/docs/rules/js-class-name.md b/docs/rules/js-class-name.md
@@ -1,4 +1,8 @@
-# JS Class Name
+# Enforce a naming convention for js- prefixed classes (`github/js-class-name`)
+
+💼 This rule is enabled in the 🔐 `internal` config.
+
+<!-- end auto-generated rule header -->
 
 JavaScript should only query and handle events for `js-` prefixed class names.
 

diff --git a/docs/rules/no-blur.md b/docs/rules/no-blur.md
@@ -1,4 +1,8 @@
-# No Blur
+# Disallow usage of `Element.prototype.blur()` (`github/no-blur`)
+
+💼 This rule is enabled in the 🔍 `browser` config.
+
+<!-- end auto-generated rule header -->
 
 Do not use `element.blur()`. Blurring an element causes the focus position to be reset causing accessibility issues when using keyboard or voice navigation. Instead, restore focus by calling `element.focus()` on a prior element.
 

diff --git a/docs/rules/no-d-none.md b/docs/rules/no-d-none.md
@@ -1,4 +1,8 @@
-# No D None
+# Disallow usage the `d-none` CSS class (`github/no-d-none`)
+
+💼 This rule is enabled in the 🔐 `internal` config.
+
+<!-- end auto-generated rule header -->
 
 ## Rule Details
 

diff --git a/docs/rules/no-dataset.md b/docs/rules/no-dataset.md
@@ -1,4 +1,8 @@
-# No Dataset
+# Enforce usage of `Element.prototype.getAttribute` instead of `Element.prototype.datalist` (`github/no-dataset`)
+
+💼 This rule is enabled in the 🔍 `browser` config.
+
+<!-- end auto-generated rule header -->
 
 ## Rule Details
 

diff --git a/docs/rules/no-dynamic-script-tag.md b/docs/rules/no-dynamic-script-tag.md
@@ -1,4 +1,8 @@
-# No Dynamic Script Tag
+# Disallow creating dynamic script tags (`github/no-dynamic-script-tag`)
+
+💼 This rule is enabled in the ✅ `recommended` config.
+
+<!-- end auto-generated rule header -->
 
 ## Rule Details
 

diff --git a/docs/rules/no-implicit-buggy-globals.md b/docs/rules/no-implicit-buggy-globals.md
@@ -1,4 +1,8 @@
-# No Implicit Buggy Globals
+# Disallow implicit global variables (`github/no-implicit-buggy-globals`)
+
+💼 This rule is enabled in the ✅ `recommended` config.
+
+<!-- end auto-generated rule header -->
 
 ## Rule Details
 

diff --git a/docs/rules/no-inner-html.md b/docs/rules/no-inner-html.md
@@ -1,4 +1,8 @@
-# No Inner HTML
+# Disallow `Element.prototype.innerHTML` in favor of `Element.prototype.textContent` (`github/no-inner-html`)
+
+💼 This rule is enabled in the 🔍 `browser` config.
+
+<!-- end auto-generated rule header -->
 
 ## Rule Details
 

diff --git a/docs/rules/no-innerText.md b/docs/rules/no-innerText.md
@@ -1,4 +1,10 @@
-# No InnerText
+# Disallow `Element.prototype.innerText` in favor of `Element.prototype.textContent` (`github/no-innerText`)
+
+💼 This rule is enabled in the 🔍 `browser` config.
+
+🔧 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 -->
 
 ## Rule Details
 

diff --git a/docs/rules/no-then.md b/docs/rules/no-then.md
@@ -1,4 +1,8 @@
-# No Then
+# Enforce using `async/await` syntax over Promises (`github/no-then`)
+
+💼 This rule is enabled in the ✅ `recommended` config.
+
+<!-- end auto-generated rule header -->
 
 ## Rule Details
 

diff --git a/docs/rules/no-useless-passive.md b/docs/rules/no-useless-passive.md
@@ -1,4 +1,10 @@
-# No Useless Passive
+# Disallow marking a event handler as passive when it has no effect (`github/no-useless-passive`)
+
+💼 This rule is enabled in the 🔍 `browser` config.
+
+🔧 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 -->
 
 This rule disallows setting `passive: true` for events on which it will have no effect.
 

diff --git a/docs/rules/prefer-observers.md b/docs/rules/prefer-observers.md
@@ -1,4 +1,8 @@
-# Prefer Observers
+# Disallow poorly performing event listeners (`github/prefer-observers`)
+
+💼 This rule is enabled in the 🔍 `browser` config.
+
+<!-- end auto-generated rule header -->
 
 Some events, such as `scroll` and `resize` have traditionally caused performance issues on web pages, as they are high frequency events, firing many times per second as the user interacts with the page viewport.
 

diff --git a/docs/rules/require-passive-events.md b/docs/rules/require-passive-events.md
@@ -1,4 +1,8 @@
-# Require Passive Events
+# Enforce marking high frequency event handlers as passive (`github/require-passive-events`)
+
+💼 This rule is enabled in the 🔍 `browser` config.
+
+<!-- end auto-generated rule header -->
 
 This rule enforces adding `passive: true` to high frequency event listeners (`touchstart`, `touchmove`, `touchenter`, `touchend`, `touchleave`, `wheel`, `mousewheel`).
 

diff --git a/docs/rules/role-supports-aria-props.md b/docs/rules/role-supports-aria-props.md
@@ -1,4 +1,8 @@
-# Role Supports ARIA Props
+# Enforce that elements with explicit or implicit roles defined contain only `aria-*` properties supported by that `role` (`github/role-supports-aria-props`)
+
+💼 This rule is enabled in the ⚛️ `react` config.
+
+<!-- end auto-generated rule header -->
 
 ## Rule Details
 
@@ -72,3 +76,5 @@ There are conflicting resources and opinions on what elements should support the
   <h1 id="dialogHeading">Heading</h1>
 </div>
 ```
+
+## Version
diff --git a/docs/rules/unescaped-html-literal.md b/docs/rules/unescaped-html-literal.md
@@ -1,4 +1,8 @@
-# Unescaped HTML Literal
+# Disallow unescaped HTML literals (`github/unescaped-html-literal`)
+
+💼 This rule is enabled in the 🔍 `browser` config.
+
+<!-- end auto-generated rule header -->
 
 ## Rule Details
 

diff --git a/lib/rules/a11y-no-generic-link-text.js b/lib/rules/a11y-no-generic-link-text.js
@@ -18,6 +18,8 @@ module.exports = {
       description: 'disallow generic link text',
       url: require('../url')(module),
     },
+    deprecated: true,
+    replacedBy: ['jsx-a11y/anchor-ambiguous-text'],
     schema: [],
   },