testaro 64.8.1 → 64.8.3

package/package.json

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

package/procs/standardize.js

@@ -321,29 +321,42 @@ const doQualWeb = (result, standardResult, ruleClassName) => {
 };
 // Converts instances of a wave rule category.
 const doWAVE = (result, standardResult, categoryName) => {
+  // If results for the category are reported:
   if (result.categories && result.categories[categoryName]) {
     const category = result.categories[categoryName];
     const ordinalSeverity = categoryName === 'alert' ? 0 : 3;
     const {items} = category;
+    // If any violations in the category are reported:
     if (items) {
+      // For each rule violated:
       Object.keys(items).forEach(ruleID => {
-        items[ruleID].selectors.forEach(violationFacts => {
+        const item = items[ruleID];
+        // For each violation:
+        item.selectors.forEach(violationFacts => {
           let tagName = '';
           let id = '';
-          if (typeof violationFacts[0] === 'string') {
-            const finalTerm = violationFacts[0].replace(/^.+\s/, '');
-            if (finalTerm.includes('#')) {
-              const finalArray = finalTerm.split('#');
-              tagName = finalArray[0].replace(/:.*/, '');
-              id = isBadID(finalArray[1]) ? '' : finalArray[1];
-            }
-            else {
-              tagName = finalTerm.replace(/:.*/, '');
-            }
+          const finalTerm = violationFacts[0].replace(/^.+\s/, '');
+          // If the selector is an element ID:
+          if (finalTerm.includes('#')) {
+            const finalArray = finalTerm.split('#');
+            // Use it to get the element tagname and ID
+            tagName = finalArray[0].replace(/:.*/, '');
+            id = isBadID(finalArray[1]) ? '' : finalArray[1];
+          }
+          // Otherwise, i.e. if the selector is not an element ID:
+          else {
+            // Get the element tagname from it.
+            tagName = finalTerm.replace(/:.*/, '');
           }
+          const {wcag} = item;
+          // Get a violation description suffix from the WCAG data of the rule.
+          const wcagSuffix = wcag.length
+            ? ` (${wcag.map(wcagItem => wcagItem.name).join('; ')})`
+            : '';
+          // Get a standard instance.
           const instance = {
             ruleID,
-            what: items[ruleID].description,
+            what: `${item.description}${wcagSuffix}`,
             ordinalSeverity,
             tagName,
             id,
@@ -354,6 +367,7 @@ const doWAVE = (result, standardResult, categoryName) => {
             },
             excerpt: violationFacts[1]
           };
+          // Add it to the standard result.
           standardResult.instances.push(instance);
         });
       });

package/tests/wave.js

@@ -15,7 +15,6 @@
 
 // CONSTANTS
 
-const fs = require('fs/promises');
 const https = require('https');
 
 // FUNCTIONS
@@ -93,9 +92,9 @@ exports.reporter = async (page, report, actIndex) => {
                   }
                 });
               }
-              // Add WCAG information from the WAVE documentation.
-              const waveDocJSON = await fs.readFile('procs/wavedoc.json', 'utf8');
-              const waveDoc = JSON.parse(waveDocJSON);
+              // Get the WAVE WCAG documentation.
+              const waveDocResponse = await fetch('https://wave.webaim.org/api/docs');
+              const waveDoc = waveDocResponse.ok ? await waveDocResponse.json() : [];
               // For each rule category:
               for (const categoryName of Object.keys(categories)) {
                 const category = categories[categoryName];
@@ -112,24 +111,28 @@ exports.reporter = async (page, report, actIndex) => {
                     const {guidelines} = ruleDoc;
                     const rule = items[ruleName];
                     // Add WCAG information to the rule data.
-                    rule.wcag = guidelines;
+                    rule.wcag = guidelines || [];
                     // For each violation:
                     for (const index in rule.selectors) {
-                      const selector = rule.selectors[index];
-                      // Get an excerpt of the element.
-                      const excerpt = await page.evaluate(selector => {
-                        const element = document.querySelector(selector);
-                        // If the selector matches an element:
-                        if (element) {
-                          // Get an excerpt of the element.
-                          const rawExcerpt = element.textContent.trim() || element.outerHTML.trim();
-                          const normalizedExcerpt = rawExcerpt.replace(/\s+/g, ' ');
-                          return normalizedExcerpt.slice(0, 300);
-                        }
-                        else {
-                          return '';
-                        }
-                      }, selector);
+                      const selector = rule.selectors[index] || '';
+                      let excerpt = '';
+                      // If a selector is provided:
+                      if (selector) {
+                        // Get an excerpt of the element.
+                        excerpt = await page.evaluate(selector => {
+                          const element = document.querySelector(selector);
+                          // If the selector matches an element:
+                          if (element) {
+                            // Get an excerpt of the element.
+                            const rawExcerpt = element.textContent.trim() || element.outerHTML.trim();
+                            const normalizedExcerpt = rawExcerpt.replace(/\s+/g, ' ');
+                            return normalizedExcerpt.slice(0, 300);
+                          }
+                          else {
+                            return '';
+                          }
+                        }, selector);
+                      }
                       // Convert the violation selector to a selector-excerpt pair.
                       rule.selectors[index] = [selector, excerpt];
                     }