testaro 60.16.2 → 60.18.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "testaro",
-  "version": "60.16.2",
+  "version": "60.18.0",
   "description": "Run 1000 web accessibility tests from 11 tools and get a standardized report",
   "main": "index.js",
   "scripts": {

package/procs/testaro.js

@@ -26,122 +26,6 @@ const {xPath} = require('playwright-dompath');
 
 // ########## FUNCTIONS
 
-// Initializes violation locators and a result and returns them in an object.
-const init = exports.init = async (sampleMax, page, locAllSelector, options = {}) => {
-  // Get locators for the specified elements.
-  const locPop = page.locator(locAllSelector, options);
-  const locPops = await locPop.all();
-  const populationSize = locPops.length;
-  const sampleSize = Math.min(sampleMax, populationSize);
-  const locIndexes = getSample(locPops, sampleSize);
-  const allLocs = locIndexes.map(index => locPops[index]);
-  const result = {
-    data: {
-      populationSize,
-      sampleSize,
-      populationRatio: sampleSize ? populationSize / sampleSize : null
-    },
-    totals: [0, 0, 0, 0],
-    standardInstances: []
-  };
-  // Return the result.
-  return {
-    allLocs,
-    locs: [],
-    result
-  };
-};
-
-// Populates and returns a result.
-const getRuleResult = exports.getRuleResult = async (
-  withItems, all, ruleID, whats, ordinalSeverity, tagName = ''
-) => {
-  const {locs, result} = all;
-  const {data, totals, standardInstances} = result;
-  // For each violation locator:
-  for (const locItem of locs) {
-    // Get data on its element.
-    let loc, whatParam;
-    if (Array.isArray(locItem)) {
-      loc = locItem[0];
-      whatParam = locItem[1];
-    }
-    else {
-      loc = locItem;
-    }
-    const elData = await getLocatorData(loc);
-    // Increment the totals.
-    totals[ordinalSeverity] += data.populationRatio;
-    // If itemization is required:
-    if (withItems) {
-      // Get the bounding box of the element.
-      const {tagName, id, location, excerpt} = elData;
-      const box = location.type === 'box' ? location.spec : await boxOf(loc);
-      // Add a standard instance to the result.
-      standardInstances.push({
-        ruleID,
-        what: whatParam ? whats[0].replace('__param__', whatParam) : whats[0],
-        ordinalSeverity,
-        tagName,
-        id,
-        location,
-        excerpt,
-        boxID: boxToString(box),
-        pathID: tagName === 'HTML' ? '/html' : await xPath(loc)
-      });
-    }
-  }
-  // If itemization is not required and any instances exist:
-  if (! withItems && locs.length) {
-    // Add a summary standard instance to the result.
-    standardInstances.push({
-      ruleID,
-      what: whats[1],
-      ordinalSeverity,
-      count: Math.round(totals[ordinalSeverity]),
-      tagName,
-      id: '',
-      location: {
-        doc: '',
-        type: '',
-        spec: ''
-      },
-      excerpt: '',
-      boxID: '',
-      pathID: ''
-    });
-  }
-  // Return the result.
-  return result;
-};
-// Performs a simplifiable test.
-exports.simplify = async (page, withItems, ruleData) => {
-  const {
-    ruleID, selector, pruner, complaints, ordinalSeverity, summaryTagName
-  } = ruleData;
-  // Get an object with initialized violation locators and result as properties.
-  const all = await init(100, page, selector);
-  // For each locator:
-  for (const loc of all.allLocs) {
-    // Get whether its element violates the rule.
-    const isBad = await pruner(loc);
-    // If it does:
-    if (isBad) {
-      // Add the locator of the element to the array of violation locators.
-      all.locs.push(loc);
-    }
-  }
-  // Populate and return the result.
-  const whats = [
-    complaints.instance,
-    complaints.summary
-  ];
-  const result = await getRuleResult(
-    withItems, all, ruleID, whats, ordinalSeverity, summaryTagName
-  );
-  // Return the result.
-  return result;
-};
 // Performs a standard test.
 exports.doTest = async (
   page,
@@ -169,12 +53,13 @@ exports.doTest = async (
     const candidates = document.body.querySelectorAll(candidateSelector);
     let violationCount = 0;
     const instances = [];
-    // Get a violation function.
+    // Get a function that returns a violation description, if any, for the candidate.
     const getBadWhat = eval(`(${getBadWhatString})`);
     // For each candidate:
     for (const candidate of candidates) {
+      // Get the violation description, if any.
       const violationWhat = await getBadWhat(candidate);
-      // If it violates the rule:
+      // If the candidate violates the rule:
       if (violationWhat) {
         // Increment the violation count.
         violationCount++;

package/testaro/allCaps.js

@@ -14,48 +14,44 @@
   This test reports elements with native or transformed upper-case text at least 8 characters long. Blocks of upper-case text are difficult to read.
 */
 
-// ########## IMPORTS
+// IMPORTS
 
-// Module to perform common operations.
-const {simplify} = require('../procs/testaro');
+const {doTest} = require('../procs/testaro');
 
-// ########## FUNCTIONS
+// FUNCTIONS
 
 // Runs the test and returns the result.
 exports.reporter = async (page, withItems) => {
-  // Specify the rule.
-  const ruleData = {
-    ruleID: 'allCaps',
-    selector: 'body *:not(style, script, svg)',
-    pruner: async loc => await loc.evaluate(el => {
-      // Get the concatenated and debloated text content of the element and its child text nodes.
-      const elText = Array
-      .from(el.childNodes)
-      .filter(node => node.nodeType === Node.TEXT_NODE)
-      .map(textNode => textNode.nodeValue)
-      .join(' ')
-      .replace(/\s{2,}/g, ' ')
-      .replace(/-{2,}/g, '-');
-      // If the element text includes 8 sequential upper-case letters, spaces, or hyphen-minuses:
-      if (/[- A-Z]{8}/.test(elText)) {
-        // Report this.
-        return true;
+  const getBadWhat = element => {
+    // Get the child text nodes of the element.
+    const childTextNodes = Array.from(element.childNodes).filter(
+      node => node.nodeType === Node.TEXT_NODE
+    );
+    // Get the concatenation of their texts that contain 8 or more consecutive letters.
+    let longText = childTextNodes
+    .map(node => node.nodeValue.trim())
+    .filter(text => /[A-Z]{8,}/i.test(text))
+    .join(' ');
+    // If there is any:
+    if (longText) {
+      // Get the style declaration of the element.
+      const styleDec = window.getComputedStyle(element);
+      const {textTransform} = styleDec;
+      // If the style declaration transforms the text to upper case:
+      if (textTransform === 'uppercase') {
+        // Return a violation description.
+        return 'Element text is rendered as all-capital';
       }
-      // Otherwise:
-      else {
-        // Report whether its text is at least 8 characters long and transformed to upper case.
-        const elStyleDec = window.getComputedStyle(el);
-        const transformStyle = elStyleDec.textTransform;
-        return transformStyle === 'uppercase' && elText.length > 7;
+      // Otherwise, if the text contains 8 or more consecutive upper-case letters:
+      if (/[A-Z]{8,}/.test(longText)) {
+        // Return a violation description.
+        return 'Element contains all-capital text';
       }
-    }),
-    complaints: {
-      instance: 'Element contains all-capital text',
-      summary: 'Elements contain all-capital text'
-    },
-    ordinalSeverity: 0,
-    summaryTagName: ''
+    }
   };
-  // Run the test and return the result.
-  return await simplify(page, withItems, ruleData);
+  const selector = 'body *:not(style, script, svg)';
+  const whats = 'Elements have all-capital text';
+  return await doTest(
+    page, withItems, 'allCaps', selector, whats, 0, null, getBadWhat.toString()
+  );
 };

package/testaro/allSlanted.js

@@ -14,31 +14,26 @@
   This test reports elements with italic or oblique text at least 40 characters long. Blocks of slanted text are difficult to read.
 */
 
-// ########## IMPORTS
+// IMPORTS
 
-// Module to perform common operations.
-const {simplify} = require('../procs/testaro');
+const {doTest} = require('../procs/testaro');
 
-// ########## FUNCTIONS
+// FUNCTIONS
 
 // Runs the test and returns the result.
 exports.reporter = async (page, withItems) => {
-  // Specify the rule.
-  const ruleData = {
-    ruleID: 'allSlanted',
-    selector: 'body *:not(style, script, svg)',
-    pruner: async loc => await loc.evaluate(el => {
-      const elStyleDec = window.getComputedStyle(el);
-      const elText = el.textContent;
-      return ['italic', 'oblique'].includes(elStyleDec.fontStyle) && elText.length > 39;
-    }),
-    complaints: {
-      instance: 'Element contains all-italic or all-oblique text',
-      summary: 'Elements contain all-italic or all-oblique text'
-    },
-    ordinalSeverity: 0,
-    summaryTagName: ''
+  const getBadWhat = element => {
+    const styleDec = window.getComputedStyle(element);
+    const {textContent} = element;
+    // If the element contains 40 or more characters of slanted text:
+    if (['italic', 'oblique'].includes(styleDec.fontStyle) && textContent.length > 39) {
+      // Return a violation description.
+      return 'Element contains all-slanted text';
+    }
   };
-  // Run the test and return the result.
-  return await simplify(page, withItems, ruleData);
+  const selector = 'body *:not(style, script, svg)';
+  const whats = 'Elements contain all-slanted text';
+  return await doTest(
+    page, withItems, 'allSlanted', selector, whats, 0, null, getBadWhat.toString()
+  );
 };

package/testaro/distortion.js

@@ -14,32 +14,30 @@
   This test reports elements whose transform style properties distort the content. Distortion makes text difficult to read.
 */
 
-// ########## IMPORTS
+// IMPORTS
 
-// Module to perform common operations.
-const {simplify} = require('../procs/testaro');
+const {doTest} = require('../procs/testaro');
 
-// ########## FUNCTIONS
+// FUNCTIONS
 
 // Runs the test and returns the result.
 exports.reporter = async (page, withItems) => {
-  // Specify the rule.
-  const ruleData = {
-    ruleID: 'distortion',
-    selector: 'body *',
-    pruner: async loc => await loc.evaluate(el => {
-      const styleDec = window.getComputedStyle(el);
-      const {transform} = styleDec;
-      return transform
-      && ['matrix', 'perspective', 'rotate', 'scale', 'skew'].some(key => transform.includes(key));
-    }),
-    complaints: {
-      instance: 'Element distorts its text',
-      summary: 'Elements distort their texts'
-    },
-    ordinalSeverity: 1,
-    summaryTagName: ''
+  const getBadWhat = element => {
+    const styleDec = window.getComputedStyle(element);
+    const {transform} = styleDec;
+    const badTransformTypes = ['matrix', 'perspective', 'rotate', 'scale', 'skew'];
+    // If the element style transforms the text:
+    if (transform) {
+      const transformType = badTransformTypes.find(key => transform.includes(key));
+      // If the transformation is distortive:
+      if (transformType) {
+        // Return a violation description.
+        return `Element distorts its text with ${transformType} transformation`;
+      }
+    }
   };
-  // Run the test and return the result.
-  return await simplify(page, withItems, ruleData);
+  const whats = 'Elements distort their texts';
+  return await doTest(
+    page, withItems, 'distortion', 'body *', whats, 0, null, getBadWhat.toString()
+  );
 };

package/testaro/focAndOp.js

@@ -70,19 +70,18 @@ exports.reporter = async (page, withItems) => {
       ]);
       // Initialize the operabilities of the element.
       const opHow = [];
-      let hasPointer = false;
       // If the element is not a label:
       if (element.tagName !== 'LABEL') {
-        const styleDec = window.getComputedStyle(element);
-        hasPointer = styleDec.cursor === 'pointer';
+        const liveStyleDec = window.getComputedStyle(element);
         // If it has a pointer cursor:
-        if (hasPointer) {
+        if (liveStyleDec.cursor === 'pointer') {
           // Neutralize the cursor style of the parent element of the element.
           element.parentElement.style.cursor = 'default';
-          // Get whether, after this, the element still has a pointer cursor.
-          hasPointer = styleDec.cursor === 'pointer';
-          // Add this to the operabilities of the element.
-          opHow.push('pointer cursor');
+          // If, after this, the element still has a pointer cursor:
+          if (liveStyleDec.cursor === 'pointer') {
+            // Add this to the operabilities of the element.
+            opHow.push('pointer cursor');
+          }
         }
       }
       // If the element has a click event listener:

package/testaro/hover.js

@@ -10,7 +10,7 @@
 
 /*
   hover
-  This test reports unexpected impacts of hovering. The elements that are subjected to hovering (called “triggers”) include all the elements that have attributes associated with control over the visibility of other elements. If hovering over an element results in an increase or decrease in the total count of visible elements in the tree rooted in the grandparent of the trigger, the rule is considered violated.
+  This test reports unexpected impacts of hovering. The elements that are subjected to hovering (called “triggers”) include all the elements that have attributes associated with control over the visibility of other elements. If hovering over an element results in an increase or decrease in the total count of visible elements in the tree rooted in the grandparent of the trigger, the rule is considered violated. This test uses the getBasicResult function in order to use Playwright for the most realistic hover simulation.
 */
 
 // IMPORTS

package/testaro/hr.js

@@ -0,0 +1,32 @@
+/*
+  © 2023 CVS Health and/or one of its affiliates. All rights reserved.
+  © 2025 Jonathan Robert Pool.
+
+  Licensed under the MIT License. See LICENSE file at the project root or
+  https://opensource.org/license/mit/ for details.
+
+  SPDX-License-Identifier: MIT
+*/
+
+/*
+  hr
+  This test reports the use of hr elements.
+*/
+
+// IMPORTS
+
+const {doTest} = require('../procs/testaro');
+
+// FUNCTIONS
+
+// Runs the test and returns the result.
+exports.reporter = async (page, withItems) => {
+  const getBadWhat = element => {
+    // Return a violation description.
+    return `hr element is used for vertical segmentation`;
+  }
+  const whats = 'HR elements are used for vertical segmentation';
+  return await doTest(
+    page, withItems, 'hr', 'hr', whats, 0, 'HR', getBadWhat.toString()
+  );
+};

package/testaro/imageLink.js

@@ -1,6 +1,7 @@
 /*
   © 2025 CVS Health and/or one of its affiliates. All rights reserved.
   © 2025 Juan S. Casado.
+  © 2025 Jonathan Robert Pool
 
   Licensed under the MIT License. See LICENSE file at the project root or
   https://opensource.org/license/mit/ for details.
@@ -11,25 +12,27 @@
 /*
   imageLink
   Clean-room rule.
-  This test reports anchor elements whose href attributes point to image files.
+  This test reports links whose destinations are image files.
 */
 
-const {simplify} = require('../procs/testaro');
+// IMPORTS
 
+const {doTest} = require('../procs/testaro');
+
+// FUNCTIONS
+
+// Runs the test and returns the result.
 exports.reporter = async (page, withItems) => {
-  const ruleData = {
-    ruleID: 'imageLink',
-    selector: 'a[href]',
-    pruner: async loc => await loc.evaluate(el => {
-      const href = el.getAttribute('href') || '';
-      return /\.(?:png|jpe?g|gif|svg|webp|ico)(?:$|[?#])/i.test(href);
-    }),
-    complaints: {
-      instance: 'Link destination is an image file',
-      summary: 'Links have image files as their destinations'
-    },
-    ordinalSeverity: 0,
-    summaryTagName: 'A'
+  const getBadWhat = element => {
+    const href = element.getAttribute('href') || '';
+    // If the destination of the element is an image file:
+    if (/\.(?:png|jpe?g|gif|svg|webp|ico)(?:$|[?#])/i.test(href)) {
+      // Return a violation description.
+      return 'Link destination is an image file';
+    }
   };
-  return await simplify(page, withItems, ruleData);
+  const whats = 'Links have image files as their destinations';
+  return await doTest(
+    page, withItems, 'imageLink', 'a[href]', whats, 0, 'A', getBadWhat.toString()
+  );
 };

package/testaro/legendLoc.js

@@ -1,6 +1,7 @@
 /*
   © 2025 CVS Health and/or one of its affiliates. All rights reserved.
   © 2025 Juan S. Casado.
+  © 2025 Jonathan Robert Pool.
 
   Licensed under the MIT License. See LICENSE file at the project root or
   https://opensource.org/license/mit/ for details.
@@ -14,30 +15,24 @@
   This test reports legend elements that are not the first children of fieldset elements.
 */
 
-const {simplify} = require('../procs/testaro');
+// IMPORTS
 
+const {doTest} = require('../procs/testaro');
+
+// FUNCTIONS
+
+// Runs the test and returns the result.
 exports.reporter = async (page, withItems) => {
-  const ruleData = {
-    ruleID: 'legendLoc',
-    selector: 'legend',
-    pruner: async (loc) => await loc.evaluate(el => {
-      const parent = el.parentElement;
-      if (!parent) return true;
-      if (parent.tagName.toUpperCase() !== 'FIELDSET') return true;
-      // Check if this legend is the first element child of the fieldset
-      for (const child of parent.children) {
-        if (child.nodeType === 1) {
-          return child !== el; // true if not first child
-        }
-      }
-      return true;
-    }),
-    complaints: {
-      instance: 'Element is not the first child of a fieldset element',
-      summary: 'legend elements are not the first children of fieldset elements'
-    },
-    ordinalSeverity: 3,
-    summaryTagName: 'LEGEND'
+  const getBadWhat = element => {
+    const parent = element.parentElement;
+    // If the element violates the rule:
+    if (! (parent && parent.tagName === 'FIELDSET' && parent.firstElementChild === element)) {
+      // Return a violation description.
+      return 'Element is not the first child of a fieldset element';
+    }
   };
-  return await simplify(page, withItems, ruleData);
+  const whats = 'Legend elements are not the first children of fieldset elements';
+  return await doTest(
+    page, withItems, 'legendLoc', 'legend', whats, 3, 'LEGEND', getBadWhat.toString()
+  );
 };

package/testaro/linkExt.js

@@ -0,0 +1,31 @@
+/*
+  © 2023 CVS Health and/or one of its affiliates. All rights reserved.
+  © 2025 Jonathan Robert Pool.
+
+  Licensed under the MIT License. See LICENSE file at the project root or
+  https://opensource.org/license/mit/ for details.
+
+  SPDX-License-Identifier: MIT
+*/
+
+/*
+  linkExt
+  This test reports links with target=_blank attributes.
+*/
+
+// IMPORTS
+
+const {doTest} = require('../procs/testaro');
+
+// FUNCTIONS
+
+exports.reporter = async (page, withItems) => {
+  const getBadWhat = element => {
+    // Return a violation description.
+    return `Link has a target=_blank attribute`;
+  };
+  const whats = 'Links have target=_blank attributes';
+  return await doTest(
+    page, withItems, 'linkExt', 'a[target=_blank]', whats, 0, 'A', getBadWhat.toString()
+  );
+};

package/testaro/linkOldAtt.js

@@ -0,0 +1,43 @@
+/*
+  © 2023 CVS Health and/or one of its affiliates. All rights reserved.
+  © 2025 Jonathan Robert Pool.
+
+  Licensed under the MIT License. See LICENSE file at the project root or
+  https://opensource.org/license/mit/ for details.
+
+  SPDX-License-Identifier: MIT
+*/
+
+/*
+  linkOldAtt
+  This test reports links with deprecated attributes.
+*/
+
+// IMPORTS
+
+const {doTest} = require('../procs/testaro');
+
+// FUNCTIONS
+
+exports.reporter = async (page, withItems) => {
+  const getBadWhat = element => {
+    const attNames = element.getAttributeNames();
+    const allBadAttNames = ['charset', 'coords', 'name', 'rev', 'shape'];
+    const elementBadAttNames = allBadAttNames.filter(att => attNames.includes(att));
+    // If the element has 1 deprecated attribute:
+    if (elementBadAttNames.length === 1) {
+      // Return a violation description.
+      return `${elementBadAttNames[0]} attribute is deprecated`;
+    }
+    // Otherwise, if the element has 2 or more deprecated attributes:
+    if (elementBadAttNames.length > 1) {
+      // Return a violation description.
+      return `Element has deprecated attributes: ${elementBadAttNames.join(', ')}`;
+    }
+  };
+  const selector = 'a[charset], a[coords], a[name], a[rev], a[shape]';
+  const whats = 'Links have deprecated attributes';
+  return await doTest(
+    page, withItems, 'linkOldAtt', selector, whats, 1, 'A', getBadWhat.toString()
+  );
+};

package/testaro/linkTo.js

@@ -0,0 +1,37 @@
+/*
+  © 2023 CVS Health and/or one of its affiliates. All rights reserved.
+  © 2025 Jonathan Robert Pool.
+
+  Licensed under the MIT License. See LICENSE file at the project root or
+  https://opensource.org/license/mit/ for details.
+
+  SPDX-License-Identifier: MIT
+*/
+/*
+  linkTo
+  This test reports links without href attributes.
+*/
+// IMPORTS
+
+const {doTest} = require('../procs/testaro');
+
+// FUNCTIONS
+
+exports.reporter = async (page, withItems) => {
+  const getBadWhat = element => {
+    const isVisible = element.checkVisibility({
+      contentVisibilityAuto: true,
+      opacityProperty: true,
+      visibilityProperty: true
+    });
+    // If the element is visible:
+    if (isVisible) {
+      // Return a violation description.
+      return `Element has no href attribute`;
+    }
+  };
+  const whats = 'Links are missing href attributes';
+  return await doTest(
+    page, withItems, 'linkTo', 'a:not([href]', whats, 2, 'A', getBadWhat.toString()
+  );
+};