Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore(text): update text content #4499

Merged
merged 6 commits into from
Jun 17, 2024
Merged

chore(text): update text content #4499

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
e5329c2
chore(text): update text content
marktnoonan Jun 11, 2024
15a6c45
revert changes to generated file
marktnoonan Jun 11, 2024
e58a6a0
move text changes to source files
marktnoonan Jun 11, 2024
bda741b
sync changes to rule-descriptions.md
marktnoonan Jun 11, 2024
2e025e5
update generated file
marktnoonan Jun 12, 2024
c98fc7c
Merge branch 'develop' into text-updates
marktnoonan Jun 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions doc/rule-descriptions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,9 +86,9 @@

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@WilcoFiers This file is also generated - should I remove these changes from the PR also?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, we try to keep this in sync with the .json files in the repo. We actually need the _template.json file updated too. Would you mind running npm run build to update that file as well?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah understood - we want the generated files updated and committed, but they are not edited directly, and so they stay current with the values used elsewhere in code. Updated the PR with the generated _template file.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@WilcoFiers I believe everything is committed and good to go at this point.

These rules are disabled by default, until WCAG 2.2 is more widely adopted and required.

| Rule ID | Description | Impact | Tags | Issue Type | ACT Rules |
| :----------------------------------------------------------------------------------------------- | :------------------------------------------------- | :------ | :--------------------------------------------- | :------------------------- | :-------- |
| [target-size](https://dequeuniversity.com/rules/axe/4.9/target-size?application=RuleDescription) | Ensure touch target have sufficient size and space | Serious | cat.sensory-and-visual-cues, wcag22aa, wcag258 | failure, needs review | |
| Rule ID | Description | Impact | Tags | Issue Type | ACT Rules |
| :----------------------------------------------------------------------------------------------- | :-------------------------------------------------- | :------ | :--------------------------------------------- | :------------------------- | :-------- |
| [target-size](https://dequeuniversity.com/rules/axe/4.9/target-size?application=RuleDescription) | Ensure touch targets have sufficient size and space | Serious | cat.sensory-and-visual-cues, wcag22aa, wcag258 | failure, needs review | |

## Best Practices Rules

Expand Down
4 changes: 2 additions & 2 deletions lib/checks/forms/autocomplete-appropriate.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
"metadata": {
"impact": "serious",
"messages": {
"pass": "the autocomplete value is on an appropriate element",
"fail": "the autocomplete value is inappropriate for this type of input"
"pass": "The autocomplete value is on an appropriate element",
"fail": "The autocomplete value is inappropriate for this type of input"
}
}
}
4 changes: 2 additions & 2 deletions lib/checks/forms/autocomplete-valid.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
"metadata": {
"impact": "serious",
"messages": {
"pass": "the autocomplete attribute is correctly formatted",
"fail": "the autocomplete attribute is incorrectly formatted"
"pass": "The autocomplete attribute is correctly formatted",
"fail": "The autocomplete attribute is incorrectly formatted"
}
},
"options": {
Expand Down
2 changes: 1 addition & 1 deletion lib/rules/table-duplicate-name.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"tags": ["cat.tables", "best-practice"],
"metadata": {
"description": "Ensure the <caption> element does not contain the same text as the summary attribute",
"help": "tables should not have the same summary and caption"
"help": "Tables should not have the same summary and caption"
},
"all": [],
"any": [],
Expand Down
2 changes: 1 addition & 1 deletion lib/rules/target-size.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"matches": "widget-not-inline-matches",
"tags": ["cat.sensory-and-visual-cues", "wcag22aa", "wcag258"],
"metadata": {
"description": "Ensure touch target have sufficient size and space",
"description": "Ensure touch targets have sufficient size and space",
"help": "All touch targets must be 24px large, or leave sufficient space"
},
"all": [],
Expand Down
30 changes: 15 additions & 15 deletions locales/_template.json
View file
Open in desktop
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@marktnoonan This is a generated file. You'll need to make these changes in in the different JSON files in lib/checks/*/{check-id}.json. This won't be used in axe-core, and it's going to get overwritten when this file is regenerated.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh that makes so much sense, yes I'll move changes to the proper place, thanks!

Original file line number Diff line number Diff line change
Expand Up @@ -282,8 +282,8 @@
"help": "Document should have one main landmark"
},
"landmark-unique": {
"help": "Ensures landmarks are unique",
"description": "Landmarks should have a unique role or role/label/title (i.e. accessible name) combination"
"description": "Ensures landmarks are unique",
"help": "Landmarks should have a unique role or role/label/title (i.e. accessible name) combination"
},
"link-in-text-block": {
"description": "Ensure links are distinguished from surrounding text in a way that does not rely on color",
Expand Down Expand Up @@ -383,14 +383,14 @@
},
"table-duplicate-name": {
"description": "Ensure the <caption> element does not contain the same text as the summary attribute",
"help": "tables should not have the same summary and caption"
"help": "Tables should not have the same summary and caption"
},
"table-fake-caption": {
"description": "Ensure that tables with a caption use the <caption> element.",
"help": "Data or header cells must not be used to give caption to a data table."
},
"target-size": {
"description": "Ensure touch target have sufficient size and space",
"description": "Ensure touch targets have sufficient size and space",
"help": "All touch targets must be 24px large, or leave sufficient space"
},
"td-has-header": {
Expand Down Expand Up @@ -461,9 +461,9 @@
"hidden": "aria-errormessage value `${data.values}` cannot reference a hidden element"
},
"incomplete": {
"singular": "ensure aria-errormessage value `${data.values}` references an existing element",
"plural": "ensure aria-errormessage values `${data.values}` reference existing elements",
"idrefs": "unable to determine if aria-errormessage element exists on the page: ${data.values}"
"singular": "Ensure aria-errormessage value `${data.values}` references an existing element",
"plural": "Ensure aria-errormessage values `${data.values}` reference existing elements",
"idrefs": "Unable to determine if aria-errormessage element exists on the page: ${data.values}"
}
},
"aria-hidden-body": {
Expand Down Expand Up @@ -678,12 +678,12 @@
}
},
"autocomplete-appropriate": {
"pass": "the autocomplete value is on an appropriate element",
"fail": "the autocomplete value is inappropriate for this type of input"
"pass": "The autocomplete value is on an appropriate element",
"fail": "The autocomplete value is inappropriate for this type of input"
},
"autocomplete-valid": {
"pass": "the autocomplete attribute is correctly formatted",
"fail": "the autocomplete attribute is incorrectly formatted"
"pass": "The autocomplete attribute is correctly formatted",
"fail": "The autocomplete attribute is incorrectly formatted"
},
"accesskeys": {
"pass": "Accesskey attribute value is unique",
Expand Down Expand Up @@ -961,7 +961,7 @@
"aria-labelledby": {
"pass": "aria-labelledby attribute exists and references elements that are visible to screen readers",
"fail": "aria-labelledby attribute does not exist, references elements that do not exist or references elements that are empty",
"incomplete": "ensure aria-labelledby references an existing element"
"incomplete": "Ensure aria-labelledby references an existing element"
},
"avoid-inline-spacing": {
"pass": "No inline styles with '!important' that affect text spacing has been specified",
Expand Down Expand Up @@ -1044,7 +1044,7 @@
}
},
"presentational-role": {
"pass": "Element's default semantics were overriden with role=\"${data.role}\"",
"pass": "Element's default semantics were overridden with role=\"${data.role}\"",
"fail": {
"default": "Element's default semantics were not overridden with role=\"none\" or role=\"presentation\"",
"globalAria": "Element's role is not presentational because it has a global ARIA attribute",
Expand All @@ -1054,11 +1054,11 @@
}
},
"role-none": {
"pass": "Element's default semantics were overriden with role=\"none\"",
"pass": "Element's default semantics were overridden with role=\"none\"",
"fail": "Element's default semantics were not overridden with role=\"none\""
},
"role-presentation": {
"pass": "Element's default semantics were overriden with role=\"presentation\"",
"pass": "Element's default semantics were overridden with role=\"presentation\"",
"fail": "Element's default semantics were not overridden with role=\"presentation\""
},
"svg-non-empty-title": {
Expand Down