@axe-core/cli 4.7.3 → 4.7.4-2456ed6.0

package/CHANGELOG.md

@@ -7,82 +7,48 @@ See [Conventional Commits](https://conventionalcommits.org) for commit guideline
 
 **Note:** Version bump only for package @axe-core/cli
 
-
-
-
-
 ## [4.7.2](https://github.com/dequelabs/axe-core-npm/compare/v4.7.1...v4.7.2) (2023-06-01)
 
-
 ### Bug Fixes
 
-* **packages/cli:** revert ESM ([#730](https://github.com/dequelabs/axe-core-npm/issues/730)) ([4e1fb95](https://github.com/dequelabs/axe-core-npm/commit/4e1fb958fa251db7eea3433f91f2a2f3adbda1e8))
-
-
-
-
+- **packages/cli:** revert ESM ([#730](https://github.com/dequelabs/axe-core-npm/issues/730)) ([4e1fb95](https://github.com/dequelabs/axe-core-npm/commit/4e1fb958fa251db7eea3433f91f2a2f3adbda1e8))
 
 ## [4.7.1](https://github.com/dequelabs/axe-core-npm/compare/v4.7.0...v4.7.1) (2023-05-02)
 
 **Note:** Version bump only for package @axe-core/cli
 
-
-
-
-
 # [4.7.0](https://github.com/dequelabs/axe-core-npm/compare/v4.6.1...v4.7.0) (2023-04-28)
 
-
 ### Bug Fixes
 
-* **cli:** do not inject script tags due to pages not allowing script tags ([#710](https://github.com/dequelabs/axe-core-npm/issues/710)) ([2e0fdb4](https://github.com/dequelabs/axe-core-npm/commit/2e0fdb4a4661040b9b8dbb91bed1a96142e4fe0c))
-
+- **cli:** do not inject script tags due to pages not allowing script tags ([#710](https://github.com/dequelabs/axe-core-npm/issues/710)) ([2e0fdb4](https://github.com/dequelabs/axe-core-npm/commit/2e0fdb4a4661040b9b8dbb91bed1a96142e4fe0c))
 
 ### Features
 
-* enable esm import ([#713](https://github.com/dequelabs/axe-core-npm/issues/713)) ([076bfa9](https://github.com/dequelabs/axe-core-npm/commit/076bfa99f27f416b4eaff6d24cc23e8573fc72ee))
-* Update axe-core to v4.7.0 ([#709](https://github.com/dequelabs/axe-core-npm/issues/709)) ([d418d09](https://github.com/dequelabs/axe-core-npm/commit/d418d093b4c462d5d60e0f7ad3d5147bcaf52aa2))
-
-
-
-
+- enable esm import ([#713](https://github.com/dequelabs/axe-core-npm/issues/713)) ([076bfa9](https://github.com/dequelabs/axe-core-npm/commit/076bfa99f27f416b4eaff6d24cc23e8573fc72ee))
+- Update axe-core to v4.7.0 ([#709](https://github.com/dequelabs/axe-core-npm/issues/709)) ([d418d09](https://github.com/dequelabs/axe-core-npm/commit/d418d093b4c462d5d60e0f7ad3d5147bcaf52aa2))
 
 ## [4.6.1](https://github.com/dequelabs/axe-core-npm/compare/v4.6.0...v4.6.1) (2023-03-28)
 
-
 ### Bug Fixes
 
-* **cli:** increase --timeout default to 90 seconds (to match --help) ([#683](https://github.com/dequelabs/axe-core-npm/issues/683)) ([d11481b](https://github.com/dequelabs/axe-core-npm/commit/d11481b8c74598617260586fe14c8ceba32c6792))
-* Update axe-core to v4.6.3 ([#698](https://github.com/dequelabs/axe-core-npm/issues/698)) ([a7d53a4](https://github.com/dequelabs/axe-core-npm/commit/a7d53a4876237c74bb8dc2836b703cdaf2f7ace5))
-
-
-
-
+- **cli:** increase --timeout default to 90 seconds (to match --help) ([#683](https://github.com/dequelabs/axe-core-npm/issues/683)) ([d11481b](https://github.com/dequelabs/axe-core-npm/commit/d11481b8c74598617260586fe14c8ceba32c6792))
+- Update axe-core to v4.6.3 ([#698](https://github.com/dequelabs/axe-core-npm/issues/698)) ([a7d53a4](https://github.com/dequelabs/axe-core-npm/commit/a7d53a4876237c74bb8dc2836b703cdaf2f7ace5))
 
 # [4.6.0](https://github.com/dequelabs/axe-core-npm/compare/v4.5.2...v4.6.0) (2023-01-19)
 
-
 ### Features
 
-* support shadow dom selectors ([#619](https://github.com/dequelabs/axe-core-npm/issues/619)) ([6065b56](https://github.com/dequelabs/axe-core-npm/commit/6065b562adf289341033a7233426ba3dcfb8a24b))
-* Update axe-core to v4.6.1 ([#633](https://github.com/dequelabs/axe-core-npm/issues/633)) ([8bab5b2](https://github.com/dequelabs/axe-core-npm/commit/8bab5b23b3653a6a0603f10d889e22418a4fff3e))
-
-
-
-
+- support shadow dom selectors ([#619](https://github.com/dequelabs/axe-core-npm/issues/619)) ([6065b56](https://github.com/dequelabs/axe-core-npm/commit/6065b562adf289341033a7233426ba3dcfb8a24b))
+- Update axe-core to v4.6.1 ([#633](https://github.com/dequelabs/axe-core-npm/issues/633)) ([8bab5b2](https://github.com/dequelabs/axe-core-npm/commit/8bab5b23b3653a6a0603f10d889e22418a4fff3e))
 
 ## [4.5.2](https://github.com/dequelabs/axe-core-npm/compare/v4.5.1...v4.5.2) (2022-11-15)
 
-
 ### Bug Fixes
 
-* **cli:** include all functions in types file ([#603](https://github.com/dequelabs/axe-core-npm/issues/603)) ([30042ef](https://github.com/dequelabs/axe-core-npm/commit/30042ef3acc0cab7f67ddcf284df089f243f53e6))
-* **cli:** use correct driver typings ([#604](https://github.com/dequelabs/axe-core-npm/issues/604)) ([d33bbdf](https://github.com/dequelabs/axe-core-npm/commit/d33bbdf2b3d05c3ba0106d717ba1c8d706c5e05c))
-* update to use axe-core 4.5.2 ([#607](https://github.com/dequelabs/axe-core-npm/issues/607)) ([61312ff](https://github.com/dequelabs/axe-core-npm/commit/61312fff2e9ee4e0f218a29a1608f69b45206fad))
-
-
-
-
+- **cli:** include all functions in types file ([#603](https://github.com/dequelabs/axe-core-npm/issues/603)) ([30042ef](https://github.com/dequelabs/axe-core-npm/commit/30042ef3acc0cab7f67ddcf284df089f243f53e6))
+- **cli:** use correct driver typings ([#604](https://github.com/dequelabs/axe-core-npm/issues/604)) ([d33bbdf](https://github.com/dequelabs/axe-core-npm/commit/d33bbdf2b3d05c3ba0106d717ba1c8d706c5e05c))
+- update to use axe-core 4.5.2 ([#607](https://github.com/dequelabs/axe-core-npm/issues/607)) ([61312ff](https://github.com/dequelabs/axe-core-npm/commit/61312fff2e9ee4e0f218a29a1608f69b45206fad))
 
 ## [4.5.1](https://github.com/dequelabs/axe-core-npm/compare/v4.5.0...v4.5.1) (2022-11-03)
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@axe-core/cli",
-  "version": "4.7.3",
+  "version": "4.7.4-2456ed6.0+2456ed6",
   "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.3",
-    "axe-core": "^4.7.0",
-    "chromedriver": "^113.0.0",
+    "@axe-core/webdriverjs": "4.7.4-2456ed6.0+2456ed6",
+    "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": "ad1c229716920cbc359553e0bcb2e0b20ac55ac9"
+  "gitHead": "2456ed641781c2262bf71db24f7f97755422d5f6"
 }

package/src/bin/cli.test.ts

@@ -9,6 +9,12 @@ import { version } from '../../package.json';
 import runCLI from '../testutils/';
 
 const SIMPLE_HTML_FILE = path.join(__dirname, '..', 'testutils', 'simple.html');
+const SIMPLE_CLEAN_HTML_FILE = path.join(
+  __dirname,
+  '..',
+  'testutils',
+  'simple-clean.html'
+);
 const SIMPLE_HTML_SOURCE = fs.readFileSync(SIMPLE_HTML_FILE, 'utf8');
 const PATH_TO_AXE_250 = path.resolve(
   __dirname,
@@ -147,6 +153,18 @@ describe('cli', () => {
         );
       }
     });
+
+    it('should exit zero if violations are found', async () => {
+      try {
+        await runCLI(`file://${SIMPLE_CLEAN_HTML_FILE}`, '--exit');
+      } catch (error) {
+        assert.equal(error.exitCode, 0);
+        assert.include(
+          error.stdout,
+          'Violation of "marquee" with 1 occurrences!'
+        );
+      }
+    });
   });
 
   describe('--dir', () => {
@@ -373,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}`,
@@ -386,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;
@@ -133,6 +165,24 @@ const cli = async (
       }
     }
 
+    if (exit) {
+      let exitErr = false;
+      /* istanbul ignore if */
+      if (Array.isArray(outcome)) {
+        for (const res of outcome) {
+          if (res.violations.length > 0) {
+            exitErr = true;
+            break;
+          }
+        }
+      } else {
+        exitErr = outcome.violations.length > 0;
+      }
+      if (exitErr) {
+        process.exit(1);
+      }
+    }
+
     /* istanbul ignore if */
     if (silentMode) {
       return;

package/src/lib/events.ts

@@ -2,13 +2,7 @@ import type { AxeResults } from 'axe-core';
 import type { EventParams } from '../types';
 import { selectorToString, error, link, bold, green } from './utils';
 
-export default ({
-  silentMode,
-  timer,
-  cliReporter,
-  verbose,
-  exit
-}: EventParams) => {
+export default ({ silentMode, timer, cliReporter, verbose }: EventParams) => {
   return {
     startTimer: (message: string) => {
       console.time(message);
@@ -69,10 +63,6 @@ export default ({
         };
         cliReporter(`\n${JSON.stringify(metadata, null, 2)}`);
       }
-
-      if (exit) {
-        process.exit(1);
-      }
     }
   };
 };

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,5 +1,6 @@
+import path from 'path';
 import chromedriver from 'chromedriver';
-import { Builder, Capabilities, WebDriver } from 'selenium-webdriver';
+import { Builder, type WebDriver } from 'selenium-webdriver';
 import chrome from 'selenium-webdriver/chrome';
 import { WebdriverConfigParams } from '../types';
 
@@ -21,6 +22,10 @@ const startDriver = async (
       }, options);
     }
 
+    if (config.chromePath) {
+      options.setChromeBinaryPath(path.resolve(config.chromePath));
+    }
+
     builder = new Builder()
       .forBrowser('chrome')
       .setChromeOptions(options)