@surea11y/core 1.2.0 → 1.4.0

package/src/checks/automatic/progressbar-name-present.js

@@ -1,3 +1,5 @@
+/* SPDX-License-Identifier: MPL-2.0 */
+
 'use strict';
 
 const id = 'progressbar-name-present';
@@ -13,7 +15,13 @@ const meta = {
   tags: ['wcag2a', 'wcag111', 'nontext', 'atomic', 'automatic', 'name'],
   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: 'serious',
   category: 'perceivable',
@@ -24,36 +32,22 @@ const meta = {
 
 function runInPage(ctx) {
   const { document, helpers, rule } = ctx;
-  const getEligibilityInfo = helpers && typeof helpers.getEligibilityInfo === 'function'
-      ? helpers.getEligibilityInfo
-      : null;
-
+  const getEligibilityInfo =
+    helpers && typeof helpers.getEligibilityInfo === 'function' ? helpers.getEligibilityInfo : null;
 
   function normalizeWs(s) {
-    return String(s || '').replace(/\s+/g, ' ').trim();
+    return String(s || '')
+      .replace(/\s+/g, ' ')
+      .trim();
   }
 
   function getAttr(el, name) {
     try {
       if (!el || !el.getAttribute) return '';
       return normalizeWs(el.getAttribute(name));
-    } catch { return ''; }
-  }
-
-  function getConservativeSubtreeText(document, container) {
-    // "Name from content" — recurses into descendants and uses each one's
-    // own accessible name (img alt, aria-label/aria-labelledby, title) when
-    // it has one, not just literal text nodes. See getContentNameInfo's
-    // header comment in src/core/dom-helpers.js for the full rationale
-    // (this replaced a text-node-only TreeWalker that missed the common
-    // "<a><img alt='...'></a>" logo-link / "<button><img alt='...'></button>"
-    // icon-button pattern).
-    if (helpers.getContentNameInfo) {
-      const info = helpers.getContentNameInfo(container, ctx);
-      return info && info.present ? info.value : '';
+    } catch {
+      return '';
     }
-    const t = (container && container.textContent) ? String(container.textContent) : '';
-    return t.replace(/\s+/g, ' ').trim();
   }
 
   function resolveAriaLabelledbyText(document, el, maxRefs) {
@@ -74,7 +68,8 @@ function runInPage(ctx) {
   }
 
   function isEligibleAcc(helpers, el, ctx) {
-    const fn = helpers && typeof helpers.isAccTreeEligible === 'function' ? helpers.isAccTreeEligible : null;
+    const fn =
+      helpers && typeof helpers.isAccTreeEligible === 'function' ? helpers.isAccTreeEligible : null;
     if (!fn) return true;
     try {
       const r = fn(el, ctx);
@@ -85,13 +80,13 @@ function runInPage(ctx) {
     }
   }
 
-
   const occurrences = [];
   let applicableCount = 0;
 
   const selector = '[role="progressbar"]';
-  const nodes = helpers.queryAllSmart ? helpers.queryAllSmart(selector) : helpers.queryAll(selector);
-
+  const nodes = helpers.queryAllSmart
+    ? helpers.queryAllSmart(selector)
+    : helpers.queryAll(selector);
 
   function evaluate(el) {
     const ariaLabel = getAttr(el, 'aria-label');
@@ -103,16 +98,12 @@ function runInPage(ctx) {
     const title = getAttr(el, 'title');
     if (title) return { ok: true, method: 'title' };
 
-    // role="progressbar" is name-from-author-only per WAI-ARIA (verified
-    // against a widely-used reference engine's own aria-progressbar-name check: any:
-    // ['aria-label', 'aria-labelledby', title] — no content-based naming
-    // method at all). It must NOT fall back to subtree content: found on a
-    // real site, Instacart's <ul role="progressbar"> loading skeleton has
-    // no name of its own, but nested descendants carry their own
-    // aria-label="Loading Box" (for a completely different purpose) —
-    // falling back to subtree content picked that up and wrongly treated
-    // it as the progressbar's own name, when that reference engine correctly
-    // still flags it as unnamed.
+    // role="progressbar" is name-from-author-only per WAI-ARIA: aria-label,
+    // aria-labelledby, or title — no content-based naming method at all. It
+    // must NOT fall back to subtree content: e.g. a <ul role="progressbar">
+    // loading skeleton with no name of its own, whose nested descendants
+    // carry their own aria-label for a different purpose — falling back to
+    // subtree content would wrongly treat that as the progressbar's name.
     return { ok: false, method: 'none' };
   }
 
@@ -129,36 +120,50 @@ function runInPage(ctx) {
     if (res.ok) continue;
 
     const eligInfo = getEligibilityInfo
-        ? (() => { try { return getEligibilityInfo(el, ctx, { targetSet: 'acc' }); } catch { return null; } })()
-        : null;
+      ? (() => {
+          try {
+            return getEligibilityInfo(el, ctx, { targetSet: 'acc' });
+          } catch {
+            return null;
+          }
+        })()
+      : null;
     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 progress bar has no accessible name.',
-      hint: 'Provide progress bar text that is not hidden from assistive technologies, or provide aria-label or aria-labelledby.',
+      hint: "Provide aria-label, aria-labelledby, or a title attribute — visible text content is not exposed as this progress bar's accessible name.",
       i18n: {
         summaryKey: 'progressbarNamePresent_summary_fail',
         hintKey: 'progressbarNamePresent_hint_fail',
         params: {}
       },
       data: {
-        details: { reasonCode: 'name_missing', controlType: 'progressbar', methodTried: res.method },
+        details: {
+          reasonCode: 'name_missing',
+          controlType: 'progressbar',
+          methodTried: res.method
+        },
         visibilityFilter: eligInfo || { targetSet: 'acc', accEligible: null, reasons: [] }
       }
     });
   }
 
-
   if (applicableCount === 0) {
     return { ruleId: rule.ruleId, outcome: 'notApplicable', severity: 'minor', occurrences: [] };
   }
   if (occurrences.length) {
-    return { ruleId: rule.ruleId, outcome: 'fail', severity: rule.defaultSeverity || 'minor', occurrences };
+    return {
+      ruleId: rule.ruleId,
+      outcome: 'fail',
+      severity: rule.defaultSeverity || 'minor',
+      occurrences
+    };
   }
   return { ruleId: rule.ruleId, outcome: 'pass', severity: 'minor', occurrences: [] };
 }
 
-module.exports = { id, meta, runInPage };
+module.exports = { id, meta, runInPage };

package/src/checks/automatic/role-img-alt-present.js

@@ -1,3 +1,5 @@
+/* SPDX-License-Identifier: MPL-2.0 */
+
 'use strict';
 
 /**
@@ -14,193 +16,243 @@
  *   Each applicable element with role="img" has an accessible text alternative:
  *    - aria-label with a non-empty value; OR
  *    - aria-labelledby referencing at least one existing element that contributes non-empty text; OR
- *    - a non-empty title attribute (last-resort accessible-name source per HTML-AAM,
- *      also accepted by a widely-used reference engine's equivalent role-img-alt rule).
+ *    - a non-empty title attribute (last-resort accessible-name source per HTML-AAM).
  */
 
 const id = 'role-img-text-alternative-present';
 
 const meta = {
-    title: '[role="img"] must have an accessible text alternative',
-    description:
-        'Checks that elements with role="img" provide an accessible text alternative via aria-label, aria-labelledby, or a title attribute.',
-    i18n: {
-        titleKey: 'roleImg_textAlternativePresent_title',
-        descriptionKey: 'roleImg_textAlternativePresent_description'
-    },
-    helpUrl: null,
-    tags: ['wcag2a', 'wcag111', 'nontext', 'images', 'aria', 'atomic', 'automatic'],
-    wcagSc: ['1.1.1'],
-    normativeMappings: [
-        { standard: 'WCAG', version: '2.2', requirement: '1.1.1', title: 'Non-text Content', conformanceLevel: 'A' }
-    ],
-    defaultSeverity: 'serious',
-    category: 'perceivable',
-    type: 'automatic',
-    defaultConfidence: 'high',
-    coverage: {
-        facetsBySc: {
-            '1.1.1': ['role-img-text-alternative-present']
-        }
+  title: '[role="img"] must have an accessible text alternative',
+  description:
+    'Checks that elements with role="img" provide an accessible text alternative via aria-label, aria-labelledby, or a title attribute.',
+  i18n: {
+    titleKey: 'roleImg_textAlternativePresent_title',
+    descriptionKey: 'roleImg_textAlternativePresent_description'
+  },
+  helpUrl: null,
+  tags: ['wcag2a', 'wcag111', 'nontext', 'images', 'aria', 'atomic', 'automatic'],
+  wcagSc: ['1.1.1'],
+  normativeMappings: [
+    {
+      standard: 'WCAG',
+      version: '2.2',
+      requirement: '1.1.1',
+      title: 'Non-text Content',
+      conformanceLevel: 'A'
+    }
+  ],
+  defaultSeverity: 'serious',
+  category: 'perceivable',
+  type: 'automatic',
+  defaultConfidence: 'high',
+  coverage: {
+    facetsBySc: {
+      '1.1.1': ['role-img-text-alternative-present']
     }
+  }
 };
 
 function runInPage(ctx) {
-    const { 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 { 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 getEligibilityInfo = helpers && typeof helpers.getEligibilityInfo === 'function'
-        ? helpers.getEligibilityInfo
-        : null;
+  const getEligibilityInfo =
+    helpers && typeof helpers.getEligibilityInfo === 'function' ? helpers.getEligibilityInfo : null;
 
-    const trim = (v) => {
-        try { return String(v == null ? '' : v).replace(/\s+/g, ' ').trim(); }
-        catch { return ''; }
-    };
-
-    const imgElements = (() => {
-        // do not consider element "img" because it has its own rule
-        const sel = '[role="img" i]:not(img)';
-        try { return Array.from((queryAllSmart ? queryAllSmart(sel) : queryAll(sel)) || []); }
-        catch { return queryAll(sel); }
-    })();
-
-    if (!imgElements.length) {
-        return { ruleId: rule.ruleId, outcome: 'notApplicable', severity: 'minor', occurrences: [] };
+  const trim = (v) => {
+    try {
+      return String(v == null ? '' : v)
+        .replace(/\s+/g, ' ')
+        .trim();
+    } catch {
+      return '';
+    }
+  };
+
+  const imgElements = (() => {
+    // do not consider element "img" because it has its own rule
+    const sel = '[role="img" i]:not(img)';
+    try {
+      return Array.from((queryAllSmart ? queryAllSmart(sel) : queryAll(sel)) || []);
+    } catch {
+      return queryAll(sel);
     }
+  })();
 
-    const occurrences = [];
-    let applicableCount = 0;
+  if (!imgElements.length) {
+    return { ruleId: rule.ruleId, outcome: 'notApplicable', severity: 'minor', occurrences: [] };
+  }
 
-    const isAccTreeEligible = helpers && typeof helpers.isAccTreeEligible === 'function'
-        ? helpers.isAccTreeEligible
-        : null;
+  const occurrences = [];
+  let applicableCount = 0;
 
-    const getAccessibleNameInfo = helpers && typeof helpers.getAccessibleNameInfo === 'function'
-        ? helpers.getAccessibleNameInfo
-        : null;
+  const isAccTreeEligible =
+    helpers && typeof helpers.isAccTreeEligible === 'function' ? helpers.isAccTreeEligible : null;
 
-    for (const el of imgElements) {
-        if (!el || !el.getAttribute) continue;
+  const getAccessibleNameInfo =
+    helpers && typeof helpers.getAccessibleNameInfo === 'function'
+      ? helpers.getAccessibleNameInfo
+      : null;
 
-        // Applicability: eligible in the acc tree (with helper exceptions).
-        if (isAccTreeEligible) {
-            const elig = (() => {
-                try { return isAccTreeEligible(el, ctx); } catch { return { eligible: true, reasons: [] }; }
-            })();
-            if (elig && elig.eligible === false) continue;
-        }
+  for (const el of imgElements) {
+    if (!el || !el.getAttribute) continue;
 
-        applicableCount += 1;
-
-        // Expectation: aria-label OR aria-labelledby. We use helper name-info when available,
-        // but we also validate the source to keep this rule scoped/deterministic.
-
-        const ariaLabelRaw = (() => { try { return el.getAttribute('aria-label'); } catch { return null; } })();
-        const ariaLabel = trim(ariaLabelRaw);
-
-        const ariaLabelledbyRaw = (() => { try { return el.getAttribute('aria-labelledby'); } catch { return null; } })();
-        const ariaLabelledby = trim(ariaLabelledbyRaw);
-
-        const hasAriaLabelAttr = ariaLabelRaw !== null;
-        const hasAriaLabelledbyAttr = ariaLabelledbyRaw !== null;
-
-        const hasValidAriaLabel = hasAriaLabelAttr && ariaLabel.length > 0;
-        const hasValidAriaLabelledbyAttr = hasAriaLabelledbyAttr && ariaLabelledby.length > 0;
-
-        // Last-resort naming mechanism per HTML-AAM (also accepted by
-        // a widely-used reference engine's role-img-alt): a non-empty title attribute.
-        const titleRaw = (() => { try { return el.getAttribute('title'); } catch { return null; } })();
-        const hasValidTitle = titleRaw !== null && trim(titleRaw).length > 0;
-
-        let nameInfo = null;
-
-        // Fast outcomes first (no helper needed)
-        let reasonCode = '';
-        let hasName = false;
-
-        if (!hasAriaLabelAttr && !hasAriaLabelledbyAttr) {
-            if (hasValidTitle) {
-                hasName = true;
-            } else {
-                reasonCode = 'missingTextAlternative';
-            }
-        } else if (hasAriaLabelAttr && !hasValidAriaLabel) {
-            if (hasValidTitle) {
-                hasName = true;
-            } else {
-                reasonCode = 'emptyAriaLabel';
-            }
-        } else if (hasAriaLabelledbyAttr && !hasValidAriaLabelledbyAttr) {
-            if (hasValidTitle) {
-                hasName = true;
-            } else {
-                reasonCode = 'emptyAriaLabelledby';
-            }
-        } else {
-            // Mechanism present + non-empty. Optionally validate resolution via helper.
-            if (getAccessibleNameInfo) {
-                nameInfo = (() => { try { return getAccessibleNameInfo(el, ctx); } catch { return null; } })();
-                const helperSaysHasName = !!(nameInfo && nameInfo.present && trim(nameInfo.value));
-                if (helperSaysHasName) {
-                    hasName = true;
-                } else {
-                    reasonCode = 'nameNotResolved';
-                }
-            } else {
-                // Without helper, accept non-empty aria-label/labelledby as sufficient.
-                hasName = true;
-            }
+    // Applicability: eligible in the acc tree (with helper exceptions).
+    if (isAccTreeEligible) {
+      const elig = (() => {
+        try {
+          return isAccTreeEligible(el, ctx);
+        } catch {
+          return { eligible: true, reasons: [] };
         }
+      })();
+      if (elig && elig.eligible === false) continue;
+    }
 
-        if (hasName) continue;
-
-
-        const eligInfo = getEligibilityInfo ? getEligibilityInfo(el, ctx, { targetSet: 'acc' }) : null;
-
-        const baseOccurrence = {
-            summary: 'Missing text alternative on element with role="img".',
-            hint: 'Provide aria-label or aria-labelledby (referencing non-empty text) to give this image a text alternative.',
-            i18n: {
-                summaryKey: 'roleImg_textAlternativePresent_summary_fail',
-                hintKey: 'roleImg_textAlternativePresent_hint_fail',
-                params: { role: 'img' }
-            },
-            data: {
-                details: {
-                    reasonCode,
-                    ariaLabel: ariaLabelRaw === null ? null : ariaLabel,
-                    ariaLabelledby: ariaLabelledbyRaw === null ? null : ariaLabelledby,
-                    accessibleNameInfo: nameInfo || null
-                },
-                visibilityFilter: eligInfo || { targetSet: 'acc', accEligible: null, reasons: [] }
-            }
-        };
+    applicableCount += 1;
+
+    // Expectation: aria-label OR aria-labelledby. We use helper name-info when available,
+    // but we also validate the source to keep this rule scoped/deterministic.
+
+    const ariaLabelRaw = (() => {
+      try {
+        return el.getAttribute('aria-label');
+      } catch {
+        return null;
+      }
+    })();
+    const ariaLabel = trim(ariaLabelRaw);
+
+    const ariaLabelledbyRaw = (() => {
+      try {
+        return el.getAttribute('aria-labelledby');
+      } catch {
+        return null;
+      }
+    })();
+    const ariaLabelledby = trim(ariaLabelledbyRaw);
+
+    const hasAriaLabelAttr = ariaLabelRaw !== null;
+    const hasAriaLabelledbyAttr = ariaLabelledbyRaw !== null;
 
-        if (helpers && typeof helpers.reportOccurrence === 'function') {
-            occurrences.push(helpers.reportOccurrence(el, baseOccurrence));
+    const hasValidAriaLabel = hasAriaLabelAttr && ariaLabel.length > 0;
+    const hasValidAriaLabelledbyAttr = hasAriaLabelledbyAttr && ariaLabelledby.length > 0;
+
+    // Last-resort naming mechanism per HTML-AAM: a non-empty title attribute.
+    const titleRaw = (() => {
+      try {
+        return el.getAttribute('title');
+      } catch {
+        return null;
+      }
+    })();
+    const hasValidTitle = titleRaw !== null && trim(titleRaw).length > 0;
+
+    let nameInfo = null;
+
+    // Fast outcomes first (no helper needed)
+    let reasonCode = '';
+    let hasName = false;
+
+    if (!hasAriaLabelAttr && !hasAriaLabelledbyAttr) {
+      if (hasValidTitle) {
+        hasName = true;
+      } else {
+        reasonCode = 'missingTextAlternative';
+      }
+    } else if (hasAriaLabelAttr && !hasValidAriaLabel) {
+      if (hasValidTitle) {
+        hasName = true;
+      } else {
+        reasonCode = 'emptyAriaLabel';
+      }
+    } else if (hasAriaLabelledbyAttr && !hasValidAriaLabelledbyAttr) {
+      if (hasValidTitle) {
+        hasName = true;
+      } else {
+        reasonCode = 'emptyAriaLabelledby';
+      }
+    } else {
+      // Mechanism present + non-empty. Optionally validate resolution via helper.
+      if (getAccessibleNameInfo) {
+        nameInfo = (() => {
+          try {
+            return getAccessibleNameInfo(el, ctx);
+          } catch {
+            return null;
+          }
+        })();
+        const helperSaysHasName = !!(nameInfo && nameInfo.present && trim(nameInfo.value));
+        if (helperSaysHasName) {
+          hasName = true;
         } else {
-            occurrences.push({ selector: '', html: '', ...baseOccurrence });
+          reasonCode = 'nameNotResolved';
         }
+      } else {
+        // Without helper, accept non-empty aria-label/labelledby as sufficient.
+        hasName = true;
+      }
     }
 
-    if (applicableCount === 0) {
-        return { ruleId: rule.ruleId, outcome: 'notApplicable', severity: 'minor', occurrences: [] };
-    }
+    if (hasName) continue;
+
+    const eligInfo = getEligibilityInfo ? getEligibilityInfo(el, ctx, { targetSet: 'acc' }) : null;
+
+    const baseOccurrence = {
+      summary: 'Missing text alternative on element with role="img".',
+      hint: 'Provide aria-label or aria-labelledby (referencing non-empty text) to give this image a text alternative.',
+      i18n: {
+        summaryKey: 'roleImg_textAlternativePresent_summary_fail',
+        hintKey: 'roleImg_textAlternativePresent_hint_fail',
+        params: { role: 'img' }
+      },
+      data: {
+        details: {
+          reasonCode,
+          ariaLabel: ariaLabelRaw === null ? null : ariaLabel,
+          ariaLabelledby: ariaLabelledbyRaw === null ? null : ariaLabelledby,
+          accessibleNameInfo: nameInfo || null
+        },
+        visibilityFilter: eligInfo || { targetSet: 'acc', accEligible: null, reasons: [] }
+      }
+    };
 
-    if (!occurrences.length) {
-        return { ruleId: rule.ruleId, outcome: 'pass', severity: 'minor', occurrences: [] };
+    if (helpers && typeof helpers.reportOccurrence === 'function') {
+      occurrences.push(helpers.reportOccurrence(el, baseOccurrence));
+    } else {
+      occurrences.push({ selector: '', html: '', ...baseOccurrence });
     }
-
-    return { ruleId: rule.ruleId, outcome: 'fail', severity: rule.defaultSeverity || 'minor', occurrences };
+  }
+
+  if (applicableCount === 0) {
+    return { ruleId: rule.ruleId, outcome: 'notApplicable', severity: 'minor', occurrences: [] };
+  }
+
+  if (!occurrences.length) {
+    return { ruleId: rule.ruleId, outcome: 'pass', severity: 'minor', occurrences: [] };
+  }
+
+  return {
+    ruleId: rule.ruleId,
+    outcome: 'fail',
+    severity: rule.defaultSeverity || 'minor',
+    occurrences
+  };
 }
 
 module.exports = { id, meta, runInPage };