axe-playwright 1.1.8 → 1.1.11

package/.github/dependabot.yml

@@ -0,0 +1,12 @@
+version: 2
+updates:
+- package-ecosystem: npm
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "23:30"
+  open-pull-requests-limit: 10
+  ignore:
+  - dependency-name: "@types/node"
+    versions:
+    - 15.0.0

package/README.md

@@ -4,6 +4,7 @@
 
 [![Build Status](https://circleci.com/gh/abhinaba-ghosh/axe-playwright.svg?style=shield&branch-=master)](https://app.circleci.com/pipelines/github/abhinaba-ghosh/axe-playwright)
 [![NPM release](https://img.shields.io/npm/v/axe-playwright.svg 'NPM release')](https://www.npmjs.com/package/axe-playwright)
+[![NPM Downloads](https://img.shields.io/npm/dt/axe-playwright.svg?style=flat-square)](https://www.npmjs.com/package/axe-playwright)
 
 [Axe](https://www.deque.com/axe/) is an accessibility testing engine for websites and other HTML-based user interfaces. This package provides simple axe analyser commands which you can incorporate in your [Playwright](https://www.npmjs.com/package/playwright) tests.The idea is highly inspired by [Andy Van Slaars](https://github.com/avanslaars) cypress-axe project.
 
@@ -123,11 +124,11 @@ A class instance that implements the `Reporter` interface. Custom reporter insta
 
 Disables assertions based on violations and only logs violations to the console output. If you set `skipFailures` as `true`, although accessibility check is not passed, your test will not fail. It will simply print the violations in the console, but will not make the test fail.
 
-### getViolations
+### getAxeResults
 
-This will run axe against the document at the point in which it is called, then return you an array of accessibility violations.
+This will run axe against the document at the point in which it is called, then returns the full set of results as reported by `axe.run`.
 
-#### Parameters on getViolations (axe.run)
+#### Parameters on getAxeResults
 
 ##### page (mandatory)
 
@@ -141,22 +142,15 @@ Defines the scope of the analysis - the part of the DOM that you would like to a
 
 Set of options passed into rules or checks, temporarily modifying them. This contrasts with axe.configure, which is more permanent.
 
-The keys consist of [those accepted by `axe.run`'s options argument](https://www.deque.com/axe/documentation/api-documentation/#parameters-axerun) as well as custom `includedImpacts`, `detailedReport`, and `detailedReportOptions` keys.
-
-The `includedImpacts` key is an array of strings that map to `impact` levels in violations. Specifying this array will only include violations where the impact matches one of the included values. Possible impact values are "minor", "moderate", "serious", or "critical".
+The object is of the same type which is [accepted by `axe.run`'s options argument](https://www.deque.com/axe/documentation/api-documentation/#parameters-axerun) and directly forwarded to it.
 
-Filtering based on impact in combination with the `skipFailures` argument allows you to introduce `axe-playwright` into tests for a legacy application without failing in CI before you have an opportunity to address accessibility issues. Ideally, you would steadily move towards stricter testing as you address issues.
-e-effects, such as adding custom output to the terminal.
+### getViolations
 
-**NOTE:** _This respects the `includedImpacts` filter and will only execute with violations that are included._
+This will run axe against the document at the point in which it is called, then return you an array of accessibility violations (i.e. the `violations` array included in the `getAxeResults` result).
 
-The `detailedReport` key is a boolean whether to print the more detailed report `detailedReportOptions` is an object with the shape
+#### Parameters on getViolations (axe.run)
 
-```
-{
- html?: boolean // include the full html for the offending nodes
-}
-```
+Identical to [parameters of getAxeResults](#parameters-on-getAxeResults).
 
 ### reportViolations
 

package/dist/index.js

@@ -31,7 +31,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.checkA11y = exports.reportViolations = exports.getViolations = exports.configureAxe = exports.injectAxe = void 0;
+exports.checkA11y = exports.reportViolations = exports.getViolations = exports.getAxeResults = exports.configureAxe = exports.injectAxe = void 0;
 const fs = __importStar(require("fs"));
 const utils_1 = require("./utils");
 const defaultTerminalReporter_1 = __importDefault(require("./reporter/defaultTerminalReporter"));
@@ -54,16 +54,26 @@ const configureAxe = (page, configurationOptions = {}) => __awaiter(void 0, void
 });
 exports.configureAxe = configureAxe;
 /**
- * Runs axe-core tools on the relevant page and returns all accessibility violations detected on the page
+ * Runs axe-core tools on the relevant page and returns all results
  * @param page
  * @param context
  * @param options
  */
-const getViolations = (page, context, options) => __awaiter(void 0, void 0, void 0, function* () {
+const getAxeResults = (page, context, options) => __awaiter(void 0, void 0, void 0, function* () {
     const result = yield page.evaluate(([context, options]) => {
-        const axeOptions = options ? options['axeOptions'] : {};
-        return window.axe.run(context || window.document, axeOptions);
+        return window.axe.run(context || window.document, options);
     }, [context, options]);
+    return result;
+});
+exports.getAxeResults = getAxeResults;
+/**
+ * Runs axe-core tools on the relevant page and returns all accessibility violations detected on the page
+ * @param page
+ * @param context
+ * @param options
+ */
+const getViolations = (page, context, options) => __awaiter(void 0, void 0, void 0, function* () {
+    const result = yield exports.getAxeResults(page, context, options);
     return result.violations;
 });
 exports.getViolations = getViolations;
@@ -90,7 +100,7 @@ const checkA11y = (page, context, options, skipFailures, reporter) => __awaiter(
     if (options === void 0) { options = undefined; }
     if (skipFailures === void 0) { skipFailures = false; }
     if (reporter === void 0) { reporter = new defaultTerminalReporter_1.default(options === null || options === void 0 ? void 0 : options.detailedReport, (_a = options === null || options === void 0 ? void 0 : options.detailedReportOptions) === null || _a === void 0 ? void 0 : _a.html); }
-    const violations = yield exports.getViolations(page, context, options);
+    const violations = yield exports.getViolations(page, context, options === null || options === void 0 ? void 0 : options.axeOptions);
     const impactedViolations = utils_1.getImpactedViolations(violations, options === null || options === void 0 ? void 0 : options.includedImpacts);
     yield exports.reportViolations(impactedViolations, reporter);
     utils_1.testResultDependsOnViolations(impactedViolations, skipFailures);

package/index.d.ts

@@ -1,4 +1,4 @@
-import { Check, ElementContext, ImpactValue, Locale, Result, Rule, RunOptions } from 'axe-core'
+import { AxeResults, Check, ElementContext, ImpactValue, Locale, Result, Rule, RunOptions } from 'axe-core'
 import { Page } from 'playwright'
 
 export interface axeOptionsConfig {
@@ -25,6 +25,14 @@ export default interface Reporter {
   report(violations: Result[]): Promise<void>
 }
 
+/**
+ * Default implementation of a reporter which prints a summary to the console.
+ */
+export class DefaultTerminalReporter implements Reporter {
+  constructor(detailedReport: boolean | undefined, includeHtml: boolean | undefined)
+  report(violations: Result[]): Promise<void>
+}
+
 export type Options = {
   includedImpacts?: ImpactValue[]
   detailedReport?: boolean
@@ -61,13 +69,21 @@ export function checkA11y(
  */
 export function configureAxe(page: Page, options?: ConfigOptions): Promise<void>
 
+/**
+ * Runs axe-core tools on the relevant page and returns all results
+ * @param page
+ * @param context
+ * @param options
+ */
+export function getAxeResults(page: Page, context?: ElementContext, options?: RunOptions): Promise<AxeResults>
+
 /**
  * Runs axe-core tools on the relevant page and returns all accessibility violations detected on the page
  * @param page
  * @param context
  * @param options
  */
-export function getViolations(page: Page, context?: ElementContext, options?: Options): Promise<Result[]>
+export function getViolations(page: Page, context?: ElementContext, options?: RunOptions): Promise<Result[]>
 
 /**
  * Report violations given the reporter.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "axe-playwright",
-  "version": "1.1.8",
+  "version": "1.1.11",
   "description": "Custom Playwright commands to inject axe-core and test for a11y",
   "main": "dist/index.js",
   "types": "index.d.ts",
@@ -25,11 +25,11 @@
   "author": "Abhinaba Ghosh",
   "license": "MIT",
   "devDependencies": {
-    "@types/is-ci": "^2.0.0",
-    "@types/jest": "^26.0.10",
-    "@types/node": "^14.14.25",
+    "@types/is-ci": "^3.0.0",
+    "@types/jest": "^27.0.3",
+    "@types/node": "^17.0.4",
     "jest": "^26.6.3",
-    "jest-each": "^26.6.2",
+    "jest-each": "^27.0.2",
     "jest-playwright-preset": "^1.3.1",
     "playwright": "^1.1.1",
     "prettier": "^2.0.5",

package/src/index.ts

@@ -1,6 +1,6 @@
 import { Page } from 'playwright'
 import * as fs from 'fs'
-import { ElementContext, Result, RunOptions, Spec } from 'axe-core'
+import { AxeResults, ElementContext, Result, RunOptions, Spec } from 'axe-core'
 import { ConfigOptions, Options } from '../index'
 import { getImpactedViolations, testResultDependsOnViolations } from './utils'
 import DefaultTerminalReporter from './reporter/defaultTerminalReporter'
@@ -40,24 +40,38 @@ export const configureAxe = async (
 }
 
 /**
- * Runs axe-core tools on the relevant page and returns all accessibility violations detected on the page
+ * Runs axe-core tools on the relevant page and returns all results
  * @param page
  * @param context
  * @param options
  */
-export const getViolations = async (
+export const getAxeResults = async (
   page: Page,
   context?: ElementContext,
-  options?: Options,
-): Promise<Result[]> => {
+  options?: RunOptions,
+): Promise<AxeResults> => {
   const result = await page.evaluate(
     ([context, options]) => {
-      const axeOptions: RunOptions = options ? options['axeOptions'] : {}
-      return window.axe.run(context || window.document, axeOptions)
+      return window.axe.run(context || window.document, options)
     },
     [context, options],
   )
 
+  return result
+}
+
+/**
+ * Runs axe-core tools on the relevant page and returns all accessibility violations detected on the page
+ * @param page
+ * @param context
+ * @param options
+ */
+export const getViolations = async (
+  page: Page,
+  context?: ElementContext,
+  options?: RunOptions,
+): Promise<Result[]> => {
+  const result = await getAxeResults(page, context, options)
   return result.violations
 }
 
@@ -85,7 +99,7 @@ export const checkA11y = async (
   skipFailures: boolean = false,
   reporter: Reporter = new DefaultTerminalReporter(options?.detailedReport, options?.detailedReportOptions?.html),
 ): Promise<void> => {
-  const violations = await getViolations(page, context, options)
+  const violations = await getViolations(page, context, options?.axeOptions)
 
   const impactedViolations = getImpactedViolations(
     violations,