@siteimprove/alfa-test-utils
v0.72.2
Published
Utilities to run Alfa tests and upload results to the Siteimprove Intelligence Platform
Downloads
62
Readme
alfa-test-utils
Utilities for running Alfa locally and uploading results to the Siteimprove Intelligence Platform.
Installation
Alfa is distributed as npm packages in the Github registry. See Github documentation on the npm registry for configuring your package manager to use the Github registry for the @siteimprove
organisation.
$ npm install --save-dev @siteimprove/alfa-test-utils
or
$ yarn add --dev @siteimprove/alfa-test-utils
Basic usage
Use scraper packages such as @siteimprove/alfa-playwright
to grab a page, then a simple test script could look like this:
import { Audit, Rules, SIP } from "@siteimprove/alfa-test-utils";
Audit.run(page, { rules: { include: Rules.aaFilter } }).then((outcomes) => {
SIP.upload(outcomes, {
userName: process.env.SI_USERNAME,
apiKey: process.env.SI_API_KEY,
testName: "WCAG 2.2 AA conformance test",
}).then(console.log);
});
See the full documentation for detailed usage instructions.