Publish axe-core accessibility scan results as self-contained HTML files in the same format as accessibility-insights-web.
Before using accessibility-insights-report, you will need to run an axe accessibility scan to produce some axe results to convert. Typically, you would do this by using an axe integration library for your favorite browser automation tool (axe-puppeteer, axe-webdriverjs, cypress-axe).
axe-sarif-converter exports a factory that can be used to create a report object and output its results as HTML.
Use it like this:
import * as Axe from 'axe';
import * as AxePuppeteer from 'axe-puppeteer';
import * as fs from 'fs';
import * as Puppeteer from 'puppeteer'
import * as util from 'util';
import { reporterFactory } from "accessibility-insights-report";
test('my accessibility test', async () => {
// This example uses axe-puppeteer, but you can use any axe-based library
// that outputs axe scan results in the default axe output format
const testPage: Puppeteer.Page = /* ... set up your test page ... */;
const axeResults: Axe.AxeResults = await new AxePuppeteer(testPage).analyze();
// Perform the conversion
const html = reporter.fromAxeResult(axeResults).asHTML();
// Output the HTML file for offline viewing in any modern browser
await util.promisify(fs.writeFile)(
'./test-results/my-accessibility-test.html',
JSON.stringify(html),
{ encoding: 'utf8' });
}To contribute, please visit accessibility-insights-web for more information.
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.
When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.