@surea11y/core 1.2.0 → 1.4.0

package/src/checks/automatic/autocomplete-valid.js

@@ -1,3 +1,5 @@
+/* SPDX-License-Identifier: MPL-2.0 */
+
 'use strict';
 
 /**
@@ -33,7 +35,8 @@ const id = 'autocomplete-valid';
 
 const meta = {
   title: 'autocomplete attribute must be a valid autofill value',
-  description: 'Checks that a non-empty autocomplete attribute is "on"/"off" or a well-formed autofill detail token list.',
+  description:
+    'Checks that a non-empty autocomplete attribute is "on"/"off" or a well-formed autofill detail token list.',
   i18n: {
     titleKey: 'autocompleteValid_title',
     descriptionKey: 'autocompleteValid_description'
@@ -42,7 +45,13 @@ const meta = {
   tags: ['wcag21aa', 'wcag135', 'forms', 'atomic', 'automatic'],
   wcagSc: ['1.3.5'],
   normativeMappings: [
-    { standard: 'WCAG', version: '2.2', requirement: '1.3.5', title: 'Identify Input Purpose', conformanceLevel: 'AA' }
+    {
+      standard: 'WCAG',
+      version: '2.2',
+      requirement: '1.3.5',
+      title: 'Identify Input Purpose',
+      conformanceLevel: 'AA'
+    }
   ],
   defaultSeverity: 'moderate',
   category: 'perceivable',
@@ -52,20 +61,63 @@ const meta = {
 };
 
 function runInPage(ctx) {
-  const { document, helpers, rule } = ctx;
+  const { helpers, rule } = ctx;
 
   // Declared inside runInPage — see scripts/build-core.js header
   // ("runInPage MUST be self-contained").
   const FIELD_NAMES = new Set([
-    'name', 'honorific-prefix', 'given-name', 'additional-name', 'family-name', 'honorific-suffix',
-    'nickname', 'username', 'new-password', 'current-password', 'one-time-code', 'organization-title',
-    'organization', 'street-address', 'address-line1', 'address-line2', 'address-line3',
-    'address-level4', 'address-level3', 'address-level2', 'address-level1', 'country', 'country-name',
-    'postal-code', 'cc-name', 'cc-given-name', 'cc-additional-name', 'cc-family-name', 'cc-number',
-    'cc-exp', 'cc-exp-month', 'cc-exp-year', 'cc-csc', 'cc-type', 'transaction-currency',
-    'transaction-amount', 'language', 'bday', 'bday-day', 'bday-month', 'bday-year', 'sex',
-    'tel', 'tel-country-code', 'tel-national', 'tel-area-code', 'tel-local', 'tel-extension',
-    'email', 'impp', 'url', 'photo'
+    'name',
+    'honorific-prefix',
+    'given-name',
+    'additional-name',
+    'family-name',
+    'honorific-suffix',
+    'nickname',
+    'username',
+    'new-password',
+    'current-password',
+    'one-time-code',
+    'organization-title',
+    'organization',
+    'street-address',
+    'address-line1',
+    'address-line2',
+    'address-line3',
+    'address-level4',
+    'address-level3',
+    'address-level2',
+    'address-level1',
+    'country',
+    'country-name',
+    'postal-code',
+    'cc-name',
+    'cc-given-name',
+    'cc-additional-name',
+    'cc-family-name',
+    'cc-number',
+    'cc-exp',
+    'cc-exp-month',
+    'cc-exp-year',
+    'cc-csc',
+    'cc-type',
+    'transaction-currency',
+    'transaction-amount',
+    'language',
+    'bday',
+    'bday-day',
+    'bday-month',
+    'bday-year',
+    'sex',
+    'tel',
+    'tel-country-code',
+    'tel-national',
+    'tel-area-code',
+    'tel-local',
+    'tel-extension',
+    'email',
+    'impp',
+    'url',
+    'photo'
   ]);
   const CONTACT_MODALITY = new Set(['home', 'work', 'mobile', 'fax', 'pager', 'impp']);
 
@@ -75,7 +127,8 @@ function runInPage(ctx) {
     if (tokens.length === 1 && (tokens[0] === 'on' || tokens[0] === 'off')) return true;
 
     let i = 0;
-    if (tokens[i] && tokens[i].startsWith('section-') && tokens[i].length > 'section-'.length) i += 1;
+    if (tokens[i] && tokens[i].startsWith('section-') && tokens[i].length > 'section-'.length)
+      i += 1;
     if (tokens[i] === 'shipping' || tokens[i] === 'billing') i += 1;
     if (CONTACT_MODALITY.has(tokens[i])) i += 1;
 
@@ -87,7 +140,9 @@ function runInPage(ctx) {
     return FIELD_NAMES.has(remaining[0]);
   }
 
-  const nodes = helpers.queryAllSmart ? helpers.queryAllSmart('input, select, textarea') : helpers.queryAll('input, select, textarea');
+  const nodes = helpers.queryAllSmart
+    ? helpers.queryAllSmart('input, select, textarea')
+    : helpers.queryAll('input, select, textarea');
 
   const occurrences = [];
   let applicableCount = 0;
@@ -103,7 +158,7 @@ function runInPage(ctx) {
 
     const tag = el.tagName.toLowerCase();
     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,
@@ -125,7 +180,12 @@ function runInPage(ctx) {
     return { ruleId: rule.ruleId, outcome: 'notApplicable', severity: 'minor', occurrences: [] };
   }
   if (occurrences.length) {
-    return { ruleId: rule.ruleId, outcome: 'fail', severity: rule.defaultSeverity || 'moderate', occurrences };
+    return {
+      ruleId: rule.ruleId,
+      outcome: 'fail',
+      severity: rule.defaultSeverity || 'moderate',
+      occurrences
+    };
   }
   return { ruleId: rule.ruleId, outcome: 'pass', severity: 'minor', occurrences: [] };
 }

package/src/checks/automatic/avoid-inline-spacing.js

@@ -1,3 +1,5 @@
+/* SPDX-License-Identifier: MPL-2.0 */
+
 'use strict';
 
 /**
@@ -19,15 +21,15 @@
  * @implementation-notes
  * - Static text-based parsing of the style attribute string (regex for
  *   the three property names followed by `!important`), not computed
- *   style — matches the property list a widely-used reference engine's avoid-inline-spacing
- *   rule checks.
+ *   style.
  */
 
 const id = 'avoid-inline-spacing';
 
 const meta = {
   title: 'Inline style must not force text spacing with !important',
-  description: 'Checks that inline style does not set line-height, letter-spacing, or word-spacing with !important, which blocks user text-spacing overrides.',
+  description:
+    'Checks that inline style does not set line-height, letter-spacing, or word-spacing with !important, which blocks user text-spacing overrides.',
   i18n: {
     titleKey: 'avoidInlineSpacing_title',
     descriptionKey: 'avoidInlineSpacing_description'
@@ -36,7 +38,13 @@ const meta = {
   tags: ['wcag21aa', 'wcag1412', 'structure', 'atomic', 'automatic'],
   wcagSc: ['1.4.12'],
   normativeMappings: [
-    { standard: 'WCAG', version: '2.2', requirement: '1.4.12', title: 'Text Spacing', conformanceLevel: 'AA' }
+    {
+      standard: 'WCAG',
+      version: '2.2',
+      requirement: '1.4.12',
+      title: 'Text Spacing',
+      conformanceLevel: 'AA'
+    }
   ],
   defaultSeverity: 'moderate',
   category: 'perceivable',
@@ -46,11 +54,13 @@ const meta = {
 };
 
 function runInPage(ctx) {
-  const { document, helpers, rule } = ctx;
+  const { helpers, rule } = ctx;
 
   const SPACING_PROPS = ['line-height', 'letter-spacing', 'word-spacing'];
 
-  const nodes = helpers.queryAllSmart ? helpers.queryAllSmart('[style]') : helpers.queryAll('[style]');
+  const nodes = helpers.queryAllSmart
+    ? helpers.queryAllSmart('[style]')
+    : helpers.queryAll('[style]');
 
   const occurrences = [];
   let applicableCount = 0;
@@ -76,7 +86,7 @@ function runInPage(ctx) {
 
     const tag = el.tagName.toLowerCase();
     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,
@@ -98,7 +108,12 @@ function runInPage(ctx) {
     return { ruleId: rule.ruleId, outcome: 'notApplicable', severity: 'minor', occurrences: [] };
   }
   if (occurrences.length) {
-    return { ruleId: rule.ruleId, outcome: 'fail', severity: rule.defaultSeverity || 'moderate', occurrences };
+    return {
+      ruleId: rule.ruleId,
+      outcome: 'fail',
+      severity: rule.defaultSeverity || 'moderate',
+      occurrences
+    };
   }
   return { ruleId: rule.ruleId, outcome: 'pass', severity: 'minor', occurrences: [] };
 }

package/src/checks/automatic/binary-control-name-present.js

@@ -1,61 +1,66 @@
+/* SPDX-License-Identifier: MPL-2.0 */
+
 'use strict';
 
 const id = 'binary-control-name-present';
 
 const meta = {
   title: 'Binary controls have an accessible name',
-  description: 'Checks that checkbox, radio, and switch controls expose a non-empty accessible name.',
+  description:
+    'Checks that checkbox, radio, and switch controls expose a non-empty accessible name.',
   i18n: {
     titleKey: 'binaryControlNamePresent_title',
     descriptionKey: 'binaryControlNamePresent_description'
   },
   helpUrl: null,
-  tags: ['wcag2a','wcag412','forms','atomic','automatic','name','checkbox','radio','switch'],
+  tags: [
+    'wcag2a',
+    'wcag412',
+    'forms',
+    'atomic',
+    'automatic',
+    'name',
+    'checkbox',
+    'radio',
+    'switch'
+  ],
   wcagSc: ['4.1.2'],
   normativeMappings: [
-    { standard: 'WCAG', version: '2.2', requirement: '4.1.2', title: 'Name, Role, Value', conformanceLevel: 'A' }
+    {
+      standard: 'WCAG',
+      version: '2.2',
+      requirement: '4.1.2',
+      title: 'Name, Role, Value',
+      conformanceLevel: 'A'
+    }
   ],
   defaultSeverity: 'serious',
   category: 'robust',
   type: 'automatic',
   defaultConfidence: 'high',
-  coverage: { facetsBySc: { '4.1.2': ['checkbox-name-present','radio-name-present','switch-name-present'] } }
+  coverage: {
+    facetsBySc: { '4.1.2': ['checkbox-name-present', 'radio-name-present', 'switch-name-present'] }
+  }
 };
 
 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 hasAttr(el, name) {
-    try { return !!(el && el.hasAttribute && el.hasAttribute(name)); } catch { return false; }
-  }
-
-  function isExplicitProgrammatic(el) {
-    // Programmatic name mechanisms we treat as authoritative (presence-only):
-    // - aria-label (non-empty)
-    // - aria-labelledby (non-empty)
-    // - title (non-empty) [weak but allowed for presence]
-    const al = getAttr(el, 'aria-label');
-    if (al) return true;
-    const alb = getAttr(el, 'aria-labelledby');
-    if (alb) return true;
-    const t = getAttr(el, 'title');
-    if (t) return true;
-    return false;
+    } catch {
+      return '';
+    }
   }
 
   function buildLabelForMap(doc) {
@@ -85,7 +90,7 @@ function runInPage(ctx) {
       const info = helpers.getContentNameInfo(container, ctx);
       return info && info.present ? info.value : '';
     }
-    const t = (container && container.textContent) ? String(container.textContent) : '';
+    const t = container && container.textContent ? String(container.textContent) : '';
     return t.replace(/\s+/g, ' ').trim();
   }
 
@@ -132,17 +137,9 @@ function runInPage(ctx) {
     return '';
   }
 
-  function getInputValueName(el) {
-    try {
-      const type = getAttr(el, 'type').toLowerCase();
-      if (type !== 'button' && type !== 'submit' && type !== 'reset') return '';
-      const v = getAttr(el, 'value');
-      return v;
-    } catch { return ''; }
-  }
-
   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);
@@ -153,13 +150,14 @@ function runInPage(ctx) {
     }
   }
 
-
   const occurrences = [];
   let applicableCount = 0;
 
-  const selector = 'input[type="checkbox"], input[type="radio"], [role="checkbox"], [role="radio"], [role="switch"]';
-  const nodes = helpers.queryAllSmart ? helpers.queryAllSmart(selector) : helpers.queryAll(selector);
-
+  const selector =
+    'input[type="checkbox"], input[type="radio"], [role="checkbox"], [role="radio"], [role="switch"]';
+  const nodes = helpers.queryAllSmart
+    ? helpers.queryAllSmart(selector)
+    : helpers.queryAll(selector);
 
   // Precompute label[for] associations once for speed/determinism.
   const labelForMap = buildLabelForMap(document);
@@ -223,7 +221,11 @@ function runInPage(ctx) {
     }
 
     // ARIA roles (checkbox/radio/switch) can use content as name
-    if (controlType === 'switch' || controlType === 'aria-checkbox' || controlType === 'aria-radio') {
+    if (
+      controlType === 'switch' ||
+      controlType === 'aria-checkbox' ||
+      controlType === 'aria-radio'
+    ) {
       const t = getConservativeSubtreeText(document, el);
       if (t) return { ok: true, method: 'content' };
     }
@@ -240,7 +242,7 @@ function runInPage(ctx) {
     const type = getAttr(el, 'type').toLowerCase();
     const role = getAttr(el, 'role').toLowerCase();
 
-    let controlType = '';
+    let controlType;
     if (tag === 'input' && type === 'checkbox') controlType = 'checkbox';
     else if (tag === 'input' && type === 'radio') controlType = 'radio';
     else if (role === 'checkbox') controlType = 'aria-checkbox';
@@ -254,10 +256,16 @@ 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,
@@ -280,12 +288,16 @@ function runInPage(ctx) {
     });
   }
 
-
   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: [] };
 }

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

@@ -1,3 +1,5 @@
+/* SPDX-License-Identifier: MPL-2.0 */
+
 'use strict';
 
 // NOTE: Repo ruleId contract requires ENGINE_TAG prefix in the rule id.
@@ -15,7 +17,13 @@ const meta = {
   tags: ['wcag2a', 'wcag412', 'forms', 'atomic', 'automatic', 'buttons', 'name'],
   wcagSc: ['4.1.2'],
   normativeMappings: [
-    { standard: 'WCAG', version: '2.2', requirement: '4.1.2', title: 'Name, Role, Value', conformanceLevel: 'A' }
+    {
+      standard: 'WCAG',
+      version: '2.2',
+      requirement: '4.1.2',
+      title: 'Name, Role, Value',
+      conformanceLevel: 'A'
+    }
   ],
   defaultSeverity: 'serious',
   category: 'robust',
@@ -25,13 +33,15 @@ const meta = {
 };
 
 function runInPage(ctx) {
-  const { document, helpers, rule } = ctx;
+  const { helpers, rule } = ctx;
 
   const occurrences = [];
   let applicableCount = 0;
 
   function normalizeWs(s) {
-    return String(s || '').replace(/\s+/g, ' ').trim();
+    return String(s || '')
+      .replace(/\s+/g, ' ')
+      .trim();
   }
 
   function getConservativeSubtreeText(container) {
@@ -39,14 +49,13 @@ function runInPage(ctx) {
     // 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).
+    // (covers 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 : '';
     }
-    const t = (container && container.textContent) ? String(container.textContent) : '';
+    const t = container && container.textContent ? String(container.textContent) : '';
     return t.replace(/\s+/g, ' ').trim();
   }
 
@@ -55,19 +64,23 @@ function runInPage(ctx) {
       const type = normalizeWs(el.getAttribute ? el.getAttribute('type') : '').toLowerCase();
       if (type !== 'button' && type !== 'submit' && type !== 'reset') return '';
       const vAttr = el.getAttribute ? el.getAttribute('value') : '';
-      return normalizeWs(vAttr != null ? vAttr : (typeof el.value === 'string' ? el.value : ''));
+      return normalizeWs(vAttr != null ? vAttr : typeof el.value === 'string' ? el.value : '');
     } catch {
       return '';
     }
   }
 
-  const selector = 'button, input[type="button"], input[type="submit"], input[type="reset"], [role="button"]';
-  const nodes = helpers.queryAllSmart ? helpers.queryAllSmart(selector) : helpers.queryAll(selector);
+  const selector =
+    'button, input[type="button"], input[type="submit"], input[type="reset"], [role="button"]';
+  const nodes = helpers.queryAllSmart
+    ? helpers.queryAllSmart(selector)
+    : helpers.queryAll(selector);
 
   for (const el of nodes) {
     // isAccTreeEligible returns { eligible, reasons }, not a boolean.
     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;
 
     applicableCount += 1;
@@ -81,8 +94,9 @@ function runInPage(ctx) {
     // getAccessibleNameInfo only resolves programmatic mechanisms (aria-labelledby,
     // aria-label, native <label> association, title) — it never falls back to
     // subtree content — so it's safe to trust directly whenever present.
-    const trustedProgrammaticName =
-      normalizeWs(nameInfo && nameInfo.present && typeof nameInfo.value === 'string' ? nameInfo.value : '');
+    const trustedProgrammaticName = normalizeWs(
+      nameInfo && nameInfo.present && typeof nameInfo.value === 'string' ? nameInfo.value : ''
+    );
     const explicitProg = !!trustedProgrammaticName;
 
     let inputValueName = '';
@@ -94,15 +108,22 @@ function runInPage(ctx) {
     // one of these roles is no longer semantically a button — per the WAI-ARIA
     // Accessible Name and Description Computation spec these roles are
     // name-from-author-only, and their rendered content represents a VALUE,
-    // not a NAME (mirrors axe-core's controlValueRoles, verified against its
-    // source). Found on a real page (Spotify's "sort by" control): a
-    // <button role="combobox">List</button> where "List" is the combobox's
-    // currently selected value, not a label for what the combobox is —
-    // crediting it as the accessible name masked a real missing-name bug.
-    const VALUE_ROLES = ['textbox', 'progressbar', 'scrollbar', 'slider', 'spinbutton', 'combobox', 'listbox'];
-    const isContentNameCandidate = (tag === 'button' || role === 'button') && !VALUE_ROLES.includes(roleNorm);
+    // not a NAME. E.g. <button role="combobox">List</button> where "List" is
+    // the combobox's currently selected value, not a label — crediting it as
+    // the accessible name would mask a missing name.
+    const VALUE_ROLES = [
+      'textbox',
+      'progressbar',
+      'scrollbar',
+      'slider',
+      'spinbutton',
+      'combobox',
+      'listbox'
+    ];
+    const isContentNameCandidate =
+      (tag === 'button' || role === 'button') && !VALUE_ROLES.includes(roleNorm);
     const contentName =
-      (!trustedProgrammaticName && !inputValueName && isContentNameCandidate)
+      !trustedProgrammaticName && !inputValueName && isContentNameCandidate
         ? getConservativeSubtreeText(el)
         : '';
 
@@ -112,10 +133,14 @@ function runInPage(ctx) {
       // Only compute the richer eligibility-info payload (used solely for
       // the occurrence's visibilityFilter) once we know an occurrence is
       // actually being built, rather than for every applicable element.
-      const eligInfo = helpers.getEligibilityInfo ? helpers.getEligibilityInfo(el, ctx, { targetSet: 'acc' }) : null;
+      const eligInfo = helpers.getEligibilityInfo
+        ? helpers.getEligibilityInfo(el, ctx, { targetSet: 'acc' })
+        : 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,
@@ -148,7 +173,12 @@ function runInPage(ctx) {
     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: [] };
 }