@a11yfred/neighbor 0.2.0 → 1.0.1

package/lib/helpers-angular.js

@@ -1,146 +1,146 @@
-/**
- * neighbor/lib/helpers-angular.js
- * Helpers for Angular template AST via @angular-eslint/template-parser.
- *
- * Parser: @angular-eslint/eslint-plugin-template provides its own rule format.
- * Node type for elements: 'Element$1' (from @angular-eslint/template-parser, the class is
- * TmplAstElement). The node has:
- *   node.name          — tag name string
- *   node.attributes    — TmplAstTextAttribute[] (static attrs)
- *   node.inputs        — TmplAstBoundAttribute[] (property bindings)
- *   node.children      — TmplAstNode[]
- *
- * We only inspect static (non-bound) attributes for ARIA checks.
- * Bound attributes ([aria-label]="expr") cannot be statically analyzed.
- *
- * Angular ESLint rule visitor uses standard ESLint `create(context)` but the
- * parser emits different node types. The visitor key from @angular-eslint is
- * 'Element$1' (the internal class name exposed via the parser).
- */
-
-import {
-  INTERACTIVE_ELEMENTS,
-  INTERACTIVE_ROLES,
-} from './helpers.js'
-
-/** Find a static TmplAstTextAttribute by name. */
-export function getAttr(tmplElement, name) {
-  return (tmplElement.attributes ?? []).find(a => a.name === name) ?? null
-}
-
-/** TmplAstTextAttribute.value is a plain string. */
-export function getAttrStringValue(attr) {
-  if (!attr) return null
-  return typeof attr.value === 'string' ? attr.value || null : null
-}
-
-export function getElementName(tmplElement) {
-  const raw = tmplElement.name ?? ''
-  if (!raw) return null
-  // Angular custom component selectors are typically kebab-case (app-button),
-  // but guard against PascalCase as well to avoid native element name collisions.
-  if (raw[0] !== raw[0].toLowerCase()) return null
-  return raw.toLowerCase()
-}
-
-export function hasAttr(tmplElement, name) {
-  return getAttr(tmplElement, name) !== null
-}
-
-export function getRoleValue(tmplElement) {
-  return getAttrStringValue(getAttr(tmplElement, 'role'))
-}
-
-export function hasAccessibleName(tmplElement) {
-  return hasAttr(tmplElement, 'aria-label') || hasAttr(tmplElement, 'aria-labelledby')
-}
-
-export function isInteractiveElement(tmplElement) {
-  const el = getElementName(tmplElement)
-  if (el && INTERACTIVE_ELEMENTS.has(el)) return true
-  const role = getRoleValue(tmplElement)
-  return !!(role && INTERACTIVE_ROLES.has(role))
-}
-
-export function hasOnlyHiddenChildren(tmplElement) {
-  const children = tmplElement.children ?? []
-  if (children.length === 0) return false
-  return children.every(child => {
-    if (child.constructor?.name === 'TmplAstText') return (child.value ?? '').trim() === ''
-    if (child.constructor?.name === 'TmplAstElement') {
-      return (child.attributes ?? []).some(a => a.name === 'aria-hidden')
-    }
-    return false
-  })
-}
-
-const NEW_TAB_PATTERN = /new.tab|new.window|opens in/i
-
-function collectAngularText(node) {
-  if (!node) return ''
-  if (node.constructor?.name === 'TmplAstText') return node.value ?? ''
-  if (node.constructor?.name === 'TmplAstElement') return (node.children ?? []).map(collectAngularText).join('')
-  return ''
-}
-
-export function hasNewTabWarning(tmplElement) {
-  const labelVal = (getAttrStringValue(getAttr(tmplElement, 'aria-label')) ?? '').toLowerCase()
-  if (NEW_TAB_PATTERN.test(labelVal)) return true
-  const childText = (tmplElement.children ?? []).map(collectAngularText).join('')
-  return NEW_TAB_PATTERN.test(childText)
-}
-
-export function getParent(tmplElement) {
-  // @angular-eslint/template-parser does not set parent on AST nodes —
-  // ancestor walking is not available without tracking the stack ourselves.
-  // Rules needing ancestor traversal are skipped for Angular.
-  return null
-}
-
-export function* getAncestors(_tmplElement) { /* not available */ }
-
-export function* getChildOpeningElements(tmplElement) {
-  for (const child of tmplElement.children ?? []) {
-    if (child.constructor?.name === 'TmplAstElement') yield child
-  }
-}
-
-export function getClassName(tmplElement) {
-  return getAttrStringValue(getAttr(tmplElement, 'class'))
-}
-
-/**
- * Returns the [innerHTML] bound input node if present, else null.
- * In @angular-eslint/template-parser, property bindings live on node.inputs
- * as TmplAstBoundAttribute nodes with { name: 'innerHTML' }.
- */
-export function getInnerHtmlAttr(tmplElement) {
-  return (tmplElement.inputs ?? []).find(i => i.name === 'innerHTML') ?? null
-}
-
-export function getInnerHtmlAttrName(_tmplElement) {
-  return '[innerHTML]'
-}
-
-export const h = {
-  getAttr,
-  getAttrStringValue,
-  getElementName,
-  hasAttr,
-  getRoleValue,
-  hasAccessibleName,
-  isInteractiveElement,
-  hasOnlyHiddenChildren,
-  hasNewTabWarning,
-  getParent,
-  getAncestors,
-  getChildOpeningElements,
-  getClassName,
-  getInnerHtmlAttr,
-  getInnerHtmlAttrName,
-  elementVisitor: 'Element$1',
-  elementWithChildrenVisitor: 'Element$1',
-  getOpeningElement: (node) => node,
-  getChildOpeningElementsFromWrapper: (node) =>
-    (node.children ?? []).filter(c => c.constructor?.name === 'TmplAstElement'),
-}
+/**
+ * neighbor/lib/helpers-angular.js
+ * Helpers for Angular template AST via @angular-eslint/template-parser.
+ *
+ * Parser: @angular-eslint/eslint-plugin-template provides its own rule format.
+ * Node type for elements: 'Element$1' (from @angular-eslint/template-parser, the class is
+ * TmplAstElement). The node has:
+ *   node.name           -  tag name string
+ *   node.attributes     -  TmplAstTextAttribute[] (static attrs)
+ *   node.inputs         -  TmplAstBoundAttribute[] (property bindings)
+ *   node.children       -  TmplAstNode[]
+ *
+ * We only inspect static (non-bound) attributes for ARIA checks.
+ * Bound attributes ([aria-label]="expr") cannot be statically analyzed.
+ *
+ * Angular ESLint rule visitor uses standard ESLint `create(context)` but the
+ * parser emits different node types. The visitor key from @angular-eslint is
+ * 'Element$1' (the internal class name exposed via the parser).
+ */
+
+import {
+  INTERACTIVE_ELEMENTS,
+  INTERACTIVE_ROLES,
+} from './helpers.js'
+
+/** Find a static TmplAstTextAttribute by name. */
+export function getAttr(tmplElement, name) {
+  return (tmplElement.attributes ?? []).find(a => a.name === name) ?? null
+}
+
+/** TmplAstTextAttribute.value is a plain string. */
+export function getAttrStringValue(attr) {
+  if (!attr) return null
+  return typeof attr.value === 'string' ? attr.value || null : null
+}
+
+export function getElementName(tmplElement) {
+  const raw = tmplElement.name ?? ''
+  if (!raw) return null
+  // Angular custom component selectors are typically kebab-case (app-button),
+  // but guard against PascalCase as well to avoid native element name collisions.
+  if (raw[0] !== raw[0].toLowerCase()) return null
+  return raw.toLowerCase()
+}
+
+export function hasAttr(tmplElement, name) {
+  return getAttr(tmplElement, name) !== null
+}
+
+export function getRoleValue(tmplElement) {
+  return getAttrStringValue(getAttr(tmplElement, 'role'))
+}
+
+export function hasAccessibleName(tmplElement) {
+  return hasAttr(tmplElement, 'aria-label') || hasAttr(tmplElement, 'aria-labelledby')
+}
+
+export function isInteractiveElement(tmplElement) {
+  const el = getElementName(tmplElement)
+  if (el && INTERACTIVE_ELEMENTS.has(el)) return true
+  const role = getRoleValue(tmplElement)
+  return !!(role && INTERACTIVE_ROLES.has(role))
+}
+
+export function hasOnlyHiddenChildren(tmplElement) {
+  const children = tmplElement.children ?? []
+  if (children.length === 0) return false
+  return children.every(child => {
+    if (child.constructor?.name === 'TmplAstText') return (child.value ?? '').trim() === ''
+    if (child.constructor?.name === 'TmplAstElement') {
+      return (child.attributes ?? []).some(a => a.name === 'aria-hidden')
+    }
+    return false
+  })
+}
+
+const NEW_TAB_PATTERN = /new.tab|new.window|opens in/i
+
+function collectAngularText(node) {
+  if (!node) return ''
+  if (node.constructor?.name === 'TmplAstText') return node.value ?? ''
+  if (node.constructor?.name === 'TmplAstElement') return (node.children ?? []).map(collectAngularText).join('')
+  return ''
+}
+
+export function hasNewTabWarning(tmplElement) {
+  const labelVal = (getAttrStringValue(getAttr(tmplElement, 'aria-label')) ?? '').toLowerCase()
+  if (NEW_TAB_PATTERN.test(labelVal)) return true
+  const childText = (tmplElement.children ?? []).map(collectAngularText).join('')
+  return NEW_TAB_PATTERN.test(childText)
+}
+
+export function getParent(tmplElement) {
+  // @angular-eslint/template-parser does not set parent on AST nodes  - 
+  // ancestor walking is not available without tracking the stack ourselves.
+  // Rules needing ancestor traversal are skipped for Angular.
+  return null
+}
+
+export function* getAncestors(_tmplElement) { /* not available */ }
+
+export function* getChildOpeningElements(tmplElement) {
+  for (const child of tmplElement.children ?? []) {
+    if (child.constructor?.name === 'TmplAstElement') yield child
+  }
+}
+
+export function getClassName(tmplElement) {
+  return getAttrStringValue(getAttr(tmplElement, 'class'))
+}
+
+/**
+ * Returns the [innerHTML] bound input node if present, else null.
+ * In @angular-eslint/template-parser, property bindings live on node.inputs
+ * as TmplAstBoundAttribute nodes with { name: 'innerHTML' }.
+ */
+export function getInnerHtmlAttr(tmplElement) {
+  return (tmplElement.inputs ?? []).find(i => i.name === 'innerHTML') ?? null
+}
+
+export function getInnerHtmlAttrName(_tmplElement) {
+  return '[innerHTML]'
+}
+
+export const h = {
+  getAttr,
+  getAttrStringValue,
+  getElementName,
+  hasAttr,
+  getRoleValue,
+  hasAccessibleName,
+  isInteractiveElement,
+  hasOnlyHiddenChildren,
+  hasNewTabWarning,
+  getParent,
+  getAncestors,
+  getChildOpeningElements,
+  getClassName,
+  getInnerHtmlAttr,
+  getInnerHtmlAttrName,
+  elementVisitor: 'Element$1',
+  elementWithChildrenVisitor: 'Element$1',
+  getOpeningElement: (node) => node,
+  getChildOpeningElementsFromWrapper: (node) =>
+    (node.children ?? []).filter(c => c.constructor?.name === 'TmplAstElement'),
+}