@axe-core/cli 4.6.2-alpha.378 → 4.6.2-alpha.380

package/dist/index.js

@@ -0,0 +1,229 @@
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/lib/index.ts
+var lib_exports = {};
+__export(lib_exports, {
+  saveOutcome: () => saveOutcome,
+  testPages: () => axe_test_urls_default,
+  utils: () => utils_exports
+});
+module.exports = __toCommonJS(lib_exports);
+
+// src/lib/axe-test-urls.ts
+var import_webdriverjs = __toESM(require("@axe-core/webdriverjs"));
+var testPages = async (urls, config, events) => {
+  const driver = await config.driver;
+  if (urls.length === 0) {
+    await driver.quit();
+    return Promise.resolve([]);
+  }
+  return new Promise((resolve, reject) => {
+    const currentUrl = urls[0].replace(/[,;]$/, "");
+    if (events?.onTestStart) {
+      events?.onTestStart(currentUrl);
+    }
+    if (config.timer) {
+      events?.startTimer("axe page load time");
+    }
+    driver.get(currentUrl).then(() => {
+      if (config.timer) {
+        events?.endTimer("axe page load time");
+      }
+      if (config.loadDelay) {
+        events?.waitingMessage(config.loadDelay);
+      }
+      return new Promise((resolve2) => {
+        setTimeout(resolve2, config.loadDelay);
+      });
+    }).then(() => {
+      const axe = new import_webdriverjs.default(driver, config.axeSource);
+      if (Array.isArray(config.include)) {
+        config.include.forEach((include) => axe.include(include));
+      }
+      if (Array.isArray(config.exclude)) {
+        config.exclude.forEach((exclude) => axe.exclude(exclude));
+      }
+      if (config.tags) {
+        axe.withTags(config.tags);
+      } else if (config.rules) {
+        axe.withRules(config.rules);
+      }
+      if (config.disable) {
+        axe.disableRules(config.disable);
+      }
+      if (config.timer) {
+        events?.startTimer("axe-core execution time");
+      }
+      axe.analyze((err, results) => {
+        if (config.timer) {
+          events?.endTimer("axe-core execution time");
+        }
+        if (err) {
+          return reject(err);
+        }
+        if (events?.onTestComplete) {
+          events?.onTestComplete(results);
+        }
+        testPages(urls.slice(1), config, events).then((out) => {
+          resolve([results].concat(out));
+        });
+      });
+    }).catch(async (e) => {
+      await driver.quit();
+      reject(e);
+    });
+  });
+};
+var axe_test_urls_default = testPages;
+
+// src/lib/utils.ts
+var utils_exports = {};
+__export(utils_exports, {
+  bold: () => bold,
+  error: () => error,
+  getAxeSource: () => getAxeSource,
+  getAxeVersion: () => getAxeVersion,
+  green: () => green,
+  italics: () => italics,
+  link: () => link,
+  parseBrowser: () => parseBrowser,
+  parseUrl: () => parseUrl,
+  reporter: () => reporter,
+  saveOutcome: () => saveOutcome,
+  selectorToString: () => selectorToString,
+  splitList: () => splitList
+});
+var import_fs = __toESM(require("fs"));
+var import_path = __toESM(require("path"));
+var import_colors = __toESM(require("colors"));
+var saveOutcome = (outcome, fileName, dir) => {
+  if (typeof fileName !== "string") {
+    fileName = "axe-results-" + Date.now() + ".json";
+  }
+  if (typeof dir !== "string") {
+    dir = process.cwd();
+  } else if (!import_path.default.isAbsolute(dir)) {
+    dir = import_path.default.join(process.cwd(), dir);
+  }
+  const filePath = import_path.default.join(dir, fileName);
+  if (!import_fs.default.existsSync(filePath)) {
+    import_fs.default.mkdirSync(dir, { recursive: true });
+  }
+  import_fs.default.writeFileSync(filePath, JSON.stringify(outcome, null, 2), "utf-8");
+  return filePath;
+};
+var parseUrl = (url) => {
+  if (!/[a-z]+:\/\//.test(url)) {
+    return "http://" + url;
+  }
+  return url;
+};
+var parseBrowser = (browser) => {
+  if (!browser) {
+    return "chrome-headless";
+  }
+  const l = browser.length;
+  switch (browser.toLowerCase()) {
+    case "ff":
+    case "firefox".substr(0, l):
+    case "gecko".substr(0, l):
+    case "marionette".substr(0, l):
+      return "firefox";
+    case "chrome".substr(0, l):
+      return "chrome";
+    case "ie":
+    case "explorer".substr(0, l):
+    case "internetexplorer".substr(0, l):
+    case "internet_explorer".substr(0, l):
+    case "internet-explorer".substr(0, l):
+      return "ie";
+    case "safari".substr(0, l):
+      return "safari";
+    case "edge".substr(0, l):
+    case "microsoftedge".substr(0, l):
+      return "MicrosoftEdge";
+    default:
+      throw new Error("Unknown browser " + browser);
+  }
+};
+var getAxeSource = (axePath) => {
+  if (axePath && !import_fs.default.existsSync(axePath)) {
+    return;
+  }
+  if (!axePath) {
+    axePath = import_path.default.join(process.cwd(), "axe.js");
+  }
+  if (!import_fs.default.existsSync(axePath)) {
+    axePath = import_path.default.join(process.cwd(), "node_modules", "axe-core", "axe.js");
+  }
+  if (!import_fs.default.existsSync(axePath)) {
+    axePath = import_path.default.join(
+      __dirname,
+      "..",
+      "..",
+      "..",
+      "node_modules",
+      "axe-core",
+      "axe.js"
+    );
+  }
+  return import_fs.default.readFileSync(axePath, "utf-8");
+};
+var getAxeVersion = (source) => {
+  const match = source.match(/\.version\s*=\s'([^']+)'/);
+  return match ? match[1] : "unknown version";
+};
+var splitList = (val) => {
+  return val.split(/[,;]/).map((str) => str.trim());
+};
+var selectorToString = (selectors, separator) => {
+  separator = separator || " ";
+  return selectors.reduce((prev, curr) => prev.concat(curr), []).join(separator);
+};
+var reporter = (noReporter, silentMode) => {
+  if (!noReporter || silentMode) {
+    return () => {
+    };
+  } else {
+    return (...args) => {
+      console.log(...args);
+    };
+  }
+};
+var link = import_colors.default.underline.blue;
+var error = import_colors.default.red.bold;
+var bold = import_colors.default.bold;
+var green = import_colors.default.green;
+var italics = import_colors.default.italic;
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  saveOutcome,
+  testPages,
+  utils
+});

package/dist/index.mjs

@@ -0,0 +1,197 @@
+var __defProp = Object.defineProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+
+// src/lib/axe-test-urls.ts
+import AxeBuilder from "@axe-core/webdriverjs";
+var testPages = async (urls, config, events) => {
+  const driver = await config.driver;
+  if (urls.length === 0) {
+    await driver.quit();
+    return Promise.resolve([]);
+  }
+  return new Promise((resolve, reject) => {
+    const currentUrl = urls[0].replace(/[,;]$/, "");
+    if (events?.onTestStart) {
+      events?.onTestStart(currentUrl);
+    }
+    if (config.timer) {
+      events?.startTimer("axe page load time");
+    }
+    driver.get(currentUrl).then(() => {
+      if (config.timer) {
+        events?.endTimer("axe page load time");
+      }
+      if (config.loadDelay) {
+        events?.waitingMessage(config.loadDelay);
+      }
+      return new Promise((resolve2) => {
+        setTimeout(resolve2, config.loadDelay);
+      });
+    }).then(() => {
+      const axe = new AxeBuilder(driver, config.axeSource);
+      if (Array.isArray(config.include)) {
+        config.include.forEach((include) => axe.include(include));
+      }
+      if (Array.isArray(config.exclude)) {
+        config.exclude.forEach((exclude) => axe.exclude(exclude));
+      }
+      if (config.tags) {
+        axe.withTags(config.tags);
+      } else if (config.rules) {
+        axe.withRules(config.rules);
+      }
+      if (config.disable) {
+        axe.disableRules(config.disable);
+      }
+      if (config.timer) {
+        events?.startTimer("axe-core execution time");
+      }
+      axe.analyze((err, results) => {
+        if (config.timer) {
+          events?.endTimer("axe-core execution time");
+        }
+        if (err) {
+          return reject(err);
+        }
+        if (events?.onTestComplete) {
+          events?.onTestComplete(results);
+        }
+        testPages(urls.slice(1), config, events).then((out) => {
+          resolve([results].concat(out));
+        });
+      });
+    }).catch(async (e) => {
+      await driver.quit();
+      reject(e);
+    });
+  });
+};
+var axe_test_urls_default = testPages;
+
+// src/lib/utils.ts
+var utils_exports = {};
+__export(utils_exports, {
+  bold: () => bold,
+  error: () => error,
+  getAxeSource: () => getAxeSource,
+  getAxeVersion: () => getAxeVersion,
+  green: () => green,
+  italics: () => italics,
+  link: () => link,
+  parseBrowser: () => parseBrowser,
+  parseUrl: () => parseUrl,
+  reporter: () => reporter,
+  saveOutcome: () => saveOutcome,
+  selectorToString: () => selectorToString,
+  splitList: () => splitList
+});
+import fs from "fs";
+import path from "path";
+import colors from "colors";
+var saveOutcome = (outcome, fileName, dir) => {
+  if (typeof fileName !== "string") {
+    fileName = "axe-results-" + Date.now() + ".json";
+  }
+  if (typeof dir !== "string") {
+    dir = process.cwd();
+  } else if (!path.isAbsolute(dir)) {
+    dir = path.join(process.cwd(), dir);
+  }
+  const filePath = path.join(dir, fileName);
+  if (!fs.existsSync(filePath)) {
+    fs.mkdirSync(dir, { recursive: true });
+  }
+  fs.writeFileSync(filePath, JSON.stringify(outcome, null, 2), "utf-8");
+  return filePath;
+};
+var parseUrl = (url) => {
+  if (!/[a-z]+:\/\//.test(url)) {
+    return "http://" + url;
+  }
+  return url;
+};
+var parseBrowser = (browser) => {
+  if (!browser) {
+    return "chrome-headless";
+  }
+  const l = browser.length;
+  switch (browser.toLowerCase()) {
+    case "ff":
+    case "firefox".substr(0, l):
+    case "gecko".substr(0, l):
+    case "marionette".substr(0, l):
+      return "firefox";
+    case "chrome".substr(0, l):
+      return "chrome";
+    case "ie":
+    case "explorer".substr(0, l):
+    case "internetexplorer".substr(0, l):
+    case "internet_explorer".substr(0, l):
+    case "internet-explorer".substr(0, l):
+      return "ie";
+    case "safari".substr(0, l):
+      return "safari";
+    case "edge".substr(0, l):
+    case "microsoftedge".substr(0, l):
+      return "MicrosoftEdge";
+    default:
+      throw new Error("Unknown browser " + browser);
+  }
+};
+var getAxeSource = (axePath) => {
+  if (axePath && !fs.existsSync(axePath)) {
+    return;
+  }
+  if (!axePath) {
+    axePath = path.join(process.cwd(), "axe.js");
+  }
+  if (!fs.existsSync(axePath)) {
+    axePath = path.join(process.cwd(), "node_modules", "axe-core", "axe.js");
+  }
+  if (!fs.existsSync(axePath)) {
+    axePath = path.join(
+      __dirname,
+      "..",
+      "..",
+      "..",
+      "node_modules",
+      "axe-core",
+      "axe.js"
+    );
+  }
+  return fs.readFileSync(axePath, "utf-8");
+};
+var getAxeVersion = (source) => {
+  const match = source.match(/\.version\s*=\s'([^']+)'/);
+  return match ? match[1] : "unknown version";
+};
+var splitList = (val) => {
+  return val.split(/[,;]/).map((str) => str.trim());
+};
+var selectorToString = (selectors, separator) => {
+  separator = separator || " ";
+  return selectors.reduce((prev, curr) => prev.concat(curr), []).join(separator);
+};
+var reporter = (noReporter, silentMode) => {
+  if (!noReporter || silentMode) {
+    return () => {
+    };
+  } else {
+    return (...args) => {
+      console.log(...args);
+    };
+  }
+};
+var link = colors.underline.blue;
+var error = colors.red.bold;
+var bold = colors.bold;
+var green = colors.green;
+var italics = colors.italic;
+export {
+  saveOutcome,
+  axe_test_urls_default as testPages,
+  utils_exports as utils
+};

package/esmTest.mjs

@@ -0,0 +1,6 @@
+import { testPages } from './dist/index.mjs';
+import assert from 'assert';
+
+const exportIsFunction = typeof(testPages) === 'function';
+assert(exportIsFunction, 'export is not a function');
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@axe-core/cli",
-  "version": "4.6.2-alpha.378+d418d09",
+  "version": "4.6.2-alpha.380+076bfa9",
   "description": "A CLI for accessibility testing using axe-core",
   "author": {
     "name": "Wilco Fiers",
@@ -17,10 +17,18 @@
     "url": "https://github.com/dequelabs/axe-core-npm.git"
   },
   "license": "MPL-2.0",
-  "main": "dist/src/lib/index.js",
-  "typings": "dist/src/types.d.ts",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
   "bin": {
-    "axe": "./dist/src/bin/cli.js"
+    "axe": "./dist/cli.js"
   },
   "publishConfig": {
     "access": "public"
@@ -30,8 +38,9 @@
   },
   "scripts": {
     "prebuild": "rimraf dist",
-    "build": "tsc",
+    "build": "tsup src/lib/index.ts --dts --format esm,cjs && tsup src/bin/cli.ts --format cjs",
     "test": "mocha --timeout 60000 -r ts-node/register 'src/**/**.test.ts'",
+    "test:esm": "node esmTest.mjs",
     "coverage": "nyc npm run test",
     "prepare": "npm run build"
   },
@@ -44,9 +53,9 @@
     "testing"
   ],
   "dependencies": {
-    "@axe-core/webdriverjs": "4.6.2-alpha.378+d418d09",
+    "@axe-core/webdriverjs": "4.6.2-alpha.380+076bfa9",
     "axe-core": "^4.7.0",
-    "chromedriver": "^111.0.0",
+    "chromedriver": "^112.0.0",
     "colors": "^1.4.0",
     "commander": "^9.4.1",
     "selenium-webdriver": "^4.8.1"
@@ -65,6 +74,7 @@
     "rimraf": "^3.0.2",
     "tempy": "1.0.0",
     "ts-node": "^10.9.1",
+    "tsup": "^6.7.0",
     "typescript": "^4.8.4"
   },
   "nyc": {
@@ -78,7 +88,7 @@
     ],
     "statements": 95,
     "branches": 92,
-    "functions": 100,
+    "functions": 94,
     "lines": 95,
     "exclude": [
       "dist",
@@ -87,5 +97,5 @@
       "src/testutils"
     ]
   },
-  "gitHead": "d418d093b4c462d5d60e0f7ad3d5147bcaf52aa2"
+  "gitHead": "076bfa99f27f416b4eaff6d24cc23e8573fc72ee"
 }

package/src/lib/axe-test-urls.test.ts

@@ -43,29 +43,6 @@ describe('testPages', function () {
     assert.deepEqual(urlsCalled, urls);
   });
 
-  it('waits until the document is ready to have a className added', async () => {
-    const asyncScripts: string[] = [];
-    let waitCalls = 0;
-
-    mockDriver.executeAsyncScript = async (script: string) => {
-      asyncScripts.push(script);
-      return '{}';
-    };
-    mockDriver.wait = async (script: string) => {
-      waitCalls++;
-      return script;
-    };
-
-    await testPages(['http://foo'], config);
-    const script = asyncScripts.find(scr => {
-      return scr.match(
-        /script\.innerHTML\s*=[\s\S]*['"]document\.documentElement\.classList\.add\(['"]deque-axe-is-ready/
-      );
-    });
-    assert.isDefined(script);
-    assert.equal(waitCalls, 1);
-  });
-
   it('injects axe into the page', async () => {
     const scripts: string[] = [];
     config.axeSource = 'axe="hi, I am axe"';

package/src/lib/axe-test-urls.ts

@@ -28,23 +28,6 @@ const testPages = async (
 
     driver
       .get(currentUrl)
-      .then(() => {
-        return driver.executeAsyncScript(`
-          const callback = arguments[arguments.length - 1];
-          const script = document.createElement('script');
-          script.innerHTML = 'document.documentElement.classList.add("deque-axe-is-ready");'
-          document.documentElement.appendChild(script);
-          callback();
-      `);
-      })
-      .then(() => {
-        return driver.wait(
-          WebDriver.until.elementsLocated(
-            WebDriver.By.css('.deque-axe-is-ready')
-          ),
-          10000
-        );
-      })
       .then(() => {
         if (config.timer) {
           events?.endTimer('axe page load time');

package/tsconfig.json

@@ -5,14 +5,21 @@
     "sourceMap": true,
     "noImplicitAny": true,
     "strictNullChecks": true,
-    "module": "commonjs",
-    "target": "es2015",
+    "moduleResolution": "node",
     "resolveJsonModule": true,
+    "module": "esnext",
+    "target": "esnext",
     "allowJs": true,
-    "lib": ["dom", "es2015", "esnext.asynciterable"],
+    "lib": ["dom", "esnext", "esnext.asynciterable"],
     "esModuleInterop": true,
     "skipLibCheck": true,
     "declaration": true
   },
+  "ts-node": {
+    "compilerOptions": {
+      "module": "commonjs",
+      "target": "es5"
+    }
+  },
   "include": ["./src/lib", "./src/bin"]
 }

package/dist/package.json

@@ -1,91 +0,0 @@
-{
-    "name": "@axe-core/cli",
-    "version": "4.6.2-alpha.378+d418d09",
-    "description": "A CLI for accessibility testing using axe-core",
-    "author": {
-        "name": "Wilco Fiers",
-        "organization": "Deque Systems, Inc.",
-        "url": "http://github.com/wilcofiers/"
-    },
-    "contributors": [
-        {
-            "name": "Michael Siek (me@michaelsiek.com)"
-        }
-    ],
-    "repository": {
-        "type": "git",
-        "url": "https://github.com/dequelabs/axe-core-npm.git"
-    },
-    "license": "MPL-2.0",
-    "main": "dist/src/lib/index.js",
-    "typings": "dist/src/types.d.ts",
-    "bin": {
-        "axe": "./dist/src/bin/cli.js"
-    },
-    "publishConfig": {
-        "access": "public"
-    },
-    "engines": {
-        "node": ">=8"
-    },
-    "scripts": {
-        "prebuild": "rimraf dist",
-        "build": "tsc",
-        "test": "mocha --timeout 60000 -r ts-node/register 'src/**/**.test.ts'",
-        "coverage": "nyc npm run test",
-        "prepare": "npm run build"
-    },
-    "keywords": [
-        "axe-core",
-        "accessibility",
-        "a11y",
-        "wcag",
-        "cli",
-        "testing"
-    ],
-    "dependencies": {
-        "@axe-core/webdriverjs": "4.6.2-alpha.378+d418d09",
-        "axe-core": "^4.7.0",
-        "chromedriver": "^111.0.0",
-        "colors": "^1.4.0",
-        "commander": "^9.4.1",
-        "selenium-webdriver": "^4.8.1"
-    },
-    "devDependencies": {
-        "@types/chai": "^4.3.3",
-        "@types/chromedriver": "^81.0.1",
-        "@types/mocha": "^10.0.0",
-        "@types/mock-fs": "^4.13.1",
-        "@types/selenium-webdriver": "^4.1.5",
-        "chai": "^4.3.6",
-        "execa": "5.1.0",
-        "mocha": "^10.0.0",
-        "mock-fs": "^5.1.4",
-        "nyc": "^15.1.0",
-        "rimraf": "^3.0.2",
-        "tempy": "1.0.0",
-        "ts-node": "^10.9.1",
-        "typescript": "^4.8.4"
-    },
-    "nyc": {
-        "checkCoverage": true,
-        "extension": [
-            ".ts"
-        ],
-        "reporter": [
-            "text-summary",
-            "html"
-        ],
-        "statements": 95,
-        "branches": 92,
-        "functions": 100,
-        "lines": 95,
-        "exclude": [
-            "dist",
-            "coverage",
-            "**/*.test.ts",
-            "src/testutils"
-        ]
-    },
-    "gitHead": "d418d093b4c462d5d60e0f7ad3d5147bcaf52aa2"
-}

package/dist/src/bin/cli.d.ts

@@ -1,2 +0,0 @@
-#!/usr/bin/env node
-export {};