[readme] properly describe rule settings in builtin configs

Fixes #874
jsx-eslint · Jul 13, 2022 · 1c06306 · 1c06306
1 parent b78f19d
commit 1c06306
Show file tree

Hide file tree

Showing 3 changed files with 45 additions and 37 deletions.
diff --git a/README.md b/README.md
@@ -153,7 +153,7 @@ configuration file by mapping each custom component name to a DOM element type.
 <!-- AUTO-GENERATED-CONTENT:START (TABLE) -->
 | Rule | Recommended | Strict |
 | :--- | :--- | :--- |
-| [accessible-emoji](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/HEAD/docs/rules/accessible-emoji.md) | error | error |
+| [accessible-emoji](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/HEAD/docs/rules/accessible-emoji.md) | off | off |
 | [alt-text](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/HEAD/docs/rules/alt-text.md) | error | error |
 | [anchor-has-content](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/HEAD/docs/rules/anchor-has-content.md) | error | error |
 | [anchor-is-valid](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/HEAD/docs/rules/anchor-is-valid.md) | error | error |
@@ -164,15 +164,15 @@ configuration file by mapping each custom component name to a DOM element type.
 | [aria-unsupported-elements](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/HEAD/docs/rules/aria-unsupported-elements.md) | error | error |
 | [autocomplete-valid](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/HEAD/docs/rules/autocomplete-valid.md) | error | error |
 | [click-events-have-key-events](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/HEAD/docs/rules/click-events-have-key-events.md) | error | error |
-| [control-has-associated-label](undefined) | error | error |
+| [control-has-associated-label](undefined) | off | off |
 | [heading-has-content](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/HEAD/docs/rules/heading-has-content.md) | error | error |
 | [html-has-lang](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/HEAD/docs/rules/html-has-lang.md) | error | error |
 | [iframe-has-title](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/HEAD/docs/rules/iframe-has-title.md) | error | error |
 | [img-redundant-alt](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/HEAD/docs/rules/img-redundant-alt.md) | error | error |
 | [interactive-supports-focus](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/HEAD/docs/rules/interactive-supports-focus.md) | error | error |
 | [label-has-associated-control](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/blob/main/docs/rules/label-has-associated-control.md) | error | error |
-| [label-has-for](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/HEAD/docs/rules/label-has-for.md) | error | error |
-| [lang](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/HEAD/docs/rules/lang.md) | error | error |
+| [label-has-for](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/HEAD/docs/rules/label-has-for.md) | off | off |
+| [lang](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/HEAD/docs/rules/lang.md) | off | off |
 | [media-has-caption](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/HEAD/docs/rules/media-has-caption.md) | error | error |
 | [mouse-events-have-key-events](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/HEAD/docs/rules/mouse-events-have-key-events.md) | error | error |
 | [no-access-key](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/HEAD/docs/rules/no-access-key.md) | error | error |
@@ -182,7 +182,7 @@ configuration file by mapping each custom component name to a DOM element type.
 | [no-noninteractive-element-interactions](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/HEAD/docs/rules/no-noninteractive-element-interactions.md) | error, with options | error |
 | [no-noninteractive-element-to-interactive-role](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/HEAD/docs/rules/no-noninteractive-element-to-interactive-role.md) | error, with options | error |
 | [no-noninteractive-tabindex](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/HEAD/docs/rules/no-noninteractive-tabindex.md) | error, with options | error |
-| [no-onchange](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/HEAD/docs/rules/no-onchange.md) | error | error |
+| [no-onchange](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/HEAD/docs/rules/no-onchange.md) | off | off |
 | [no-redundant-roles](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/HEAD/docs/rules/no-redundant-roles.md) | error | error |
 | [no-static-element-interactions](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/HEAD/docs/rules/no-static-element-interactions.md) | error, with options | error |
 | [role-has-required-aria-props](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/HEAD/docs/rules/role-has-required-aria-props.md) | error | error |

diff --git a/markdown.config.js b/markdown.config.js
@@ -2,17 +2,27 @@
 
 require('@babel/register');
 
-const { rules } = require('./src');
+const {
+  configs: {
+    recommended: { rules: recommended },
+    strict: { rules: strict },
+  },
+  rules,
+} = require('./src');
 
 const ruleTableRows = Object.keys(rules)
   .sort()
   .map((id) => {
     const { meta } = rules[id];
     const { url, errorOptions } = meta.docs;
+
+    const recSev = [].concat(recommended[`jsx-a11y/${id}`] || 'off')[0];
+    const strictSev = [].concat(strict[`jsx-a11y/${id}`] || 'off')[0];
+
     return [
       `[${id}](${url})`,
-      errorOptions ? 'error, with options' : 'error',
-      'error',
+      recSev === 'error' ? (errorOptions ? 'error, with options' : 'error') : recSev, // eslint-disable-line no-nested-ternary
+      strictSev,
     ].join(' | ');
   });
 

diff --git a/src/index.js b/src/index.js
@@ -60,35 +60,33 @@ module.exports = {
         'jsx-a11y/aria-unsupported-elements': 'error',
         'jsx-a11y/autocomplete-valid': 'error',
         'jsx-a11y/click-events-have-key-events': 'error',
-        'jsx-a11y/control-has-associated-label': ['off',
-          {
-            ignoreElements: [
-              'audio',
-              'canvas',
-              'embed',
-              'input',
-              'textarea',
-              'tr',
-              'video',
-            ],
-            ignoreRoles: [
-              'grid',
-              'listbox',
-              'menu',
-              'menubar',
-              'radiogroup',
-              'row',
-              'tablist',
-              'toolbar',
-              'tree',
-              'treegrid',
-            ],
-            includeRoles: [
-              'alert',
-              'dialog',
-            ],
-          },
-        ],
+        'jsx-a11y/control-has-associated-label': ['off', {
+          ignoreElements: [
+            'audio',
+            'canvas',
+            'embed',
+            'input',
+            'textarea',
+            'tr',
+            'video',
+          ],
+          ignoreRoles: [
+            'grid',
+            'listbox',
+            'menu',
+            'menubar',
+            'radiogroup',
+            'row',
+            'tablist',
+            'toolbar',
+            'tree',
+            'treegrid',
+          ],
+          includeRoles: [
+            'alert',
+            'dialog',
+          ],
+        }],
         'jsx-a11y/heading-has-content': 'error',
         'jsx-a11y/html-has-lang': 'error',
         'jsx-a11y/iframe-has-title': 'error',