Skip to content

Commit 1c06306

Browse files
ljharbljharb
committed
[readme] properly describe rule settings in builtin configs
Fixes #874
1 parent b78f19d commit 1c06306

File tree

3 files changed

+45
-37
lines changed

3 files changed

+45
-37
lines changed

‎README.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ configuration file by mapping each custom component name to a DOM element type.
153153
<!-- AUTO-GENERATED-CONTENT:START (TABLE) -->
154154
| Rule | Recommended | Strict |
155155
| :--- | :--- | :--- |
156-
| [accessible-emoji](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/HEAD/docs/rules/accessible-emoji.md) | error | error |
156+
| [accessible-emoji](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/HEAD/docs/rules/accessible-emoji.md) | off | off |
157157
| [alt-text](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/HEAD/docs/rules/alt-text.md) | error | error |
158158
| [anchor-has-content](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/HEAD/docs/rules/anchor-has-content.md) | error | error |
159159
| [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.
164164
| [aria-unsupported-elements](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/HEAD/docs/rules/aria-unsupported-elements.md) | error | error |
165165
| [autocomplete-valid](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/HEAD/docs/rules/autocomplete-valid.md) | error | error |
166166
| [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 |
167-
| [control-has-associated-label](undefined) | error | error |
167+
| [control-has-associated-label](undefined) | off | off |
168168
| [heading-has-content](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/HEAD/docs/rules/heading-has-content.md) | error | error |
169169
| [html-has-lang](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/HEAD/docs/rules/html-has-lang.md) | error | error |
170170
| [iframe-has-title](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/HEAD/docs/rules/iframe-has-title.md) | error | error |
171171
| [img-redundant-alt](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/HEAD/docs/rules/img-redundant-alt.md) | error | error |
172172
| [interactive-supports-focus](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/HEAD/docs/rules/interactive-supports-focus.md) | error | error |
173173
| [label-has-associated-control](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/blob/main/docs/rules/label-has-associated-control.md) | error | error |
174-
| [label-has-for](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/HEAD/docs/rules/label-has-for.md) | error | error |
175-
| [lang](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/HEAD/docs/rules/lang.md) | error | error |
174+
| [label-has-for](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/HEAD/docs/rules/label-has-for.md) | off | off |
175+
| [lang](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/HEAD/docs/rules/lang.md) | off | off |
176176
| [media-has-caption](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/HEAD/docs/rules/media-has-caption.md) | error | error |
177177
| [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 |
178178
| [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.
182182
| [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 |
183183
| [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 |
184184
| [no-noninteractive-tabindex](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/HEAD/docs/rules/no-noninteractive-tabindex.md) | error, with options | error |
185-
| [no-onchange](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/HEAD/docs/rules/no-onchange.md) | error | error |
185+
| [no-onchange](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/HEAD/docs/rules/no-onchange.md) | off | off |
186186
| [no-redundant-roles](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y/tree/HEAD/docs/rules/no-redundant-roles.md) | error | error |
187187
| [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 |
188188
| [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 |

‎markdown.config.js‎

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,27 @@
22

33
require('@babel/register');
44

5-
const { rules } = require('./src');
5+
const {
6+
configs: {
7+
recommended: { rules: recommended },
8+
strict: { rules: strict },
9+
},
10+
rules,
11+
} = require('./src');
612

713
const ruleTableRows = Object.keys(rules)
814
.sort()
915
.map((id) => {
1016
const { meta } = rules[id];
1117
const { url, errorOptions } = meta.docs;
18+
19+
const recSev = [].concat(recommended[`jsx-a11y/${id}`] || 'off')[0];
20+
const strictSev = [].concat(strict[`jsx-a11y/${id}`] || 'off')[0];
21+
1222
return [
1323
`[${id}](${url})`,
14-
errorOptions ? 'error, with options' : 'error',
15-
'error',
24+
recSev === 'error' ? (errorOptions ? 'error, with options' : 'error') : recSev, // eslint-disable-line no-nested-ternary
25+
strictSev,
1626
].join(' | ');
1727
});
1828

‎src/index.js‎

Lines changed: 27 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -60,35 +60,33 @@ module.exports = {
6060
'jsx-a11y/aria-unsupported-elements': 'error',
6161
'jsx-a11y/autocomplete-valid': 'error',
6262
'jsx-a11y/click-events-have-key-events': 'error',
63-
'jsx-a11y/control-has-associated-label': ['off',
64-
{
65-
ignoreElements: [
66-
'audio',
67-
'canvas',
68-
'embed',
69-
'input',
70-
'textarea',
71-
'tr',
72-
'video',
73-
],
74-
ignoreRoles: [
75-
'grid',
76-
'listbox',
77-
'menu',
78-
'menubar',
79-
'radiogroup',
80-
'row',
81-
'tablist',
82-
'toolbar',
83-
'tree',
84-
'treegrid',
85-
],
86-
includeRoles: [
87-
'alert',
88-
'dialog',
89-
],
90-
},
91-
],
63+
'jsx-a11y/control-has-associated-label': ['off', {
64+
ignoreElements: [
65+
'audio',
66+
'canvas',
67+
'embed',
68+
'input',
69+
'textarea',
70+
'tr',
71+
'video',
72+
],
73+
ignoreRoles: [
74+
'grid',
75+
'listbox',
76+
'menu',
77+
'menubar',
78+
'radiogroup',
79+
'row',
80+
'tablist',
81+
'toolbar',
82+
'tree',
83+
'treegrid',
84+
],
85+
includeRoles: [
86+
'alert',
87+
'dialog',
88+
],
89+
}],
9290
'jsx-a11y/heading-has-content': 'error',
9391
'jsx-a11y/html-has-lang': 'error',
9492
'jsx-a11y/iframe-has-title': 'error',

0 commit comments

Comments
 (0)