Cypress Accessibility Linter

a11y-linter.ts

function a11yLinter(tagName: string) {
  return cy.window().then((win: any) => {
    return new Cypress.Promise(function(resolve: any, reject: any) {
      win.axe.run(tagName, (err: any, results: any) => {
        if (err) {
          reject(err);
        }
        resolve(results.violations);
      });
    });
  });
}

function lintComponent(tagName: string) {
  return a11yLinter(tagName).then((violations: any) => {
    if (violations.length > 0) {
      console.table(violations);
      assert.equal(violations.length, 0, violations.length + ` a11y violation(s).
                   Please use the aXe Chrome Extension to debug the failures.`);
    }
  });
}

Cypress.Commands.add("lintComponent", (tagName: string) => {
  lintComponent(tagName);
});

component.a11y.spec.ts

describe("Component: Foo", () => {
  describe("a11y", () => {
    describe("aXe Engine", () => {
      it("passes the automated tests", () => {
        cy.lintComponent("#axe-test");
      });
    });
  });
});