feat(aria-roledescription): deprecate rule (#3948)

dequelabs · Mar 22, 2023 · 1913a9e · 1913a9e
1 parent 893fdd0
commit 1913a9e
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 3 deletions.
diff --git a/doc/rule-descriptions.md b/doc/rule-descriptions.md
@@ -25,7 +25,6 @@
 | [aria-required-attr](https://dequeuniversity.com/rules/axe/4.6/aria-required-attr?application=RuleDescription)                   | Ensures elements with ARIA roles have all required ARIA attributes                                                                                    | Critical                 | cat.aria, wcag2a, wcag412                                                         | failure                    | [4e8ab6](https://act-rules.github.io/rules/4e8ab6)                                                                                                                                                                                                                 |
 | [aria-required-children](https://dequeuniversity.com/rules/axe/4.6/aria-required-children?application=RuleDescription)           | Ensures elements with an ARIA role that require child roles contain them                                                                              | Critical                 | cat.aria, wcag2a, wcag131                                                         | failure, needs&nbsp;review | [bc4a75](https://act-rules.github.io/rules/bc4a75), [ff89c9](https://act-rules.github.io/rules/ff89c9)                                                                                                                                                             |
 | [aria-required-parent](https://dequeuniversity.com/rules/axe/4.6/aria-required-parent?application=RuleDescription)               | Ensures elements with an ARIA role that require parent roles are contained by them                                                                    | Critical                 | cat.aria, wcag2a, wcag131                                                         | failure                    | [ff89c9](https://act-rules.github.io/rules/ff89c9)                                                                                                                                                                                                                 |
-| [aria-roledescription](https://dequeuniversity.com/rules/axe/4.6/aria-roledescription?application=RuleDescription)               | Ensure aria-roledescription is only used on elements with an implicit or explicit role                                                                | Serious                  | cat.aria, wcag2a, wcag412                                                         | failure, needs&nbsp;review |                                                                                                                                                                                                                                                                    |
 | [aria-roles](https://dequeuniversity.com/rules/axe/4.6/aria-roles?application=RuleDescription)                                   | Ensures all elements with a role attribute use a valid value                                                                                          | Minor, Serious, Critical | cat.aria, wcag2a, wcag412                                                         | failure                    | [674b10](https://act-rules.github.io/rules/674b10)                                                                                                                                                                                                                 |
 | [aria-toggle-field-name](https://dequeuniversity.com/rules/axe/4.6/aria-toggle-field-name?application=RuleDescription)           | Ensures every ARIA toggle field has an accessible name                                                                                                | Moderate, Serious        | cat.aria, wcag2a, wcag412, ACT                                                    | failure, needs&nbsp;review | [e086e5](https://act-rules.github.io/rules/e086e5)                                                                                                                                                                                                                 |
 | [aria-tooltip-name](https://dequeuniversity.com/rules/axe/4.6/aria-tooltip-name?application=RuleDescription)                     | Ensures every ARIA tooltip node has an accessible name                                                                                                | Serious                  | cat.aria, wcag2a, wcag412                                                         | failure, needs&nbsp;review |                                                                                                                                                                                                                                                                    |
@@ -151,4 +150,6 @@ Rules we are still testing and developing. They are disabled by default in axe-c
 
 Deprecated rules are disabled by default and will be removed in the next major release.
 
-_There are no matching rules_
+| Rule ID                                                                                                            | Description                                                                            | Impact  | Tags                                  | Issue Type                 | ACT Rules |
+| :----------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------- | :------ | :------------------------------------ | :------------------------- | :-------- |
+| [aria-roledescription](https://dequeuniversity.com/rules/axe/4.6/aria-roledescription?application=RuleDescription) | Ensure aria-roledescription is only used on elements with an implicit or explicit role | Serious | cat.aria, wcag2a, wcag412, deprecated | failure, needs&nbsp;review |           |
diff --git a/lib/rules/aria-roledescription.json b/lib/rules/aria-roledescription.json
@@ -1,7 +1,8 @@
 {
   "id": "aria-roledescription",
   "selector": "[aria-roledescription]",
-  "tags": ["cat.aria", "wcag2a", "wcag412"],
+  "tags": ["cat.aria", "wcag2a", "wcag412", "deprecated"],
+  "enabled": false,
   "metadata": {
     "description": "Ensure aria-roledescription is only used on elements with an implicit or explicit role",
     "help": "aria-roledescription must be on elements with a semantic role"