fix(docs/rules): add missing category tags to rules metadata #2569
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add category tags to the rules that were missing them. Add validation to check during a build for the inclusion of a category on the rule metadata. Closes issue #2554
|
|
mDalessandro
commented
Oct 20, 2020
| @@ -2,7 +2,7 @@ | |||
| "id": "accesskeys", | |||
| "selector": "[accesskey]", | |||
| "excludeHidden": false, | |||
| "tags": ["best-practice", "cat.keyboard"], | |||
| "tags": ["cat.keyboard", "best-practice"], | |||
There was a problem hiding this comment.
I swapped the positioning here to better match the order of the other rules' tags.
straker
reviewed
Oct 20, 2020
There was a problem hiding this comment.
Look great! Just want @WilcoFiers to verify the categories are correct as he knows them best.
| @@ -198,6 +198,10 @@ function createSchemas() { | |||
| type: 'array', | |||
| items: { | |||
| type: 'string' | |||
| }, | |||
| conform: function hasCategoryTag(tags) { return tags.some(tag => tag.includes('cat.')) }, | |||
There was a problem hiding this comment.
Nice. I like this check. Thanks for adding this.
straker
added
the
hacktoberfest
|
@mDalessandro so we merged a new rule and now this pr has a conflict. Sorry about that. Would you mind merging the latest develop to resolve the conflict? |
|
@straker no need. It's an easy fix. I've sorted it. |
WilcoFiers
approved these changes
Oct 21, 2020
|
Awesome, thanks for taking care of that. I haven't had a chance to sit down and do it, so that was helpful. I'll keep an eye out for any other issues I could work on. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add category tags to the rules that were missing them.
Add validation to check during a build for the inclusion of a category on the rule metadata.
Newly added categories for rules which were missing them:
aria-input-field-name:
cat.ariaaria-toggle-field-name:
cat.ariaaria-tooltip-name:
cat.ariaavoid-inline-spacing:
cat.structureidentical-links-same-purpose:
cat.semanticslabel-content-name-mismatch:
cat.semanticsno-autoplay-audio:
cat.time-and-mediascrollable-region-focusable:
cat.keyboardLet me know if you have a different thought on which categories should be used for these rules. Because there's no description of the categories themselves, it wasn't clear which one should be used; for example, both
cat.semanticsandcat.structureseemed to have some overlap. That could probably be a new gihub issue if anyone else feels similarly.Closes issue #2554
Reviewer checks
Required fields, to be filled out by PR reviewer(s)