testaro 58.0.9 → 58.1.0

package/AGENTS.md

@@ -0,0 +1,27 @@
+/*
+  Licensed under the MIT License. See LICENSE file for details.
+*/
+
+# Testaro Agent Guidelines
+
+## Commands
+- **Run all tests**: `npm run tests`
+- **Run single test**: `npm test <testname>` (e.g., `npm test hover`)
+- **Run job**: `npm run run [jobID]`
+- **Directory watch**: `npm run dirWatch`
+- **Network watch**: `npm run netWatch`
+- **Lint**: `npx eslint <file>` (follows `.eslintrc.json`)
+
+## Architecture
+- **Main dirs**: `/tests` (tool test definitions), `/procs` (shared procedures), `/validation` (test validators), root (core modules)
+- **Key files**: `run.js` (main executor), `actSpecs.js` (act specifications), `call.js` (CLI entry), `tests/testaro.js` (Testaro tool rules)
+- **Tools**: Integrates 11 a11y tools (Axe, Alfa, IBM Checker, QualWeb, ASLint, WAVE, WallyAX, Ed11y, HTML CodeSniffer, Nu Validator, Testaro)
+- **Data flow**: Jobs (JSON) → run.js → tool tests → reports (with standardized results)
+- **Env vars**: Required for WallyAX (`WAX_KEY`), WAVE (`WAVE_KEY`); optional `DEBUG`, `WAITS`, `JOBDIR`, `REPORTDIR`, `AGENT`
+
+## Code Style
+- **ESLint**: 2-space indent, single quotes, semicolons required, Stroustrup brace style, no use-before-define
+- **Imports**: CommonJS (`require`/`module.exports`), not ES modules
+- **Naming**: camelCase for vars/functions, descriptive names, rule IDs in lowercase
+- **Error handling**: Try-catch blocks, report failures via `prevented: true` in results
+- **Comments**: Explain complex logic, but keep concise

package/LICENSE

@@ -1,6 +1,7 @@
 MIT License
 
-© 2021–2024 CVS Health and/or one of its affiliates. All rights reserved.
+© 2021–2025 CVS Health and/or one of its affiliates. All rights reserved.
+© 2025 Jonathan Robert Pool. All rights reserved.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/package.json

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

package/run.js

@@ -569,26 +569,42 @@ const abortActs = (report, actIndex) => {
   console.log(`ERROR: Job aborted on act ${actIndex}`);
 };
 // Performs the acts in a report and adds the results to the report.
-const doActs = async (report) => {
+const doActs = async (report, opts = {}) => {
   const {acts} = report;
+  const {onProgress = null, signal = null} = opts;
   // Get the standardization specification.
   const standard = report.standard || 'only';
   const reportPath = `${tmpDir}/report.json`;
   // For each act in the report.
   for (const doActsIndex in acts) {
+    if (signal && signal.aborted) throw new Error('doActs aborted');
     actIndex = doActsIndex;
     // If the job has not been aborted:
     if (report.jobData && ! report.jobData.aborted) {
       let act = acts[actIndex];
       const {type, which} = act;
-      const actSuffix = type === 'test' ? ` ${which}` : '';
-      const message = `>>>> ${type}${actSuffix}`;
       // If granular reporting has been specified:
       if (report.observe) {
-        // Notify the observer of the act and log it.
+        // If a progress callback has been provided:
         const whichParam = which ? `&which=${which}` : '';
         const messageParams = `act=${type}${whichParam}`;
-        tellServer(report, messageParams, message);
+        if (onProgress) {
+          // Notify the observer of the act.
+          try {
+            onProgress({
+              type,
+              which
+            });
+          }
+          catch (error) {}
+        }
+        // Otherwise, i.e. if no progress callback has been provided:
+        else {
+          const actSuffix = type === 'test' ? ` ${which}` : '';
+          const message = `>>>> ${type}${actSuffix}`;
+          // Notify the observer of the act and log it.
+          tellServer(report, messageParams, message);
+        }
       }
       // Otherwise, i.e. if granular reporting has not been specified:
       else {
@@ -1386,7 +1402,7 @@ const doActs = async (report) => {
   return report;
 };
 // Runs a job and returns a report.
-exports.doJob = async job => {
+exports.doJob = async (job, opts = {}) => {
   // Make a report as a copy of the job.
   let report = JSON.parse(JSON.stringify(job));
   const jobData = report.jobData = {};
@@ -1428,7 +1444,7 @@ exports.doJob = async job => {
     });
     // Perform the acts and get a report.
     console.log('Performing the job acts');
-    report = await doActs(report, 0, null);
+    report = await doActs(report, opts);
     // Add the end time and duration to the report.
     const endTime = new Date();
     report.jobData.endTime = nowString();