Merge pull request #2398 from NullVoxPopuli/nvp/template-lint-extract-rule-template-no-abstract-roles

Extract rule: template-no-abstract-roles

Author: NullVoxPopuli

README.md

@@ -179,6 +179,7 @@ rules in templates can be disabled with eslint directives with mustache or html
 | Name                                                                             | Description                             | 💼 | 🔧 | 💡 |
 | :------------------------------------------------------------------------------- | :-------------------------------------- | :- | :- | :- |
 | [template-link-href-attributes](docs/rules/template-link-href-attributes.md)     | require href attribute on link elements |    |    |    |
+| [template-no-abstract-roles](docs/rules/template-no-abstract-roles.md)           | disallow abstract ARIA roles            |    |    |    |
 | [template-no-accesskey-attribute](docs/rules/template-no-accesskey-attribute.md) | disallow accesskey attribute            |    | 🔧 |    |
 
 ### Best Practices

docs/rules/template-no-abstract-roles.md

@@ -0,0 +1,36 @@
+# ember/template-no-abstract-roles
+
+<!-- end auto-generated rule header -->
+
+The HTML attribute `role` must never have the following values:
+
+- `command`
+- `composite`
+- `input`
+- `landmark`
+- `range`
+- `roletype`
+- `section`
+- `sectionhead`
+- `select`
+- `structure`
+- `widget`
+- `window`
+
+## Examples
+
+This rule **forbids** the following:
+
+```hbs
+<div role='window'> Hello, world! </div>
+```
+
+This rule **allows** the following:
+
+```hbs
+<div role='button'> Push it </div>
+```
+
+## References
+
+- See [https://www.w3.org/TR/wai-aria-1.0/roles#abstract_roles](https://www.w3.org/TR/wai-aria-1.0/roles#abstract_roles)

lib/rules/template-no-abstract-roles.js

@@ -0,0 +1,54 @@
+const PROHIBITED_ROLE_VALUES = new Set([
+  'command',
+  'composite',
+  'input',
+  'landmark',
+  'range',
+  'roletype',
+  'section',
+  'sectionhead',
+  'select',
+  'structure',
+  'widget',
+  'window',
+]);
+
+/** @type {import('eslint').Rule.RuleModule} */
+module.exports = {
+  meta: {
+    type: 'problem',
+    docs: {
+      description: 'disallow abstract ARIA roles',
+      category: 'Accessibility',
+      strictGjs: true,
+      strictGts: true,
+      url: 'https://github.com/ember-cli/eslint-plugin-ember/tree/master/docs/rules/template-no-abstract-roles.md',
+    },
+    fixable: null,
+    schema: [],
+    messages: {
+      abstractRole:
+        '{{role}} is an abstract role, and is not a valid value for the role attribute.',
+    },
+  },
+
+  create(context) {
+    return {
+      GlimmerElementNode(node) {
+        const roleAttr = node.attributes?.find((attr) => attr.name === 'role');
+
+        if (roleAttr && roleAttr.value && roleAttr.value.type === 'GlimmerTextNode') {
+          const roleValue = roleAttr.value.chars;
+
+          if (PROHIBITED_ROLE_VALUES.has(roleValue)) {
+            context.report({
+              node: roleAttr,
+              messageId: 'abstractRole',
+              data: { role: roleValue },
+            });
+          }
+        }
+      },
+    };
+  },
+};

tests/lib/rules/template-no-abstract-roles.js

@@ -0,0 +1,23 @@
+const rule = require('../../../lib/rules/template-no-abstract-roles');
+const RuleTester = require('eslint').RuleTester;
+
+const ruleTester = new RuleTester({
+  parser: require.resolve('ember-eslint-parser'),
+  parserOptions: { ecmaVersion: 2022, sourceType: 'module' },
+});
+
+ruleTester.run('template-no-abstract-roles', rule, {
+  valid: ['<template><div role="button"></div></template>', '<template><div></div></template>'],
+  invalid: [
+    {
+      code: '<template><div role="command"></div></template>',
+      output: null,
+      errors: [{ messageId: 'abstractRole' }],
+    },
+    {
+      code: '<template><div role="widget"></div></template>',
+      output: null,
+      errors: [{ messageId: 'abstractRole' }],
+    },
+  ],
+});