@a11ycore/reporter 中文文档教程

Question

@a11ycore/reporter

Description

Reporter 是一个允许您将 a11y 结果与 A11ycore 报告平台同步的工具。 如果您还没有注册一个帐户，您将无法使用这个包。 您可以在此处注册；

Usage

const { runA11yJest } = require('@a11ycore/jest');
const { reporter }  = require('@a11ycore/reporter');
const { normaliseBuild } = require('@a11ycore/utils');

// can be found in the details page of your a11ycore project
const apiKey = process.env.A11Y_API_KEY;
const projectId = process.env.PROJECT_ID

describe("jest", () => {
  test("it should call the runA11yMethod", async () => {
    const element = React.createElement("img", { src: "#" });
    const html = ReactDOMServer.renderToString(element);
    const results = await runA11yJest(html)
    expect(results.violations.length).toBeGreaterThan(1);
    const normalisedResults = normaliseBuild(projectId, results); // if not done your results will not process and may be rejected
    await reporter(projectId, apiKey, normaliseBuild(projectId, results)); // you can then login to your a11ycore dashbaord to see results
  });
});