@axe-core/cli 4.7.4-alpha.409 → 4.7.4-f03670b.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@axe-core/cli",
-  "version": "4.7.4-alpha.409+eb99c15",
+  "version": "4.7.4-f03670b.0+f03670b",
   "description": "A CLI for accessibility testing using axe-core",
   "author": {
     "name": "Wilco Fiers",
@@ -32,8 +32,7 @@
     "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"
+    "coverage": "nyc npm run test"
   },
   "keywords": [
     "axe-core",
@@ -44,9 +43,9 @@
     "testing"
   ],
   "dependencies": {
-    "@axe-core/webdriverjs": "4.7.4-alpha.409+eb99c15",
-    "axe-core": "^4.7.0",
-    "chromedriver": "^113.0.0",
+    "@axe-core/webdriverjs": "4.7.4-f03670b.0+f03670b",
+    "axe-core": "~4.8.2",
+    "chromedriver": "latest",
     "colors": "^1.4.0",
     "commander": "^9.4.1",
     "selenium-webdriver": "^4.8.1"
@@ -55,15 +54,13 @@
     "@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",
+    "tempy": "^1.0.0",
     "ts-node": "^10.9.1",
     "typescript": "^4.8.4"
   },
@@ -77,7 +74,7 @@
       "html"
     ],
     "statements": 95,
-    "branches": 92,
+    "branches": 91,
     "functions": 94,
     "lines": 95,
     "exclude": [
@@ -87,5 +84,5 @@
       "src/testutils"
     ]
   },
-  "gitHead": "eb99c1571486f66cae42c417943b6e70f15ec582"
+  "gitHead": "f03670beb2c3f46c698a3d607de6bdae7565d79d"
 }

package/src/bin/cli.test.ts

@@ -391,7 +391,9 @@ describe('cli', () => {
     });
   });
 
-  describe('--chromedriver-path', () => {
+  // disabled during conversion to npm workspaces as the node_module install directory changed
+  // @see https://github.com/dequelabs/axe-core-npm/issues/822
+  describe.skip('--chromedriver-path', () => {
     it('should throw error if path does not exist', async () => {
       const result = await runCLI(
         `file://${SIMPLE_HTML_FILE}`,
@@ -404,4 +406,15 @@ describe('cli', () => {
       );
     });
   });
+
+  describe('--chrome-path', () => {
+    it('should throw error if path does not exist', async () => {
+      const result = await runCLI(
+        `file://${SIMPLE_HTML_FILE}`,
+        '--chrome-path="someinvalidpath"',
+        '--show-errors'
+      );
+      assert.include(result.stderr, 'no chrome binary at');
+    });
+  });
 });

package/src/bin/cli.ts

@@ -77,6 +77,10 @@ program
     '--chromedriver-path <path>',
     'Absolute path to the desired chromedriver executable'
   )
+  .option(
+    '--chrome-path <path>',
+    'Path to the desired chrome executable'
+  )
   .action(cli);
 
 program.parse(process.argv);

package/src/bin/index.ts

@@ -15,6 +15,7 @@ import {
 import axeTestUrls from '../lib/axe-test-urls';
 import event from '../lib/events';
 import { startDriver } from '../lib/webdriver';
+import { error as selenium_error } from 'selenium-webdriver';
 
 const cli = async (
   args: OptionValues,
@@ -36,7 +37,8 @@ const cli = async (
     rules,
     disable,
     loadDelay,
-    chromedriverPath
+    chromedriverPath,
+    chromePath
   } = args;
 
   const showErrors = args.showErrors === true;
@@ -67,7 +69,8 @@ const cli = async (
     browser: args.browser,
     timeout,
     chromeOptions,
-    chromedriverPath
+    chromedriverPath,
+    chromePath
   };
 
   args.driver = startDriver(driverConfigs);
@@ -106,8 +109,37 @@ const cli = async (
     rules,
     disable
   };
+  let outcome;
   try {
-    const outcome = await axeTestUrls(urls, testPageConfigParams, events);
+    try {
+      outcome = await axeTestUrls(urls, testPageConfigParams, events);
+    } catch (e) {
+      if (e instanceof selenium_error.ScriptTimeoutError) {
+        console.error(error('Error: %s'), e.message);
+        console.log(`The timeout is currently configured to be ${timeout} seconds (you can change it with --timeout).`)
+        process.exit(2);
+      }
+      // Provide a more user-friendly error message when there's a ChromeDriver/Chrome version mismatch.
+      else if (
+        e instanceof selenium_error.SessionNotCreatedError &&
+        e.message.includes(
+          'This version of ChromeDriver only supports'
+          // This string has to match the error message printed by chromedriver, see
+          // https://chromium.googlesource.com/chromium/src/+/refs/tags/110.0.5481.194/chrome/test/chromedriver/chrome_launcher.cc#300.
+        )
+      ) {
+        console.error(error('Error: %s'), e.message);
+        console.log(`\nPlease install a matching version of ChromeDriver and run axe with the --chromedriver-path option:
+
+    $ npm install -g chromedriver@<version>
+    $ axe --chromedriver-path $(npm root -g)/chromedriver/bin/chromedriver <url...>
+
+(where <version> is the first number of the "current browser version" reported above.)`);
+        process.exit(2);
+      } else {
+        throw e;
+      }
+    }
     if (silentMode) {
       process.stdout.write(JSON.stringify(outcome, null, 2));
       return;

package/src/lib/utils.test.ts

@@ -1,6 +1,8 @@
 import 'mocha';
 import { assert } from 'chai';
-import mock = require('mock-fs');
+import tempy from 'tempy';
+import { join } from 'path';
+import { mkdirSync, writeFileSync, rmSync } from 'fs';
 import { dependencies } from '../../package.json';
 import * as utils from './utils';
 
@@ -74,24 +76,52 @@ describe('utils', () => {
 
   describe('getAxeSource', () => {
     describe('mock file', () => {
-      beforeEach(() => {
-        mock({
-          '/node_modules/axe-core': {},
-          '../node_modules/axe-core': {
-            'axe.js': mock.load(require.resolve('axe-core'))
-          }
-        });
-      });
+      function setupTree() {
+        const tempDir = tempy.directory();
+        const parentDirname = join(tempDir, 'node_modules', 'axe-core');
+        mkdirSync(parentDirname, { recursive: true });
+        writeFileSync(join(parentDirname, 'axe.js'), 'parent');
+
+        const cliDirname = join(tempDir, 'packages', 'cli');
+        const nodeModDirname = join(
+          cliDirname,
+          'node_modules',
+          'axe-core'
+        );
+        mkdirSync(nodeModDirname, { recursive: true });
+        writeFileSync(join(nodeModDirname, 'axe.js'), 'node modules');
+
+        const cwdDirname = join(tempDir, 'packages', 'cli', 'lib');
+        mkdirSync(cwdDirname);
+        writeFileSync(join(cwdDirname, 'axe.js'), 'cwd');
+        return {
+          cliDirname,
+          parentDirname,
+          nodeModDirname,
+          cwdDirname
+        };
+      }
 
-      afterEach(() => {
-        mock.restore();
+      it('uses axe.js from the working directory if it exists', () => {
+        const { cwdDirname } = setupTree();
+        const axeSource = utils.getAxeSource(undefined, cwdDirname);
+        assert.include(axeSource, 'cwd');
       });
-      it('fall back to use `locally` installed axe-core', () => {
-        const axeSource = utils.getAxeSource();
-        const axeVersionCheck = dependencies['axe-core'].replace('^', '');
-        assert.include(axeSource, axeVersionCheck);
+      it("falls back to axe-core from the working directory's node_modules if axe.js doesn't exist in the working directory", () => {
+        const { cliDirname, cwdDirname } = setupTree();
+        rmSync(join(cwdDirname, 'axe.js'));
+        const axeSource = utils.getAxeSource(undefined, cliDirname);
+        assert.include(axeSource, 'node modules');
+      });
+      it("falls back to axe-core from our own package's node_modules if no working-directory based implementation exists", () => {
+        const { cwdDirname, nodeModDirname } = setupTree();
+        rmSync(join(cwdDirname, 'axe.js'));
+        rmSync(join(nodeModDirname, 'axe.js'));
+        const axeSource = utils.getAxeSource(undefined, cwdDirname);
+        assert.include(axeSource, 'parent');
       });
     });
+
     it('given no axe source use local source', () => {
       const axeSource = utils.getAxeSource();
       assert.isNotNull(axeSource);

package/src/lib/utils.ts

@@ -1,7 +1,7 @@
 import fs from 'fs';
 import path from 'path';
 import colors from 'colors';
-import { AxeResults } from 'axe-core';
+import type { AxeResults, UnlabelledFrameSelector } from 'axe-core';
 
 export const saveOutcome = (
   outcome: AxeResults | AxeResults[],
@@ -70,35 +70,39 @@ export const parseBrowser = (browser?: string): string | Error => {
   }
 };
 
-export const getAxeSource = (axePath?: string): string | void => {
+export const getAxeSource = (
+  axePath?: string,
+  dirname?: string
+): string | void => {
   // Abort if axePath should exist, and it isn't
   if (axePath && !fs.existsSync(axePath)) {
     return;
   }
 
+  let cwd = dirname;
+  if (!cwd) {
+    cwd = process.cwd();
+  }
+
+  if (!dirname) {
+    dirname = __dirname;
+  }
+
   // Look for axe in current working directory
   if (!axePath) {
-    axePath = path.join(process.cwd(), 'axe.js');
+    axePath = path.join(cwd, 'axe.js');
   }
 
   if (!fs.existsSync(axePath)) {
     // Look for axe in CWD ./node_modules
-    axePath = path.join(process.cwd(), 'node_modules', 'axe-core', 'axe.js');
+    axePath = path.join(cwd, 'node_modules', 'axe-core', 'axe.js');
   }
 
   if (!fs.existsSync(axePath)) {
-    // `__dirname` is /@axe-core/cli/dist/src/lib when installed globally
-    // to access the locally installed axe-core package we need to go up 3 levels
-    // if all else fails, use the locally installed axe
-    axePath = path.join(
-      __dirname,
-      '..',
-      '..',
-      '..',
-      'node_modules',
-      'axe-core',
-      'axe.js'
-    );
+    // in local develop using npm workspaces axe-core is
+    // hoisted to the root, but when published axe-core
+    // will be in the node_modules for the cli
+    axePath = require.resolve('axe-core/axe.js');
   }
 
   return fs.readFileSync(axePath, 'utf-8');
@@ -114,7 +118,7 @@ export const splitList = (val: string): string[] => {
 };
 
 export const selectorToString = (
-  selectors: string[],
+  selectors: UnlabelledFrameSelector,
   separator?: string
 ): string => {
   separator = separator || ' ';

package/src/lib/webdriver.ts

@@ -1,3 +1,4 @@
+import path from 'path';
 import chromedriver from 'chromedriver';
 import { Builder, type WebDriver } from 'selenium-webdriver';
 import chrome from 'selenium-webdriver/chrome';
@@ -21,6 +22,10 @@ const startDriver = async (
       }, options);
     }
 
+    if (config.chromePath) {
+      options.setChromeBinaryPath(path.resolve(config.chromePath));
+    }
+
     builder = new Builder()
       .forBrowser('chrome')
       .setChromeOptions(options)

package/src/types.ts

@@ -23,6 +23,7 @@ export interface WebdriverConfigParams {
   browser: string;
   timeout: number;
   chromedriverPath?: string;
+  chromePath?: string;
   path?: string;
   chromeOptions?: string[];
   builder?: Builder;

package/dist/package.json

@@ -1,91 +0,0 @@
-{
-    "name": "@axe-core/cli",
-    "version": "4.7.4-alpha.409+eb99c15",
-    "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.7.4-alpha.409+eb99c15",
-        "axe-core": "^4.7.0",
-        "chromedriver": "^113.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": 94,
-        "lines": 95,
-        "exclude": [
-            "dist",
-            "coverage",
-            "**/*.test.ts",
-            "src/testutils"
-        ]
-    },
-    "gitHead": "eb99c1571486f66cae42c417943b6e70f15ec582"
-}

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

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

package/dist/src/bin/cli.js

@@ -1,39 +0,0 @@
-#!/usr/bin/env node
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const commander_1 = require("commander");
-const package_json_1 = require("../../package.json");
-const utils_1 = require("../lib/utils");
-const _1 = __importDefault(require("."));
-const program = new commander_1.Command();
-program
-    .version(package_json_1.version)
-    .usage('<url...> [options]')
-    .option('-i, --include <list>', 'CSS selector of included elements, comma separated', utils_1.splitList)
-    .option('-e, --exclude <list>', 'CSS selector of excluded elements, comma separated', utils_1.splitList)
-    .option('-r, --rules <list>', 'IDs of rules to run, comma separated', utils_1.splitList)
-    .option('-t, --tags <list>', 'Tags of rules to run, comma separated', utils_1.splitList)
-    .option('-l, --disable <list>', 'IDs of rules to disable, comma separated', utils_1.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)
-    // TODO: Replace this with a reporter option, this required adding
-    .option('--no-reporter', 'Turn the CLI reporter off')
-    .option('--chrome-options [options]', 'Options to provide to headless Chrome', utils_1.splitList)
-    .option('--chromedriver-path <path>', 'Absolute path to the desired chromedriver executable')
-    .action(_1.default);
-program.parse(process.argv);
-//# sourceMappingURL=cli.js.map

package/dist/src/bin/cli.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"cli.js","sourceRoot":"","sources":["../../../src/bin/cli.ts"],"names":[],"mappings":";;;;;;AAEA,yCAAoC;AACpC,qDAA6C;AAC7C,wCAAyC;AACzC,yCAAoB;AAEpB,MAAM,OAAO,GAAG,IAAI,mBAAO,EAAE,CAAC;AAE9B,OAAO;KACJ,OAAO,CAAC,sBAAO,CAAC;KAChB,KAAK,CAAC,oBAAoB,CAAC;KAC3B,MAAM,CACL,sBAAsB,EACtB,oDAAoD,EACpD,iBAAS,CACV;KACA,MAAM,CACL,sBAAsB,EACtB,oDAAoD,EACpD,iBAAS,CACV;KACA,MAAM,CACL,oBAAoB,EACpB,sCAAsC,EACtC,iBAAS,CACV;KACA,MAAM,CACL,mBAAmB,EACnB,uCAAuC,EACvC,iBAAS,CACV;KACA,MAAM,CACL,sBAAsB,EACtB,0CAA0C,EAC1C,iBAAS,CACV;KACA,MAAM,CACL,8BAA8B,EAC9B,2CAA2C,CAC5C;KACA,MAAM,CACL,uBAAuB,EACvB,sDAAsD,CACvD;KACA,MAAM,CACL,cAAc,EACd,uDAAuD,CACxD;KACA,MAAM,CAAC,kBAAkB,EAAE,kBAAkB,CAAC;KAC9C,MAAM,CAAC,yBAAyB,EAAE,qBAAqB,CAAC;KACxD,MAAM,CAAC,YAAY,EAAE,mDAAmD,CAAC;KACzE,MAAM,CACL,eAAe,EACf,8DAA8D,CAC/D;KACA,MAAM,CACL,kBAAkB,EAClB,sGAAsG,CACvG;KACA,MAAM,CACL,eAAe,EACf,4CAA4C;AAC5C,aAAa;AACb,EAAE,CACH;KACA,MAAM,CAAC,SAAS,EAAE,8BAA8B,CAAC;KACjD,MAAM,CAAC,yBAAyB,EAAE,8BAA8B,EAAE,IAAI,CAAC;IACxE,kEAAkE;KACjE,MAAM,CAAC,eAAe,EAAE,2BAA2B,CAAC;KACpD,MAAM,CACL,4BAA4B,EAC5B,uCAAuC,EACvC,iBAAS,CACV;KACA,MAAM,CACL,4BAA4B,EAC5B,sDAAsD,CACvD;KACA,MAAM,CAAC,UAAG,CAAC,CAAC;AAEf,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC"}

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

@@ -1 +0,0 @@
-import 'mocha';