@axe-core/cli 4.7.2-alpha.388 → 4.7.2-alpha.390

package/dist/cli.js

@@ -1,464 +0,0 @@
-#!/usr/bin/env node
-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 __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
-));
-
-// src/bin/cli.ts
-var import_commander = require("commander");
-
-// package.json
-var version = "4.7.2-alpha.388+23701dc";
-
-// src/lib/utils.ts
-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;
-
-// src/bin/index.ts
-var import_colors2 = __toESM(require("colors"));
-
-// 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/events.ts
-var events_default = ({
-  silentMode,
-  timer,
-  cliReporter,
-  verbose,
-  exit
-}) => {
-  return {
-    startTimer: (message) => {
-      console.time(message);
-    },
-    endTimer: (message) => {
-      console.timeEnd(message);
-    },
-    waitingMessage: (loadDelayTime) => {
-      console.log(
-        "Waiting for " + loadDelayTime + " milliseconds after page loads..."
-      );
-    },
-    onTestStart: (url) => {
-      if (silentMode) {
-        return;
-      }
-      console.log(
-        bold("\nTesting " + link(url)) + " ... please wait, this may take a minute."
-      );
-      if (timer) {
-        console.time("Total test time");
-      }
-    },
-    onTestComplete: (results) => {
-      const { violations, testEngine, testEnvironment, testRunner } = results;
-      if (violations.length === 0) {
-        cliReporter(green(" 0 violations found!"));
-        return;
-      }
-      const issueCount = violations.reduce((count, violation) => {
-        cliReporter(
-          "\n" + error("  Violation of %j with %d occurrences!\n") + "    %s. Correct invalid elements at:\n" + violation.nodes.map((node) => "     - " + selectorToString(node.target) + "\n").join("") + "    For details, see: %s",
-          violation.id,
-          violation.nodes.length,
-          violation.description,
-          link(violation.helpUrl.split("?")[0])
-        );
-        return count + violation.nodes.length;
-      }, 0);
-      cliReporter(error("\n%d Accessibility issues detected."), issueCount);
-      if (verbose) {
-        const metadata = {
-          "Test Runner": testRunner,
-          "Test Engine": testEngine,
-          "Test Environment": testEnvironment
-        };
-        cliReporter(`
-${JSON.stringify(metadata, null, 2)}`);
-      }
-      if (exit) {
-        process.exit(1);
-      }
-    }
-  };
-};
-
-// src/lib/webdriver.ts
-var import_chromedriver = __toESM(require("chromedriver"));
-var import_selenium_webdriver = require("selenium-webdriver");
-var import_chrome = __toESM(require("selenium-webdriver/chrome"));
-var startDriver = async (config) => {
-  const scriptTimeout = config.timeout * 1e3;
-  let builder;
-  if (config.browser === "chrome-headless") {
-    const service = new import_chrome.default.ServiceBuilder(
-      config.chromedriverPath || import_chromedriver.default.path
-    );
-    let options = new import_chrome.default.Options().headless();
-    if (config.chromeOptions?.length) {
-      options = config.chromeOptions.reduce(function(options2, arg) {
-        return options2.addArguments(arg);
-      }, options);
-    }
-    builder = new import_selenium_webdriver.Builder().forBrowser("chrome").setChromeOptions(options).setChromeService(service);
-  } else {
-    builder = new import_selenium_webdriver.Builder().forBrowser(config.browser);
-  }
-  config.builder = builder;
-  const driver = builder.build();
-  await driver.manage().setTimeouts({ script: scriptTimeout });
-  return driver;
-};
-
-// src/bin/index.ts
-var cli = async (args, url) => {
-  const {
-    save,
-    stdout,
-    dir,
-    exit,
-    timer,
-    reporter: noReporter,
-    chromeOptions,
-    verbose,
-    timeout,
-    include,
-    exclude,
-    tags,
-    rules,
-    disable,
-    loadDelay,
-    chromedriverPath
-  } = args;
-  const showErrors = args.showErrors === true;
-  const silentMode = !!stdout;
-  args.axeSource = getAxeSource(args.axeSource);
-  if (!args.axeSource) {
-    console.error(error("Unable to find the axe-core source file"));
-    process.exit(2);
-  }
-  args.browser = parseBrowser(args.browser);
-  if (chromeOptions) {
-    if (args.browser !== "chrome-headless") {
-      console.error(
-        error(
-          "You may only provide --chrome-options when using headless chrome"
-        )
-      );
-      process.exit(2);
-    }
-  }
-  const driverConfigs = {
-    browser: args.browser,
-    timeout,
-    chromeOptions,
-    chromedriverPath
-  };
-  args.driver = startDriver(driverConfigs);
-  const cliReporter = reporter(noReporter, silentMode);
-  const axeVersion = getAxeVersion(args.axeSource);
-  if (!silentMode) {
-    console.log(
-      import_colors2.default.bold("Running axe-core " + axeVersion + " in " + args.browser)
-    );
-  }
-  const urls = url.args.map(parseUrl);
-  if (urls.length === 0) {
-    console.error(error("No url was specified. Check `axe --help` for help\n"));
-  }
-  const events = events_default({
-    silentMode,
-    timer,
-    cliReporter,
-    verbose,
-    exit
-  });
-  const testPageConfigParams = {
-    driver: args.driver,
-    timer,
-    loadDelay,
-    axeSource: args.axeSource,
-    include,
-    exclude,
-    tags,
-    rules,
-    disable
-  };
-  try {
-    const outcome = await axe_test_urls_default(urls, testPageConfigParams, events);
-    if (silentMode) {
-      process.stdout.write(JSON.stringify(outcome, null, 2));
-      return;
-    }
-    if (timer) {
-      console.timeEnd("Total test time");
-    }
-    if (Array.isArray(outcome)) {
-      console.log(bold("Testing complete of %d pages\n"), outcome.length);
-    }
-    if (save || dir) {
-      try {
-        const fileName = saveOutcome(outcome, save, dir);
-        console.log("Saved file at", fileName, "\n");
-      } catch (e) {
-        console.error(error("Unable to save file!\n") + e);
-        process.exit(1);
-      }
-    }
-    if (silentMode) {
-      return;
-    }
-    console.log(
-      italics(
-        "Please note that only 20% to 50% of all accessibility issues can automatically be detected. \nManual testing is always required. For more information see:\n%s\n"
-      ),
-      link("https://dequeuniversity.com/curriculum/courses/testingmethods")
-    );
-  } catch (e) {
-    if (!showErrors) {
-      console.error(error("An error occurred while testing this page."));
-    } else {
-      console.error(error("Error: %s"), e);
-    }
-    console.error(
-      "Please report the problem to: " + link("https://github.com/dequelabs/axe-core-npm/issues/") + "\n"
-    );
-    process.exit(1);
-  }
-};
-var bin_default = cli;
-
-// src/bin/cli.ts
-var program = new import_commander.Command();
-program.version(version).usage("<url...> [options]").option(
-  "-i, --include <list>",
-  "CSS selector of included elements, comma separated",
-  splitList
-).option(
-  "-e, --exclude <list>",
-  "CSS selector of excluded elements, comma separated",
-  splitList
-).option(
-  "-r, --rules <list>",
-  "IDs of rules to run, comma separated",
-  splitList
-).option(
-  "-t, --tags <list>",
-  "Tags of rules to run, comma separated",
-  splitList
-).option(
-  "-l, --disable <list>",
-  "IDs of rules to disable, comma separated",
-  splitList
-).option(
-  "-b, --browser [browser-name]",
-  "Which browser to run (Webdriver required)"
-).option(
-  "-s, --save [filename]",
-  "Save the output as a JSON file. Filename is optional"
-).option(
-  "-j, --stdout",
-  "Output results to STDOUT and silence all other output"
-).option("-d, --dir <path>", "Output directory").option("-a, --axe-source <path>", "Path to axe.js file").option("-q, --exit", "Exit with `1` failure code if any a11y tests fail").option(
-  "-v, --verbose",
-  "Output metadata like test tool name, version and environment"
-).option(
-  "--load-delay <n>",
-  "Set how much time (milliseconds) axe will wait after page load before running the audit (default: 0)"
-).option(
-  "--timeout <n>",
-  "Set how much time (seconds) axe has to run",
-  // @ts-ignore
-  90
-).option("--timer", "Log the time it takes to run").option("--show-errors [boolean]", "Display the full error stack", true).option("--no-reporter", "Turn the CLI reporter off").option(
-  "--chrome-options [options]",
-  "Options to provide to headless Chrome",
-  splitList
-).option(
-  "--chromedriver-path <path>",
-  "Absolute path to the desired chromedriver executable"
-).action(bin_default);
-program.parse(process.argv);

package/dist/index.d.ts

@@ -1,71 +0,0 @@
-import { AxeResults } from 'axe-core';
-import { WebDriver } from 'selenium-webdriver';
-import colors from 'colors';
-
-interface EventResponse {
-    startTimer: (message: string) => void;
-    endTimer: (message: string) => void;
-    waitingMessage: (loadDelayTime: number) => void;
-    onTestStart: (url: string) => void;
-    onTestComplete: (results: AxeResults) => void;
-}
-interface ConfigParams {
-    driver: WebDriver;
-    timer?: boolean;
-    loadDelay?: number;
-    axeSource?: string;
-    include?: string | string[];
-    exclude?: string | string[];
-    tags?: string | string[];
-    rules?: string | string[];
-    disable?: string | string[];
-}
-
-declare const testPages: (urls: string | string[], config: ConfigParams, events?: EventResponse) => Promise<AxeResults[] | AxeResults>;
-
-declare const saveOutcome: (outcome: AxeResults | AxeResults[], fileName?: string, dir?: string) => string;
-declare const parseUrl: (url: string) => string;
-declare const parseBrowser: (browser?: string) => string | Error;
-declare const getAxeSource: (axePath?: string) => string | void;
-declare const getAxeVersion: (source: string) => string;
-declare const splitList: (val: string) => string[];
-declare const selectorToString: (selectors: string[], separator?: string) => string;
-declare const reporter: (noReporter: boolean, silentMode: boolean) => (() => void);
-declare const link: colors.Color;
-declare const error: colors.Color;
-declare const bold: colors.Color;
-declare const green: colors.Color;
-declare const italics: colors.Color;
-
-declare const utils_bold: typeof bold;
-declare const utils_error: typeof error;
-declare const utils_getAxeSource: typeof getAxeSource;
-declare const utils_getAxeVersion: typeof getAxeVersion;
-declare const utils_green: typeof green;
-declare const utils_italics: typeof italics;
-declare const utils_link: typeof link;
-declare const utils_parseBrowser: typeof parseBrowser;
-declare const utils_parseUrl: typeof parseUrl;
-declare const utils_reporter: typeof reporter;
-declare const utils_saveOutcome: typeof saveOutcome;
-declare const utils_selectorToString: typeof selectorToString;
-declare const utils_splitList: typeof splitList;
-declare namespace utils {
-  export {
-    utils_bold as bold,
-    utils_error as error,
-    utils_getAxeSource as getAxeSource,
-    utils_getAxeVersion as getAxeVersion,
-    utils_green as green,
-    utils_italics as italics,
-    utils_link as link,
-    utils_parseBrowser as parseBrowser,
-    utils_parseUrl as parseUrl,
-    utils_reporter as reporter,
-    utils_saveOutcome as saveOutcome,
-    utils_selectorToString as selectorToString,
-    utils_splitList as splitList,
-  };
-}
-
-export { saveOutcome, testPages, utils };