Merge pull request #2405 from NullVoxPopuli/nvp/template-lint-extract-rule-template-no-aria-unsupported-elements

Extract rule: template-no-aria-unsupported-elements

Author: NullVoxPopuli

README.md

@@ -178,11 +178,12 @@ rules in templates can be disabled with eslint directives with mustache or html
 
 ### Accessibility
 
-| 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            |    | 🔧 |    |
+| 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                                                     |    | 🔧 |    |
+| [template-no-aria-unsupported-elements](docs/rules/template-no-aria-unsupported-elements.md) | disallow ARIA roles, states, and properties on elements that do not support them |    |    |    |
 
 ### Best Practices
 

docs/rules/template-no-aria-unsupported-elements.md

@@ -0,0 +1,61 @@
+# ember/template-no-aria-unsupported-elements
+
+<!-- end auto-generated rule header -->
+
+Disallows using ARIA roles, states, and properties on elements that do not support them.
+
+Certain HTML elements do not support ARIA roles, states, and properties. This rule helps ensure that ARIA attributes are only used on elements that support them, improving accessibility.
+
+## Rule Details
+
+This rule disallows ARIA attributes on elements that do not support them, including:
+
+- `meta`
+- `html`
+- `script`
+- `style`
+- `title`
+- `base`
+- `head`
+- `link`
+
+## Examples
+
+Examples of **incorrect** code for this rule:
+
+```gjs
+<template>
+  <meta role="button" />
+</template>
+```
+
+```gjs
+<template>
+  <script aria-label="Analytics"></script>
+</template>
+```
+
+```gjs
+<template>
+  <style role="presentation"></style>
+</template>
+```
+
+Examples of **correct** code for this rule:
+
+```gjs
+<template>
+  <div role="button" aria-label="Submit"></div>
+</template>
+```
+
+```gjs
+<template>
+  <button aria-pressed="true">Toggle</button>
+</template>
+```
+
+## References
+
+- [WAI-ARIA in HTML](https://www.w3.org/TR/html-aria/)
+- [ember-template-lint no-aria-unsupported-elements](https://github.com/ember-template-lint/ember-template-lint/blob/master/docs/rule/no-aria-unsupported-elements.md)

lib/rules/template-no-aria-unsupported-elements.js

@@ -0,0 +1,58 @@
+/** @type {import('eslint').Rule.RuleModule} */
+module.exports = {
+  meta: {
+    type: 'problem',
+    docs: {
+      description:
+        'disallow ARIA roles, states, and properties on elements that do not support them',
+      category: 'Accessibility',
+      strictGjs: true,
+      strictGts: true,
+      url: 'https://github.com/ember-cli/eslint-plugin-ember/tree/master/docs/rules/template-no-aria-unsupported-elements.md',
+    },
+    fixable: null,
+    schema: [],
+    messages: {
+      unsupported:
+        'ARIA attribute "{{attribute}}" is not supported on <{{element}}> elements. Consider using a different element.',
+    },
+  },
+
+  create(context) {
+    // Elements that don't support ARIA
+    const ELEMENTS_WITHOUT_ARIA_SUPPORT = new Set([
+      'meta',
+      'html',
+      'script',
+      'style',
+      'title',
+      'base',
+      'head',
+      'link',
+    ]);
+
+    return {
+      GlimmerElementNode(node) {
+        if (ELEMENTS_WITHOUT_ARIA_SUPPORT.has(node.tag)) {
+          const ariaAttributes = node.attributes?.filter(
+            (attr) =>
+              attr.type === 'GlimmerAttrNode' &&
+              attr.name &&
+              (attr.name.startsWith('aria-') || attr.name === 'role')
+          );
+
+          for (const attr of ariaAttributes || []) {
+            context.report({
+              node: attr,
+              messageId: 'unsupported',
+              data: {
+                attribute: attr.name,
+                element: node.tag,
+              },
+            });
+          }
+        }
+      },
+    };
+  },
+};

tests/lib/rules/template-no-aria-unsupported-elements.js

@@ -0,0 +1,33 @@
+const rule = require('../../../lib/rules/template-no-aria-unsupported-elements');
+const RuleTester = require('eslint').RuleTester;
+
+const ruleTester = new RuleTester({
+  parser: require.resolve('ember-eslint-parser'),
+  parserOptions: { ecmaVersion: 2022, sourceType: 'module' },
+});
+
+ruleTester.run('template-no-aria-unsupported-elements', rule, {
+  valid: [
+    '<template><div role="button" aria-label="Submit"></div></template>',
+    '<template><button aria-pressed="true">Toggle</button></template>',
+    '<template><input aria-label="Username"></template>',
+  ],
+
+  invalid: [
+    {
+      code: '<template><meta role="button"></template>',
+      output: null,
+      errors: [{ messageId: 'unsupported' }],
+    },
+    {
+      code: '<template><script aria-label="Script"></script></template>',
+      output: null,
+      errors: [{ messageId: 'unsupported' }],
+    },
+    {
+      code: '<template><style role="presentation"></style></template>',
+      output: null,
+      errors: [{ messageId: 'unsupported' }],
+    },
+  ],
+});