From 783c59ada18686af65995af8e04fd48944f048de Mon Sep 17 00:00:00 2001 From: Anthony Le Goas Date: Sun, 25 Apr 2021 12:46:01 +0200 Subject: [PATCH] add a11y check on abstract roles --- src/compiler/compile/nodes/Element.ts | 13 +- .../a11y-no-abstract-roles/input.svelte | 12 ++ .../a11y-no-abstract-roles/warnings.json | 182 ++++++++++++++++++ 3 files changed, 205 insertions(+), 2 deletions(-) create mode 100644 test/validator/samples/a11y-no-abstract-roles/input.svelte create mode 100644 test/validator/samples/a11y-no-abstract-roles/warnings.json diff --git a/src/compiler/compile/nodes/Element.ts b/src/compiler/compile/nodes/Element.ts index dbde8f1b2df8..893f3b979c7d 100644 --- a/src/compiler/compile/nodes/Element.ts +++ b/src/compiler/compile/nodes/Element.ts @@ -28,6 +28,9 @@ const aria_attribute_set = new Set(aria_attributes); const aria_roles = 'alert alertdialog application article banner blockquote button caption cell checkbox code columnheader combobox complementary contentinfo definition deletion dialog directory document emphasis feed figure form generic graphics-document graphics-object graphics-symbol grid gridcell group heading img link list listbox listitem log main marquee math meter menu menubar menuitem menuitemcheckbox menuitemradio navigation none note option paragraph presentation progressbar radio radiogroup region row rowgroup rowheader scrollbar search searchbox separator slider spinbutton status strong subscript superscript switch tab table tablist tabpanel term textbox time timer toolbar tooltip tree treegrid treeitem'.split(' '); const aria_role_set = new Set(aria_roles); +const aria_roles_abstract = 'command composite input landmark range roletype section sectionhead select structure widget window'.split(' '); +const aria_roles_abstract_set = new Set(aria_roles_abstract); + const a11y_required_attributes = { a: ['href'], area: ['alt', 'aria-label', 'aria-labelledby'], @@ -341,8 +344,14 @@ export default class Element extends Node { } const value = attribute.get_static_value(); - // @ts-ignore - if (value && !aria_role_set.has(value)) { + + if (value && aria_roles_abstract_set.has(value as string)) { + const message = `A11y: abstract role '${value}' is forbidden`; + component.warn(attribute, { + code: 'a11y-no-abstract-role', + message + }); + } else if (value && !aria_role_set.has(value as string)) { // @ts-ignore const match = fuzzymatch(value, aria_roles); component.warn(attribute, compiler_warnings.a11y_unknown_role(value, match)); diff --git a/test/validator/samples/a11y-no-abstract-roles/input.svelte b/test/validator/samples/a11y-no-abstract-roles/input.svelte new file mode 100644 index 000000000000..dbe6bd858119 --- /dev/null +++ b/test/validator/samples/a11y-no-abstract-roles/input.svelte @@ -0,0 +1,12 @@ +
+
+
+
+
+
+
+
+
+
+
+
diff --git a/test/validator/samples/a11y-no-abstract-roles/warnings.json b/test/validator/samples/a11y-no-abstract-roles/warnings.json new file mode 100644 index 000000000000..2f1aada3715b --- /dev/null +++ b/test/validator/samples/a11y-no-abstract-roles/warnings.json @@ -0,0 +1,182 @@ +[ + { + "code": "a11y-no-abstract-role", + "end": { + "character": 19, + "column": 19, + "line": 1 + }, + "message": "A11y: abstract role 'command' is forbidden", + "pos": 5, + "start": { + "character": 5, + "column": 5, + "line": 1 + } + }, + { + "code": "a11y-no-abstract-role", + "end": { + "character": 43, + "column": 21, + "line": 2 + }, + "message": "A11y: abstract role 'composite' is forbidden", + "pos": 27, + "start": { + "character": 27, + "column": 5, + "line": 2 + } + }, + { + "code": "a11y-no-abstract-role", + "end": { + "character": 63, + "column": 17, + "line": 3 + }, + "message": "A11y: abstract role 'input' is forbidden", + "pos": 51, + "start": { + "character": 51, + "column": 5, + "line": 3 + } + }, + { + "code": "a11y-no-abstract-role", + "end": { + "character": 86, + "column": 20, + "line": 4 + }, + "message": "A11y: abstract role 'landmark' is forbidden", + "pos": 71, + "start": { + "character": 71, + "column": 5, + "line": 4 + } + }, + { + "code": "a11y-no-abstract-role", + "end": { + "character": 106, + "column": 17, + "line": 5 + }, + "message": "A11y: abstract role 'range' is forbidden", + "pos": 94, + "start": { + "character": 94, + "column": 5, + "line": 5 + } + }, + { + "code": "a11y-no-abstract-role", + "end": { + "character": 129, + "column": 20, + "line": 6 + }, + "message": "A11y: abstract role 'roletype' is forbidden", + "pos": 114, + "start": { + "character": 114, + "column": 5, + "line": 6 + } + }, + { + "code": "a11y-no-abstract-role", + "end": { + "character": 151, + "column": 19, + "line": 7 + }, + "message": "A11y: abstract role 'section' is forbidden", + "pos": 137, + "start": { + "character": 137, + "column": 5, + "line": 7 + } + }, + { + "code": "a11y-no-abstract-role", + "end": { + "character": 177, + "column": 23, + "line": 8 + }, + "message": "A11y: abstract role 'sectionhead' is forbidden", + "pos": 159, + "start": { + "character": 159, + "column": 5, + "line": 8 + } + }, + { + "code": "a11y-no-abstract-role", + "end": { + "character": 198, + "column": 18, + "line": 9 + }, + "message": "A11y: abstract role 'select' is forbidden", + "pos": 185, + "start": { + "character": 185, + "column": 5, + "line": 9 + } + }, + { + "code": "a11y-no-abstract-role", + "end": { + "character": 222, + "column": 21, + "line": 10 + }, + "message": "A11y: abstract role 'structure' is forbidden", + "pos": 206, + "start": { + "character": 206, + "column": 5, + "line": 10 + } + }, + { + "code": "a11y-no-abstract-role", + "end": { + "character": 243, + "column": 18, + "line": 11 + }, + "message": "A11y: abstract role 'widget' is forbidden", + "pos": 230, + "start": { + "character": 230, + "column": 5, + "line": 11 + } + }, + { + "code": "a11y-no-abstract-role", + "end": { + "character": 264, + "column": 18, + "line": 12 + }, + "message": "A11y: abstract role 'window' is forbidden", + "pos": 251, + "start": { + "character": 251, + "column": 5, + "line": 12 + } + } +]