Merge pull request #2408 from NullVoxPopuli/nvp/template-lint-extract-rule-template-no-autofocus-attribute

Extract rule: template-no-autofocus-attribute

Author: NullVoxPopuli

README.md

@@ -185,6 +185,7 @@ rules in templates can be disabled with eslint directives with mustache or html
 | [template-no-accesskey-attribute](docs/rules/template-no-accesskey-attribute.md)             | disallow accesskey attribute                                                     |    | 🔧 |    |
 | [template-no-aria-hidden-body](docs/rules/template-no-aria-hidden-body.md)                   | disallow aria-hidden on body element                                             |    | 🔧 |    |
 | [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 |    |    |    |
+| [template-no-autofocus-attribute](docs/rules/template-no-autofocus-attribute.md)             | disallow autofocus attribute                                                     |    | 🔧 |    |
 
 ### Best Practices
 

docs/rules/template-no-autofocus-attribute.md

@@ -0,0 +1,48 @@
+# ember/template-no-autofocus-attribute
+
+🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
+
+<!-- end auto-generated rule header -->
+
+Disallows the use of `autofocus` attribute on elements.
+
+The `autofocus` attribute can cause usability issues for both sighted and non-sighted users by disrupting expected behavior and screen reader announcements.
+
+## Examples
+
+Examples of **incorrect** code for this rule:
+
+```gjs
+<template>
+  <input type="text" autofocus />
+</template>
+```
+
+```gjs
+<template>
+  <textarea autofocus></textarea>
+</template>
+```
+
+Examples of **correct** code for this rule:
+
+```gjs
+<template>
+  <input type="text" />
+</template>
+```
+
+```gjs
+<template>
+  <textarea></textarea>
+</template>
+```
+
+## When Not To Use It
+
+If you need to autofocus for specific accessibility or UX requirements and have thoroughly tested with assistive technologies, you may disable this rule for those specific cases.
+
+## References
+
+- [eslint-plugin-ember template-no-autofocus-attribute](https://github.com/ember-cli/eslint-plugin-ember/blob/master/docs/rules/template-no-autofocus-attribute.md)
+- [MDN autofocus attribute](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/autofocus)

lib/rules/template-no-autofocus-attribute.js

@@ -0,0 +1,48 @@
+/** @type {import('eslint').Rule.RuleModule} */
+module.exports = {
+  meta: {
+    type: 'suggestion',
+    docs: {
+      description: 'disallow autofocus attribute',
+      category: 'Accessibility',
+      strictGjs: true,
+      strictGts: true,
+      url: 'https://github.com/ember-cli/eslint-plugin-ember/tree/master/docs/rules/template-no-autofocus-attribute.md',
+    },
+    fixable: 'code',
+    schema: [],
+    messages: {
+      noAutofocus:
+        'Avoid using autofocus attribute. Autofocusing elements can cause usability issues for sighted and non-sighted users.',
+    },
+  },
+
+  create(context) {
+    return {
+      GlimmerElementNode(node) {
+        const autofocusAttr = node.attributes?.find((attr) => attr.name === 'autofocus');
+
+        if (autofocusAttr) {
+          context.report({
+            node: autofocusAttr,
+            messageId: 'noAutofocus',
+            fix(fixer) {
+              // Remove the attribute including preceding whitespace
+              const sourceCode = context.sourceCode;
+              const text = sourceCode.getText();
+              const attrStart = autofocusAttr.range[0];
+              const attrEnd = autofocusAttr.range[1];
+
+              let removeStart = attrStart;
+              while (removeStart > 0 && /\s/.test(text[removeStart - 1])) {
+                removeStart--;
+              }
+
+              return fixer.removeRange([removeStart, attrEnd]);
+            },
+          });
+        }
+      },
+    };
+  },
+};

tests/lib/rules/template-no-autofocus-attribute.js

@@ -0,0 +1,57 @@
+//------------------------------------------------------------------------------
+// Requirements
+//------------------------------------------------------------------------------
+
+const rule = require('../../../lib/rules/template-no-autofocus-attribute');
+const RuleTester = require('eslint').RuleTester;
+
+//------------------------------------------------------------------------------
+// Tests
+//------------------------------------------------------------------------------
+
+const ruleTester = new RuleTester({
+  parser: require.resolve('ember-eslint-parser'),
+  parserOptions: { ecmaVersion: 2022, sourceType: 'module' },
+});
+
+ruleTester.run('template-no-autofocus-attribute', rule, {
+  valid: [
+    `<template>
+      <input type="text" />
+    </template>`,
+    `<template>
+      <button>Click me</button>
+    </template>`,
+  ],
+
+  invalid: [
+    {
+      code: `<template>
+        <input type="text" autofocus />
+      </template>`,
+      output: `<template>
+        <input type="text"/>
+      </template>`,
+      errors: [
+        {
+          message:
+            'Avoid using autofocus attribute. Autofocusing elements can cause usability issues for sighted and non-sighted users.',
+          type: 'GlimmerAttrNode',
+        },
+      ],
+    },
+    {
+      code: `<template>
+        <textarea autofocus></textarea>
+      </template>`,
+      output: `<template>
+        <textarea></textarea>
+      </template>`,
+      errors: [
+        {
+          type: 'GlimmerAttrNode',
+        },
+      ],
+    },
+  ],
+});