@surea11y/core 1.2.0 → 1.4.0

package/src/checks/manual/object-text-alternative-quality-manual.js

@@ -1,3 +1,5 @@
+/* SPDX-License-Identifier: MPL-2.0 */
+
 'use strict';
 
 /**
@@ -11,184 +13,205 @@
  *   Human review is required to confirm that the provided text alternative is accurate and appropriate.
  */
 
-const id = "object-text-alternative-quality";
+const id = 'object-text-alternative-quality';
 
 const meta = {
-    title: "<object> text alternative must be appropriate (manual review)",
-    description: "Flags <object> elements with detected fallback or name for human review of equivalence and appropriateness.",
-    i18n: {
-        titleKey: "object_textAltQuality_title",
-        descriptionKey: "object_textAltQuality_description"
-    },
-    helpUrl: null,
-    tags: ["wcag2a", "wcag111", "nontext", "object", "manual", "atomic"],
-    wcagSc: ['1.1.1'],
-    normativeMappings: [
-        {standard: 'WCAG', version: '2.2', requirement: '1.1.1', title: 'Non-text Content', conformanceLevel: 'A'}
-    ],
-    defaultSeverity: 'minor',
-    category: 'perceivable',
-    type: 'manual',
-    defaultConfidence: 'medium',
-    coverage: {
-        facetsBySc: {
-            '1.1.1': ['text-alternative-quality']
-        }
+  title: '<object> text alternative must be appropriate (manual review)',
+  description:
+    'Flags <object> elements with detected fallback or name for human review of equivalence and appropriateness.',
+  i18n: {
+    titleKey: 'object_textAltQuality_title',
+    descriptionKey: 'object_textAltQuality_description'
+  },
+  helpUrl: null,
+  tags: ['wcag2a', 'wcag111', 'nontext', 'object', 'manual', 'atomic'],
+  wcagSc: ['1.1.1'],
+  normativeMappings: [
+    {
+      standard: 'WCAG',
+      version: '2.2',
+      requirement: '1.1.1',
+      title: 'Non-text Content',
+      conformanceLevel: 'A'
+    }
+  ],
+  defaultSeverity: 'minor',
+  category: 'perceivable',
+  type: 'manual',
+  defaultConfidence: 'medium',
+  coverage: {
+    facetsBySc: {
+      '1.1.1': ['text-alternative-quality']
     }
+  }
 };
 
 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 getEligibilityInfo = helpers && typeof helpers.getEligibilityInfo === 'function'
-        ? helpers.getEligibilityInfo
-        : null;
-
-    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()));
-        }
-        return !focusable;
-    }
+  const getEligibilityInfo =
+    helpers && typeof helpers.getEligibilityInfo === 'function' ? helpers.getEligibilityInfo : null;
 
+  const isAccTreeEligible =
+    helpers && typeof helpers.isAccTreeEligible === 'function' ? helpers.isAccTreeEligible : null;
 
-    const els = (() => {
+  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 Array.from((queryAllSmart ? queryAllSmart('object') : queryAll('object')) || []);
+          return getFocusableInfo(el, ctx);
         } catch {
-            return queryAll('object');
+          return null;
         }
-    })();
-
-    if (!els.length) {
-        return {ruleId: rule.ruleId, outcome: 'notApplicable', severity: 'minor', occurrences: []};
+      })();
+      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 = (() => {
+    try {
+      return Array.from((queryAllSmart ? queryAllSmart('object') : queryAll('object')) || []);
+    } catch {
+      return queryAll('object');
+    }
+  })();
 
-    const occurrences = [];
-    let applicableCount = 0;
-
-    for (const el of els) {
-        if (!el || !el.getAttribute) continue;
-
-        if (isAccTreeEligible) {
-            const elig = (() => {
-                try {
-                    return isAccTreeEligible(el, ctx);
-                } catch {
-                    return {eligible: true, reasons: []};
-                }
-            })();
-            if (elig && elig.eligible === false) continue;
-        }
-
-        if (isRolePresentationExcluded(el)) continue;
+  if (!els.length) {
+    return { ruleId: rule.ruleId, outcome: 'notApplicable', severity: 'minor', occurrences: [] };
+  }
 
-        const trim = (v) => (v == null ? '' : String(v)).trim();
+  const occurrences = [];
+  let applicableCount = 0;
 
-        let fallbackText = '';
-        let ariaLabel = '';
-        let ariaLabelledBy = '';
-        let title = '';
-        let labelledByText = '';
+  for (const el of els) {
+    if (!el || !el.getAttribute) continue;
 
+    if (isAccTreeEligible) {
+      const elig = (() => {
         try {
-            fallbackText = trim(el.textContent || '');
-            ariaLabel = trim(el.getAttribute('aria-label'));
-            ariaLabelledBy = trim(el.getAttribute('aria-labelledby'));
-            title = trim(el.getAttribute('title'));
-        } catch {}
-
-// Only resolve idrefs if needed/present
-        if (!ariaLabel && ariaLabelledBy && helpers && typeof helpers.getTextFromIdRefs === 'function') {
-            try {
-                const t = helpers.getTextFromIdRefs(ariaLabelledBy, ctx);
-                labelledByText = trim(t && t.text);
-            } catch {}
+          return isAccTreeEligible(el, ctx);
+        } catch {
+          return { eligible: true, reasons: [] };
         }
+      })();
+      if (elig && elig.eligible === false) continue;
+    }
 
-        const details = {
-            fallbackText: fallbackText || null,
-            ariaLabel: ariaLabel || null,
-            ariaLabelledBy: ariaLabelledBy || null,
-            ariaLabelledByText: labelledByText || null,
-            title: title || null
-        };
-
-        const hasMechanism = !!(details.fallbackText || details.ariaLabel || details.ariaLabelledByText || details.title);
-        if (!hasMechanism) continue;
-
-        applicableCount += 1;
-
-        const eligInfo = getEligibilityInfo ? getEligibilityInfo(el, ctx, { targetSet: 'acc' }) : null;
-
-        const baseOccurrence = {
-            summary: 'Review text alternative for <object> for equivalence and appropriateness.',
-            hint: 'Confirm the fallback content or ARIA name provides an equivalent alternative for the embedded content.',
-            i18n: {
-                summaryKey: 'object_textAltQuality_summary_cantTell',
-                hintKey: 'object_textAltQuality_hint_cantTell',
-                params: { element: 'object' }
-            },
-            data: {
-                visibilityFilter: eligInfo || { targetSet: 'acc', accEligible: null, reasons: [] },
-                details
-            }
-        };
-
-        if (helpers && typeof helpers.reportOccurrence === 'function') {
-            occurrences.push(helpers.reportOccurrence(el, baseOccurrence));
-        } else {
-            occurrences.push({ selector: '', html: '', ...baseOccurrence });
-        }
+    if (isRolePresentationExcluded(el)) continue;
+
+    const trim = (v) => (v == null ? '' : String(v)).trim();
+
+    let fallbackText = '';
+    let ariaLabel = '';
+    let ariaLabelledBy = '';
+    let title = '';
+    let labelledByText = '';
+
+    try {
+      fallbackText = trim(el.textContent || '');
+      ariaLabel = trim(el.getAttribute('aria-label'));
+      ariaLabelledBy = trim(el.getAttribute('aria-labelledby'));
+      title = trim(el.getAttribute('title'));
+    } catch {}
+
+    // Only resolve idrefs if needed/present
+    if (
+      !ariaLabel &&
+      ariaLabelledBy &&
+      helpers &&
+      typeof helpers.getTextFromIdRefs === 'function'
+    ) {
+      try {
+        const t = helpers.getTextFromIdRefs(ariaLabelledBy, ctx);
+        labelledByText = trim(t && t.text);
+      } catch {}
     }
 
-    if (applicableCount === 0) {
-        return {ruleId: rule.ruleId, outcome: 'notApplicable', severity: 'minor', occurrences: []};
+    const details = {
+      fallbackText: fallbackText || null,
+      ariaLabel: ariaLabel || null,
+      ariaLabelledBy: ariaLabelledBy || null,
+      ariaLabelledByText: labelledByText || null,
+      title: title || null
+    };
+
+    const hasMechanism = !!(
+      details.fallbackText ||
+      details.ariaLabel ||
+      details.ariaLabelledByText ||
+      details.title
+    );
+    if (!hasMechanism) continue;
+
+    applicableCount += 1;
+
+    const eligInfo = getEligibilityInfo ? getEligibilityInfo(el, ctx, { targetSet: 'acc' }) : null;
+
+    const baseOccurrence = {
+      summary: 'Review text alternative for <object> for equivalence and appropriateness.',
+      hint: 'Confirm the fallback content or ARIA name provides an equivalent alternative for the embedded content.',
+      i18n: {
+        summaryKey: 'object_textAltQuality_summary_cantTell',
+        hintKey: 'object_textAltQuality_hint_cantTell',
+        params: { element: 'object' }
+      },
+      data: {
+        visibilityFilter: eligInfo || { targetSet: 'acc', accEligible: null, reasons: [] },
+        details
+      }
+    };
+
+    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};
+module.exports = { id, meta, runInPage };

package/src/checks/manual/p-as-heading-manual.js

@@ -1,3 +1,5 @@
+/* SPDX-License-Identifier: MPL-2.0 */
+
 'use strict';
 
 /**
@@ -34,7 +36,8 @@ const id = 'p-as-heading';
 
 const meta = {
   title: 'A <p> styled to look like a heading should probably be a real heading',
-  description: 'Flags short <p> elements whose entire text is bold and rendered at >=18px, for manual review of whether a real heading element should be used instead.',
+  description:
+    'Flags short <p> elements whose entire text is bold and rendered at >=18px, for manual review of whether a real heading element should be used instead.',
   i18n: {
     titleKey: 'pAsHeading_title',
     descriptionKey: 'pAsHeading_description'
@@ -43,7 +46,13 @@ const meta = {
   tags: ['wcag2a', 'wcag131', 'structure', 'atomic', 'manual'],
   wcagSc: ['1.3.1'],
   normativeMappings: [
-    { standard: 'WCAG', version: '2.2', requirement: '1.3.1', title: 'Info and Relationships', conformanceLevel: 'A' }
+    {
+      standard: 'WCAG',
+      version: '2.2',
+      requirement: '1.3.1',
+      title: 'Info and Relationships',
+      conformanceLevel: 'A'
+    }
   ],
   defaultSeverity: 'minor',
   category: 'perceivable',
@@ -53,12 +62,14 @@ const meta = {
 };
 
 function runInPage(ctx) {
-  const { document, helpers, rule } = ctx;
+  const { helpers, rule } = ctx;
 
   const MAX_HEADING_LIKE_CHARS = 120;
   const MIN_FONT_SIZE_PX = 18;
 
-  function trim(v) { return (v == null ? '' : String(v)).trim(); }
+  function trim(v) {
+    return (v == null ? '' : String(v)).trim();
+  }
 
   function safeComputedStyle(el) {
     try {
@@ -67,7 +78,8 @@ function runInPage(ctx) {
         const cs = helpers.computedStyle(el);
         if (cs) return cs;
       }
-      const view = (el.ownerDocument && el.ownerDocument.defaultView) ? el.ownerDocument.defaultView : null;
+      const view =
+        el.ownerDocument && el.ownerDocument.defaultView ? el.ownerDocument.defaultView : null;
       if (view && typeof view.getComputedStyle === 'function') return view.getComputedStyle(el);
     } catch {}
     return null;
@@ -124,7 +136,7 @@ function runInPage(ctx) {
     if (fontSizePx < MIN_FONT_SIZE_PX) 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 || '';
 
     const baseOccurrence = {
       selector: stableSelector,
@@ -153,7 +165,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
+    };
   }
 
   return { ruleId: rule.ruleId, outcome: 'notApplicable', severity: 'minor', occurrences: [] };

package/src/checks/manual/page-has-heading-one-manual.js

@@ -1,10 +1,12 @@
+/* SPDX-License-Identifier: MPL-2.0 */
+
 'use strict';
 
 /**
  * @check page-has-heading-one
  * @atomic true
  * @summary The page should have at least one level-one heading
- * @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
  *   Always applicable to any HTML document with a <body> element —
  *   "does the page have an h1" is a whole-page concern, matching
@@ -21,23 +23,23 @@
  *   header comment for the shared rationale/precedent.
  * - Filters candidates through `isAccTreeEligible` (hidden/aria-hidden/
  *   display:none/inert elements don't count as "the page has a heading
- *   one"), matching `landmark-one-main`'s own precedent. Found via a real
- *   page (CDC's flu page, 2026-07-30): its only `<h1>` sits inside a
- *   `display:none` ancestor — genuinely unreachable by sighted and screen
- *   reader users alike — and a raw `document.querySelectorAll` credited it
- *   anyway, reporting `notApplicable` where axe-core correctly fails. This
- *   does NOT regress purely-visually-clipped-but-AT-exposed headings (e.g.
- *   eBay's homepage `<h1>` hidden via clip-path/off-screen positioning,
- *   `visibility:visible`, no `aria-hidden`) — `isAccTreeEligible` only
- *   excludes elements actually removed from the accessibility tree, not
- *   ones merely clipped from the visual viewport.
+ *   one"), matching `landmark-one-main`'s own precedent — a raw
+ *   `document.querySelectorAll` would wrongly credit an `<h1>` that sits
+ *   inside a `display:none` ancestor, genuinely unreachable by sighted and
+ *   screen reader users alike, as satisfying this check. This does NOT
+ *   regress purely-visually-clipped-but-AT-exposed headings (e.g. an `<h1>`
+ *   hidden via clip-path/off-screen positioning, `visibility:visible`, no
+ *   `aria-hidden`) — `isAccTreeEligible` only excludes elements actually
+ *   removed from the accessibility tree, not ones merely clipped from the
+ *   visual viewport.
  */
 
 const id = 'page-has-heading-one';
 
 const meta = {
   title: 'Page should have a level-one heading',
-  description: 'Checks that the page has at least one level-one heading (<h1> or role="heading" with aria-level="1").',
+  description:
+    'Checks that the page has at least one level-one heading (<h1> or role="heading" with aria-level="1").',
   i18n: {
     titleKey: 'pageHasHeadingOne_title',
     descriptionKey: 'pageHasHeadingOne_description'
@@ -70,7 +72,9 @@ function runInPage(ctx) {
   }
 
   function normalizeWs(s) {
-    return String(s || '').replace(/\s+/g, ' ').trim();
+    return String(s || '')
+      .replace(/\s+/g, ' ')
+      .trim();
   }
 
   function getExplicitRoleToken(el) {
@@ -90,7 +94,8 @@ function runInPage(ctx) {
     return tag === 'h1';
   }
 
-  const isAccTreeEligible = helpers && typeof helpers.isAccTreeEligible === 'function' ? helpers.isAccTreeEligible : null;
+  const isAccTreeEligible =
+    helpers && typeof helpers.isAccTreeEligible === 'function' ? helpers.isAccTreeEligible : null;
 
   function isExposedToAt(el) {
     if (!isAccTreeEligible) return true;
@@ -105,11 +110,12 @@ function runInPage(ctx) {
 
   // queryAllSmart (shadow-DOM-aware) instead of plain document.querySelectorAll -- see
   // landmark-one-main-manual.js's identical precedent.
-  let nodes = [];
+  let nodes;
   try {
-    nodes = helpers && typeof helpers.queryAllSmart === 'function'
-      ? helpers.queryAllSmart('h1, [role]')
-      : document.querySelectorAll('h1, [role]');
+    nodes =
+      helpers && typeof helpers.queryAllSmart === 'function'
+        ? helpers.queryAllSmart('h1, [role]')
+        : document.querySelectorAll('h1, [role]');
   } catch {
     nodes = [];
   }
@@ -121,26 +127,30 @@ function runInPage(ctx) {
   }
 
   const stableSelector = helpers.buildSelector ? helpers.buildSelector(body) : 'body';
-  const html = helpers.getOuterHtmlSnippet ? helpers.getOuterHtmlSnippet(body) : (body.outerHTML || '').slice(0, 200);
+  const html = helpers.getOuterHtmlSnippet
+    ? helpers.getOuterHtmlSnippet(body)
+    : (body.outerHTML || '').slice(0, 200);
 
   return {
     ruleId: rule.ruleId,
     outcome: 'cantTell',
     severity: rule.defaultSeverity || 'minor',
-    occurrences: [{
-      selector: stableSelector,
-      html,
-      summary: 'This page has no level-one heading.',
-      hint: 'Add a level-one heading (<h1> or role="heading" aria-level="1") that identifies the page\'s main content.',
-      i18n: {
-        summaryKey: 'pageHasHeadingOne_summary_cantTell',
-        hintKey: 'pageHasHeadingOne_hint_cantTell',
-        params: {}
-      },
-      data: {
-        details: { reasonCode: 'HEADING_ONE_MISSING' }
+    occurrences: [
+      {
+        selector: stableSelector,
+        html,
+        summary: 'This page has no level-one heading.',
+        hint: 'Add a level-one heading (<h1> or role="heading" aria-level="1") that identifies the page\'s main content.',
+        i18n: {
+          summaryKey: 'pageHasHeadingOne_summary_cantTell',
+          hintKey: 'pageHasHeadingOne_hint_cantTell',
+          params: {}
+        },
+        data: {
+          details: { reasonCode: 'HEADING_ONE_MISSING' }
+        }
       }
-    }]
+    ]
   };
 }