@surea11y/core 1.1.2 → 1.3.0

package/src/checks/automatic/aria-conditional-attr.js

@@ -43,7 +43,13 @@ const meta = {
   tags: ['wcag2a', 'wcag412', 'aria', 'structure', 'atomic', 'automatic'],
   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',
@@ -53,9 +59,11 @@ const meta = {
 };
 
 function runInPage(ctx) {
-  const { document, helpers, rule } = ctx;
+  const { helpers, rule } = ctx;
 
-  function trim(v) { return (v == null ? '' : String(v)).trim(); }
+  function trim(v) {
+    return (v == null ? '' : String(v)).trim();
+  }
 
   const TRUTHY_INVALID_VALUES = new Set(['true', 'grammar', 'spelling']);
 
@@ -78,13 +86,14 @@ function runInPage(ctx) {
     if (TRUTHY_INVALID_VALUES.has(invalidValue)) 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 tag = (el.tagName || '').toLowerCase();
 
     occurrences.push({
       selector: stableSelector,
       html,
-      summary: 'This element has aria-errormessage but aria-invalid is missing or "false", so the error message is not exposed.',
+      summary:
+        'This element has aria-errormessage but aria-invalid is missing or "false", so the error message is not exposed.',
       hint: 'Set aria-invalid to "true" (or "grammar"/"spelling") whenever aria-errormessage should be exposed to assistive technology.',
       i18n: {
         summaryKey: 'ariaConditionalAttr_summary_fail',
@@ -92,7 +101,10 @@ function runInPage(ctx) {
         params: { element: tag, ariaInvalid: invalidValue || '(absent)' }
       },
       data: {
-        details: { reasonCode: 'ARIA_ERRORMESSAGE_WITHOUT_TRUTHY_INVALID', ariaInvalid: invalidValue }
+        details: {
+          reasonCode: 'ARIA_ERRORMESSAGE_WITHOUT_TRUTHY_INVALID',
+          ariaInvalid: invalidValue
+        }
       }
     });
   }
@@ -101,7 +113,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 || 'serious', occurrences };
+    return {
+      ruleId: rule.ruleId,
+      outcome: 'fail',
+      severity: rule.defaultSeverity || 'serious',
+      occurrences
+    };
   }
   return { ruleId: rule.ruleId, outcome: 'pass', severity: 'minor', occurrences: [] };
 }

package/src/checks/automatic/aria-deprecated-role.js

@@ -26,7 +26,8 @@ const id = 'aria-deprecated-role';
 
 const meta = {
   title: 'role attribute must not use a deprecated or author-prohibited ARIA role',
-  description: 'Checks that an explicit role="" attribute does not use a role deprecated by the WAI-ARIA specification, or one reserved for user-agent-internal use only (e.g. role="generic").',
+  description:
+    'Checks that an explicit role="" attribute does not use a role deprecated by the WAI-ARIA specification, or one reserved for user-agent-internal use only (e.g. role="generic").',
   i18n: {
     titleKey: 'ariaDeprecatedRole_title',
     descriptionKey: 'ariaDeprecatedRole_description'
@@ -35,7 +36,13 @@ const meta = {
   tags: ['wcag2a', 'wcag412', 'aria', 'structure', 'atomic', 'automatic'],
   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: 'moderate',
   category: 'robust',
@@ -45,14 +52,16 @@ const meta = {
 };
 
 function runInPage(ctx) {
-  const { document, helpers, rule } = ctx;
+  const { helpers, rule } = ctx;
 
   const ariaHelpers = helpers && helpers.aria ? helpers.aria : null;
   if (!ariaHelpers) {
     return { ruleId: rule.ruleId, outcome: 'notApplicable', severity: 'minor', occurrences: [] };
   }
 
-  const nodes = helpers.queryAllSmart ? helpers.queryAllSmart('[role]') : helpers.queryAll('[role]');
+  const nodes = helpers.queryAllSmart
+    ? helpers.queryAllSmart('[role]')
+    : helpers.queryAll('[role]');
 
   const occurrences = [];
   let applicableCount = 0;
@@ -72,10 +81,10 @@ function runInPage(ctx) {
     if (!ariaHelpers.isDeprecatedRole(role)) 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 guidance = ariaHelpers.getDeprecatedRoleGuidance
-        ? ariaHelpers.getDeprecatedRoleGuidance(role)
-        : 'Replace the deprecated role with its recommended replacement.';
+      ? ariaHelpers.getDeprecatedRoleGuidance(role)
+      : 'Replace the deprecated role with its recommended replacement.';
 
     occurrences.push({
       selector: stableSelector,
@@ -97,7 +106,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/aria-hidden-body.js

@@ -24,7 +24,8 @@ const id = 'aria-hidden-body';
 
 const meta = {
   title: 'The document <body> must not be aria-hidden',
-  description: 'Checks that <body> does not have aria-hidden="true", which would remove the entire page from the accessibility tree.',
+  description:
+    'Checks that <body> does not have aria-hidden="true", which would remove the entire page from the accessibility tree.',
   i18n: {
     titleKey: 'ariaHiddenBody_title',
     descriptionKey: 'ariaHiddenBody_description'
@@ -33,8 +34,20 @@ const meta = {
   tags: ['wcag2a', 'wcag131', 'wcag412', 'structure', 'atomic', 'automatic'],
   wcagSc: ['1.3.1', '4.1.2'],
   normativeMappings: [
-    { standard: 'WCAG', version: '2.2', requirement: '1.3.1', title: 'Info and Relationships', conformanceLevel: 'A' },
-    { standard: 'WCAG', version: '2.2', requirement: '4.1.2', title: 'Name, Role, Value', conformanceLevel: 'A' }
+    {
+      standard: 'WCAG',
+      version: '2.2',
+      requirement: '1.3.1',
+      title: 'Info and Relationships',
+      conformanceLevel: 'A'
+    },
+    {
+      standard: 'WCAG',
+      version: '2.2',
+      requirement: '4.1.2',
+      title: 'Name, Role, Value',
+      conformanceLevel: 'A'
+    }
   ],
   defaultSeverity: 'critical',
   category: 'perceivable',
@@ -48,6 +61,14 @@ const meta = {
   }
 };
 
+// This check is inherently whole-document (does the PAGE have this
+// property?), not evaluable per-subtree -- notApplicable when contextSelector
+// scoped this run narrower than the whole document, or when
+// engineOptions.fragment:true was set (see helpers.isWholeDocumentScope).
+function applicability(ctx) {
+  return ctx.helpers.isWholeDocumentScope ? ctx.helpers.isWholeDocumentScope() : true;
+}
+
 function runInPage(ctx) {
   const { document, helpers, rule } = ctx;
 
@@ -64,24 +85,34 @@ 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);
 
-  const occurrences = [{
-    selector: stableSelector,
-    html,
-    summary: 'The document body has aria-hidden="true", which hides the entire page from assistive technologies.',
-    hint: 'Remove aria-hidden from <body>. Hide specific elements instead, if that was the intent.',
-    i18n: {
-      summaryKey: 'ariaHiddenBody_summary_fail',
-      hintKey: 'ariaHiddenBody_hint_fail',
-      params: {}
-    },
-    data: {
-      details: { reasonCode: 'ARIA_HIDDEN_BODY' }
+  const occurrences = [
+    {
+      selector: stableSelector,
+      html,
+      summary:
+        'The document body has aria-hidden="true", which hides the entire page from assistive technologies.',
+      hint: 'Remove aria-hidden from <body>. Hide specific elements instead, if that was the intent.',
+      i18n: {
+        summaryKey: 'ariaHiddenBody_summary_fail',
+        hintKey: 'ariaHiddenBody_hint_fail',
+        params: {}
+      },
+      data: {
+        details: { reasonCode: 'ARIA_HIDDEN_BODY' }
+      }
     }
-  }];
+  ];
 
-  return { ruleId: rule.ruleId, outcome: 'fail', severity: rule.defaultSeverity || 'critical', occurrences };
+  return {
+    ruleId: rule.ruleId,
+    outcome: 'fail',
+    severity: rule.defaultSeverity || 'critical',
+    occurrences
+  };
 }
 
-module.exports = { id, meta, runInPage };
+module.exports = { id, meta, runInPage, applicability };