testaro 34.1.2 → 35.0.0

package/README.md

@@ -424,8 +424,6 @@ When you include a `rules` property, you limit the tests of the tool that are pe
 
 The `nuVal`, `qualWeb`, and `testaro` tools require specific formats for the `rules` property. Those formats are described below in the sections about those tools.
 
-The `ed11y` tool does not yet allow rule specification.
-
 ###### Examples
 
 An example of a `test` act is:

package/package.json

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

package/tests/ed11y.js

@@ -35,13 +35,13 @@ const fs = require('fs/promises');
 // Conducts and reports the Editoria11y tests.
 exports.reporter = async (page, options) => {
   // Get the nonce, if any.
-  const {report} = options;
+  const {act, report} = options;
   const {jobData} = report;
   const scriptNonce = jobData && jobData.lastScriptNonce;
   // Get the test script.
   const script = await fs.readFile(`${__dirname}/../ed11y/editoria11y.min.js`, 'utf8');
   const rawResultJSON = await page.evaluate(args => new Promise(async resolve => {
-    const {scriptNonce, script} = args;
+    const {scriptNonce, script, rulesToTest} = args;
     // When the script is executed:
     document.addEventListener('ed11yResults', () => {
       // Get the result.
@@ -74,34 +74,39 @@ exports.reporter = async (page, options) => {
       delete resultObj.options.lightTheme;
       // Initialize the element results.
       const results = resultObj.results = [];
-      // Populate them and add them to the result.
+      // For each rule violation:
       Ed11y.results.forEach(elResult => {
-        const result = {};
-        result.test = elResult.test || '';
-        if (elResult.content) {
-          result.content = elResult.content.replace(/\s+/g, ' ');
-        }
-        if (elResult.element) {
-          const{element} = elResult;
-          result.tagName = element.tagName || '';
-          result.id = element.id || '';
-          result.loc = {};
-          const locRect = element.getBoundingClientRect();
-          if (locRect) {
-            ['x', 'y', 'width', 'height'].forEach(dim => {
-              result.loc[dim] = Math.round(locRect[dim]);
-            });
-          }
-          let elText = element.textContent.replace(/\s+/g, ' ').trim();
-          if (! elText) {
-            elText = element.outerHTML;
+        // If rules were not selected or they were and include this one:
+        if (! rulesToTest || rulesToTest.includes(elResult.test)) {
+          // Create a violation record.
+          const result = {};
+          result.test = elResult.test || '';
+          if (elResult.content) {
+            result.content = elResult.content.replace(/\s+/g, ' ');
           }
-          if (elText.length > 400) {
-            elText = `${elText.slice(0, 200)}…${elText.slice(-200)}`;
+          if (elResult.element) {
+            const{element} = elResult;
+            result.tagName = element.tagName || '';
+            result.id = element.id || '';
+            result.loc = {};
+            const locRect = element.getBoundingClientRect();
+            if (locRect) {
+              ['x', 'y', 'width', 'height'].forEach(dim => {
+                result.loc[dim] = Math.round(locRect[dim]);
+              });
+            }
+            let elText = element.textContent.replace(/\s+/g, ' ').trim();
+            if (! elText) {
+              elText = element.outerHTML;
+            }
+            if (elText.length > 400) {
+              elText = `${elText.slice(0, 200)}…${elText.slice(-200)}`;
+            }
+            result.excerpt = elText.replace(/\s+/g, ' ');
           }
-          result.excerpt = elText.replace(/\s+/g, ' ');
+          // Add it to the result.
+          results.push(result);
         }
-        results.push(result);
       });
       // Return the result.
       try {
@@ -131,7 +136,7 @@ exports.reporter = async (page, options) => {
       console.log(`ERROR creating Ed11y (${error.message})`);
       resolve(JSON.stringify({error: error.message}));
     };
-  }), {scriptNonce, script});
+  }), {scriptNonce, script, rulesToTest: act.rules});
   const result = JSON.parse(rawResultJSON);
   let data = {};
   // Return the act report.