@surea11y/core 1.2.0 → 1.4.0

package/src/checks/manual/identical-links-same-purpose-manual.js

@@ -1,3 +1,5 @@
+/* SPDX-License-Identifier: MPL-2.0 */
+
 'use strict';
 
 /**
@@ -42,7 +44,13 @@ const meta = {
   tags: ['wcag2aaa', 'wcag249', 'navigation', 'atomic', 'manual'],
   wcagSc: ['2.4.9'],
   normativeMappings: [
-    { standard: 'WCAG', version: '2.2', requirement: '2.4.9', title: 'Link Purpose (Link Only)', conformanceLevel: 'AAA' }
+    {
+      standard: 'WCAG',
+      version: '2.2',
+      requirement: '2.4.9',
+      title: 'Link Purpose (Link Only)',
+      conformanceLevel: 'AAA'
+    }
   ],
   defaultSeverity: 'minor',
   category: 'operable',
@@ -52,13 +60,15 @@ const meta = {
 };
 
 function runInPage(ctx) {
-  const { document, helpers, rule } = ctx;
+  const { helpers, rule } = ctx;
 
   function normName(s) {
     return (s == null ? '' : String(s)).replace(/\s+/g, ' ').trim().toLowerCase();
   }
 
-  const nodes = helpers.queryAllSmart ? helpers.queryAllSmart('a[href]') : helpers.queryAll('a[href]');
+  const nodes = helpers.queryAllSmart
+    ? helpers.queryAllSmart('a[href]')
+    : helpers.queryAll('a[href]');
 
   const groups = new Map(); // normName -> [{ el, href }]
   let applicableCount = 0;
@@ -67,18 +77,24 @@ function runInPage(ctx) {
     if (!el || !el.getAttribute) continue;
 
     const eligResult = helpers.isAccTreeEligible ? helpers.isAccTreeEligible(el, ctx) : true;
-    const eligible = typeof eligResult === 'boolean' ? eligResult : !!(eligResult && eligResult.eligible);
+    const eligible =
+      typeof eligResult === 'boolean' ? eligResult : !!(eligResult && eligResult.eligible);
     if (!eligible) continue;
 
     const nameInfo = helpers.getAccessibleNameInfo ? helpers.getAccessibleNameInfo(el, ctx) : null;
-    const rawName = (nameInfo && typeof nameInfo.value === 'string' && nameInfo.value.trim())
-      ? nameInfo.value
-      : (el.textContent || '');
+    const rawName =
+      nameInfo && typeof nameInfo.value === 'string' && nameInfo.value.trim()
+        ? nameInfo.value
+        : el.textContent || '';
     const name = normName(rawName);
     if (!name) continue;
 
-    let href = '';
-    try { href = String(el.href || ''); } catch { href = ''; }
+    let href;
+    try {
+      href = String(el.href || '');
+    } catch {
+      href = '';
+    }
     if (!href) continue;
 
     applicableCount += 1;
@@ -95,12 +111,15 @@ function runInPage(ctx) {
 
     for (const { el, href } of entries) {
       const stableSelector = helpers.buildSelector ? helpers.buildSelector(el) : 'html';
-      const html = helpers.getOuterHtmlSnippet ? helpers.getOuterHtmlSnippet(el) : (el.outerHTML || '');
+      const html = helpers.getOuterHtmlSnippet
+        ? helpers.getOuterHtmlSnippet(el)
+        : el.outerHTML || '';
 
       const baseOccurrence = {
         selector: stableSelector,
         html,
-        summary: 'This link shares an accessible name with other links on the page that lead to a different destination.',
+        summary:
+          'This link shares an accessible name with other links on the page that lead to a different destination.',
         hint: 'Ensure links with the same text serve the same purpose, or make the link text distinct enough to describe each destination.',
         i18n: {
           summaryKey: 'identicalLinksSamePurpose_summary_cantTell',
@@ -130,7 +149,12 @@ function runInPage(ctx) {
   }
 
   if (occurrences.length) {
-    return { ruleId: rule.ruleId, outcome: 'cantTell', severity: rule.defaultSeverity || 'minor', occurrences };
+    return {
+      ruleId: rule.ruleId,
+      outcome: 'cantTell',
+      severity: rule.defaultSeverity || 'minor',
+      occurrences
+    };
   }
 
   // Manual rules may only emit cantTell/notApplicable (never pass/fail):

package/src/checks/manual/image-redundant-alt-manual.js

@@ -1,10 +1,12 @@
+/* SPDX-License-Identifier: MPL-2.0 */
+
 'use strict';
 
 /**
  * @check image-redundant-alt
  * @atomic true
  * @summary An image's alt text must not duplicate adjacent visible text
- * @standard Best Practices (a widely-used reference engine's classification; no formal WCAG Success Criterion — see ROADMAP.md Tier 1b)
+ * @standard Best Practices (no formal WCAG Success Criterion — see ROADMAP.md Tier 1b)
  * @applicability
  *   Applies to <img> elements with non-empty alt text whose immediate
  *   parent element also has other visible text content (i.e. text nodes
@@ -30,7 +32,8 @@ const id = 'image-redundant-alt';
 
 const meta = {
   title: 'Image alt text must not duplicate adjacent visible text',
-  description: 'Checks that an <img> alt text is not identical to other visible text already present in its immediate parent element.',
+  description:
+    'Checks that an <img> alt text is not identical to other visible text already present in its immediate parent element.',
   i18n: {
     titleKey: 'imageRedundantAlt_title',
     descriptionKey: 'imageRedundantAlt_description'
@@ -47,26 +50,48 @@ const meta = {
 };
 
 function runInPage(ctx) {
-  const { document, helpers, rule } = ctx;
+  const { helpers, rule } = ctx;
 
   function normalizeWs(s) {
-    return String(s || '').replace(/\s+/g, ' ').trim();
+    return String(s || '')
+      .replace(/\s+/g, ' ')
+      .trim();
   }
 
   function getOwnTextExcludingImg(parent, imgEl) {
+    const isAccTreeEligible =
+      helpers && typeof helpers.isAccTreeEligible === 'function' ? helpers.isAccTreeEligible : null;
+
     let text = '';
     for (const child of parent.childNodes || []) {
       if (child === imgEl) continue;
       if (child.nodeType === 3) {
         text += ' ' + (child.nodeValue || '');
       } else if (child.nodeType === 1 && child !== imgEl) {
+        // An aria-hidden sibling is never actually announced to assistive
+        // technology, so its text can't cause the "same words twice"
+        // double-announcement this rule exists to catch -- counting it
+        // anyway flags a redundancy that doesn't exist in what AT users
+        // actually hear.
+        if (isAccTreeEligible) {
+          const elig = (() => {
+            try {
+              return isAccTreeEligible(child, ctx);
+            } catch {
+              return { eligible: true, reasons: [] };
+            }
+          })();
+          if (elig && elig.eligible === false) continue;
+        }
         text += ' ' + (child.textContent || '');
       }
     }
     return normalizeWs(text);
   }
 
-  const nodes = helpers.queryAllSmart ? helpers.queryAllSmart('img[alt]') : helpers.queryAll('img[alt]');
+  const nodes = helpers.queryAllSmart
+    ? helpers.queryAllSmart('img[alt]')
+    : helpers.queryAll('img[alt]');
 
   const occurrences = [];
   let applicableCount = 0;
@@ -87,12 +112,12 @@ function runInPage(ctx) {
     if (otherText.toLowerCase() !== alt.toLowerCase()) continue;
 
     const stableSelector = helpers.buildSelector ? helpers.buildSelector(el) : 'html';
-    const html = helpers.getOuterHtmlSnippet ? helpers.getOuterHtmlSnippet(el) : (el.outerHTML || '');
+    const html = helpers.getOuterHtmlSnippet ? helpers.getOuterHtmlSnippet(el) : el.outerHTML || '';
 
     occurrences.push({
       selector: stableSelector,
       html,
-      summary: 'This image\'s alt text duplicates other visible text right next to it.',
+      summary: "This image's alt text duplicates other visible text right next to it.",
       hint: 'Make the alt text empty (alt="") if the image is purely decorative alongside the text, or remove the redundant duplication.',
       i18n: {
         summaryKey: 'imageRedundantAlt_summary_cantTell',
@@ -109,7 +134,12 @@ function runInPage(ctx) {
     return { ruleId: rule.ruleId, outcome: 'notApplicable', severity: 'minor', occurrences: [] };
   }
   if (occurrences.length) {
-    return { ruleId: rule.ruleId, outcome: 'cantTell', severity: rule.defaultSeverity || 'minor', occurrences };
+    return {
+      ruleId: rule.ruleId,
+      outcome: 'cantTell',
+      severity: rule.defaultSeverity || 'minor',
+      occurrences
+    };
   }
   return { ruleId: rule.ruleId, outcome: 'notApplicable', severity: 'minor', occurrences: [] };
 }

package/src/checks/manual/img-alt-decorative-manual.js

@@ -1,3 +1,5 @@
+/* SPDX-License-Identifier: MPL-2.0 */
+
 'use strict';
 
 /**
@@ -11,20 +13,27 @@
  *   Human review is required to confirm that the provided text alternative is accurate and appropriate.
  */
 
-const id = "img-alt-decorative";
+const id = 'img-alt-decorative';
 
 const meta = {
-  title: "<img> with alt=\"\" must be decorative (manual review)",
-  description: "Flags <img> elements with empty alt for human review that they are purely decorative.",
+  title: '<img> with alt="" must be decorative (manual review)',
+  description:
+    'Flags <img> elements with empty alt for human review that they are purely decorative.',
   i18n: {
-    titleKey: "img_altDecorative_title",
-    descriptionKey: "img_altDecorative_description"
+    titleKey: 'img_altDecorative_title',
+    descriptionKey: 'img_altDecorative_description'
   },
   helpUrl: null,
-  tags: ["wcag2a", "wcag111", "nontext", "images", "manual", "atomic"],
+  tags: ['wcag2a', 'wcag111', 'nontext', 'images', 'manual', 'atomic'],
   wcagSc: ['1.1.1'],
   normativeMappings: [
-    { standard: 'WCAG', version: '2.2', requirement: '1.1.1', title: 'Non-text Content', conformanceLevel: 'A' }
+    {
+      standard: 'WCAG',
+      version: '2.2',
+      requirement: '1.1.1',
+      title: 'Non-text Content',
+      conformanceLevel: 'A'
+    }
   ],
   defaultSeverity: 'minor',
   category: 'perceivable',
@@ -38,111 +47,139 @@ const meta = {
 };
 
 function runInPage(ctx) {
-
-    const { document, root, helpers, rule } = ctx;
-    const safeRoot = root || document;
-
-    const queryAllSmart = helpers && typeof helpers.queryAllSmart === 'function' ? helpers.queryAllSmart : null;
-    const queryAll = helpers && typeof helpers.queryAll === 'function'
-        ? helpers.queryAll
-        : (sel) => {
-            try { return safeRoot && safeRoot.querySelectorAll ? Array.from(safeRoot.querySelectorAll(sel)) : []; }
-            catch { return []; }
+  const { document, root, helpers, rule } = ctx;
+  const safeRoot = root || document;
+
+  const queryAllSmart =
+    helpers && typeof helpers.queryAllSmart === 'function' ? helpers.queryAllSmart : null;
+  const queryAll =
+    helpers && typeof helpers.queryAll === 'function'
+      ? helpers.queryAll
+      : (sel) => {
+          try {
+            return safeRoot && safeRoot.querySelectorAll
+              ? Array.from(safeRoot.querySelectorAll(sel))
+              : [];
+          } catch {
+            return [];
+          }
         };
 
-    const isAccTreeEligible = helpers && typeof helpers.isAccTreeEligible === 'function'
-        ? helpers.isAccTreeEligible
-        : null;
-
-    const getFocusableInfo = helpers && typeof helpers.getFocusableInfo === 'function'
-        ? helpers.getFocusableInfo
-        : null;
-
-    function isRolePresentationExcluded(el) {
-        const role = (() => {
-            try { return String(el.getAttribute('role') || '').trim().toLowerCase(); }
-            catch { return ''; }
-        })();
-        if (role !== 'presentation' && role !== 'none') return false;
-
-        // Exclude only when NOT focusable (mirrors img-alt-present policy)
-        let focusable = false;
-        if (getFocusableInfo) {
-            const fi = (() => { try { return getFocusableInfo(el, ctx); } catch { return null; } })();
-            focusable = !!(fi && fi.focusable);
-        } else {
-            const tabindex = el.getAttribute('tabindex');
-            focusable = tabindex != null && String(tabindex).trim() !== '' && !Number.isNaN(Number(String(tabindex).trim()));
+  const isAccTreeEligible =
+    helpers && typeof helpers.isAccTreeEligible === 'function' ? helpers.isAccTreeEligible : null;
+
+  const getFocusableInfo =
+    helpers && typeof helpers.getFocusableInfo === 'function' ? helpers.getFocusableInfo : null;
+
+  function isRolePresentationExcluded(el) {
+    const role = (() => {
+      try {
+        return String(el.getAttribute('role') || '')
+          .trim()
+          .toLowerCase();
+      } catch {
+        return '';
+      }
+    })();
+    if (role !== 'presentation' && role !== 'none') return false;
+
+    // Exclude only when NOT focusable (mirrors img-alt-present policy)
+    let focusable;
+    if (getFocusableInfo) {
+      const fi = (() => {
+        try {
+          return getFocusableInfo(el, ctx);
+        } catch {
+          return null;
         }
-        return !focusable;
+      })();
+      focusable = !!(fi && fi.focusable);
+    } else {
+      const tabindex = el.getAttribute('tabindex');
+      focusable =
+        tabindex != null &&
+        String(tabindex).trim() !== '' &&
+        !Number.isNaN(Number(String(tabindex).trim()));
     }
+    return !focusable;
+  }
 
-    const els = (() => {
-        // Only likely candidates:
-        // - alt="" (exact)
-        // - alt that starts/ends with space (to catch whitespace-only like "   ")
-        const sel = 'img[alt=""], img[alt^=" "], img[alt$=" "]';
-        try { return Array.from((queryAllSmart ? queryAllSmart(sel) : queryAll(sel)) || []); }
-        catch { return queryAll(sel); }
-    })();
-    const uniqueEls = [];
-    const seen = new Set();
-    for (const el of els) {
-        if (!seen.has(el)) { seen.add(el); uniqueEls.push(el); }
+  const els = (() => {
+    // Only likely candidates:
+    // - alt="" (exact)
+    // - alt that starts/ends with space (to catch whitespace-only like "   ")
+    const sel = 'img[alt=""], img[alt^=" "], img[alt$=" "]';
+    try {
+      return Array.from((queryAllSmart ? queryAllSmart(sel) : queryAll(sel)) || []);
+    } catch {
+      return queryAll(sel);
     }
-
-    if (!els.length) {
-        return { ruleId: rule.ruleId, outcome: 'notApplicable', severity: 'minor', occurrences: [] };
+  })();
+  const uniqueEls = [];
+  const seen = new Set();
+  for (const el of els) {
+    if (!seen.has(el)) {
+      seen.add(el);
+      uniqueEls.push(el);
     }
+  }
 
-    const occurrences = [];
-    let applicableCount = 0;
-
-    for (const el of uniqueEls) {
-        if (!el || !el.getAttribute) continue;
+  if (!els.length) {
+    return { ruleId: rule.ruleId, outcome: 'notApplicable', severity: 'minor', occurrences: [] };
+  }
 
-        if (isAccTreeEligible) {
-            const elig = (() => {
-                try { return isAccTreeEligible(el, ctx); } catch { return { eligible: true, reasons: [] }; }
-            })();
-            if (elig && elig.eligible === false) continue;
-        }
+  const occurrences = [];
+  let applicableCount = 0;
 
-        if (isRolePresentationExcluded(el)) continue;
-
-        // Rule-specific applicability (only elements that already have a text alternative mechanism)
-        const rawAlt = el.getAttribute('alt');
-        if (rawAlt == null) continue;
-        if (String(rawAlt).trim() !== '') continue;
-
-        applicableCount += 1;
-
-        const baseOccurrence = {
-            summary: 'Review whether <img> is decorative (alt="").',
-            hint: 'Confirm the image is purely decorative. If it conveys information or function, provide meaningful alt text.',
-            i18n: {
-                summaryKey: 'img_altDecorative_summary_cantTell',
-                hintKey: 'img_altDecorative_hint_cantTell',
-                params: { element: 'img' }
-            },
-            data: {
-                visibilityFilter: { targetSet: 'acc', accEligible: null, reasons: [] },
-                details: null
-            }
-        };
+  for (const el of uniqueEls) {
+    if (!el || !el.getAttribute) continue;
 
-        if (helpers && typeof helpers.reportOccurrence === 'function') {
-            occurrences.push(helpers.reportOccurrence(el, baseOccurrence));
-        } else {
-            occurrences.push({ selector: '', html: '', ...baseOccurrence });
+    if (isAccTreeEligible) {
+      const elig = (() => {
+        try {
+          return isAccTreeEligible(el, ctx);
+        } catch {
+          return { eligible: true, reasons: [] };
         }
+      })();
+      if (elig && elig.eligible === false) continue;
     }
 
-    if (applicableCount === 0) {
-        return { ruleId: rule.ruleId, outcome: 'notApplicable', severity: 'minor', occurrences: [] };
+    if (isRolePresentationExcluded(el)) continue;
+
+    // Rule-specific applicability (only elements that already have a text alternative mechanism)
+    const rawAlt = el.getAttribute('alt');
+    if (rawAlt == null) continue;
+    if (String(rawAlt).trim() !== '') continue;
+
+    applicableCount += 1;
+
+    const baseOccurrence = {
+      summary: 'Review whether <img> is decorative (alt="").',
+      hint: 'Confirm the image is purely decorative. If it conveys information or function, provide meaningful alt text.',
+      i18n: {
+        summaryKey: 'img_altDecorative_summary_cantTell',
+        hintKey: 'img_altDecorative_hint_cantTell',
+        params: { element: 'img' }
+      },
+      data: {
+        visibilityFilter: { targetSet: 'acc', accEligible: null, reasons: [] },
+        details: null
+      }
+    };
+
+    if (helpers && typeof helpers.reportOccurrence === 'function') {
+      occurrences.push(helpers.reportOccurrence(el, baseOccurrence));
+    } else {
+      occurrences.push({ selector: '', html: '', ...baseOccurrence });
     }
+  }
+
+  if (applicableCount === 0) {
+    return { ruleId: rule.ruleId, outcome: 'notApplicable', severity: 'minor', occurrences: [] };
+  }
 
-    return { ruleId: rule.ruleId, outcome: 'cantTell', severity: 'minor', occurrences };
+  return { ruleId: rule.ruleId, outcome: 'cantTell', severity: 'minor', occurrences };
 }
 
 module.exports = { id, meta, runInPage };