testaro 18.12.0 → 18.13.1

package/README.md

@@ -59,20 +59,20 @@ Some of the rules tested by Testaro are based on rules of the [BBC Accessibility
 
 ## Rules
 
-Each tool accessed with Testaro defines _rules_ and tests _targets_ for compliance with its rules. The counts of the rules range from about 30, for Testaro itself, to about 270, for Continuum Community Edition. In total, the ten tools define about 1350 rules. Some of the tools are under active development, and their rule counts change over time.
+Each tool accessed with Testaro defines _rules_ and tests _targets_ for compliance with its rules. The counts of the rules range from about 40, for Testaro itself, to about 270, for Continuum Community Edition. In total, the nine tools define about 920 rules. Some of the tools are under active development, and their rule counts change over time.
 
 When you ask Testaro to run tests of a tool, you may specify a subset of the rules of that tool, and the report will give you the results of only the tests for those rules. These tools will perform only those tests:
-- alfa
-- axe
-- continuum
-- htmlcs
-- qualWeb
-- testaro
+- `alfa`
+- `axe`
+- `continuum`
+- `htmlcs`
+- `qualWeb`
+- `testaro`
 
 These tools always perform a fixed set of tests, and Testaro disregards irrelevant results when you specify a set of rules:
-- ibm
-- nuVal
-- wave
+- `ibm`
+- `nuVal`
+- `wave`
 
 ## Job data
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "testaro",
-  "version": "18.12.0",
+  "version": "18.13.1",
   "description": "Run 920 web accessibility tests from 9 tools and get a standardized report",
   "main": "index.js",
   "scripts": {

package/testaro/zIndex.js

@@ -10,68 +10,32 @@
 
 // ########## IMPORTS
 
-// Module to get locator data.
-const {getLocatorData} = require('../procs/getLocatorData');
+// Module to perform common operations.
+const {init, report} = require('../procs/testaro');
 
 // ########## FUNCTIONS
 
+// Runs the test and returns the result.
 exports.reporter = async (page, withItems) => {
-  // Initialize the result.
-  const data = {};
-  const totals = [0, 0, 0, 0];
-  const standardInstances = [];
-  // Get locators for all eligible elements.
-  const locAll = page.locator('body *');
-  const locsAll = await locAll.all();
-  // For each of them:
-  for (const loc of locsAll) {
-    // Get its Z index.
-    const zIndex = await loc.evaluate(element => {
-      const styleDec = window.getComputedStyle(element);
-      return styleDec.zIndex;
+  // Initialize the locators and result.
+  const all = await init(page, 'body *');
+  // For each locator:
+  for (const loc of all.allLocs) {
+    // Get whether its element violates the rule.
+    const badZ = await loc.evaluate(el => {
+      const styleDec = window.getComputedStyle(el);
+      const {zIndex} = styleDec;
+      return zIndex !== 'auto' ? zIndex : null;
     });
-    // If it is not auto:
-    if (zIndex !== 'auto') {
-      // Add to the totals.
-      totals[0]++;
-      // If itemization is required:
-      if (withItems) {
-        // Get data on the element.
-        const elData = await getLocatorData(loc);
-        // Add an instance to the result.
-        standardInstances.push({
-          ruleID: 'zIndex',
-          what: `Element has a non-default Z index (${zIndex})`,
-          ordinalSeverity: 0,
-          tagName: elData.tagName,
-          id: elData.id,
-          location: elData.location,
-          excerpt: elData.excerpt
-        });
-      }
+    // If it does:
+    if (badZ) {
+      // Add the locator to the array of violators.
+      all.locs.push([loc, badZ]);
     }
   }
-  // If itemization is not required:
-  if (! withItems) {
-    // Add a summary instance to the result.
-    standardInstances.push({
-      ruleID: 'zIndex',
-      what: 'Elements have non-default Z indexes',
-      count: totals[0],
-      ordinalSeverity: 0,
-      tagName: '',
-      id: '',
-      location: {
-        doc: '',
-        type: '',
-        spec: ''
-      },
-      excerpt: ''
-    });
-  }
-  return {
-    data,
-    totals,
-    standardInstances
-  };
+  // Populate and return the result.
+  const whats = [
+    'Element has a non-default Z index (__param__)', 'Elements have non-default Z indexes'
+  ];
+  return await report(withItems, all, 'zIndex', whats, 0);
 };