From 3a2a3207359624a7a41fc32d17bec5f62ccdf388 Mon Sep 17 00:00:00 2001 From: hshiroya Date: Wed, 18 Jun 2025 00:21:01 +0530 Subject: [PATCH 1/2] feat: add reportOnly flag to checkA11y to optionally skip test failure --- cypress/e2e/test.cy.js | 10 ++++++++-- src/index.ts | 5 +++-- 2 files changed, 11 insertions(+), 4 deletions(-) diff --git a/cypress/e2e/test.cy.js b/cypress/e2e/test.cy.js index 685350b..2d73638 100644 --- a/cypress/e2e/test.cy.js +++ b/cypress/e2e/test.cy.js @@ -1,5 +1,11 @@ it('works!', () => { - cy.visit('/'); + cy.visit('https://www.ibm.com/in-en/careers/search'); cy.injectAxe(); - cy.checkA11y(undefined, { retries: 20, interval: 10 }); + cy.checkA11y(undefined, { retries: 0, interval: 10 }); +}); + +it('Check reportOnly flag passes tests', () => { + cy.visit('https://www.ibm.com/in-en/careers/search'); + cy.injectAxe(); + cy.checkA11y({ reportOnly: true }, { retries: 0, interval: 10 }); }); diff --git a/src/index.ts b/src/index.ts index 70654db..9c076ec 100644 --- a/src/index.ts +++ b/src/index.ts @@ -21,6 +21,7 @@ export interface Options extends axe.RunOptions { includedImpacts?: string[]; interval?: number; retries?: number; + reportOnly?: boolean; } export interface InjectOptions { @@ -81,7 +82,7 @@ const checkA11y = ( if (isEmptyObjectorNull(violationCallback)) { violationCallback = undefined; } - const { includedImpacts, interval, retries, ...axeOptions } = + const { includedImpacts, interval, retries,reportOnly, ...axeOptions } = options || {}; let remainingRetries = retries || 0; function runAxeCheck(): Promise { @@ -125,7 +126,7 @@ const checkA11y = ( return cy.wrap(violations, { log: false }); }) .then((violations) => { - if (!skipFailures) { + if (!skipFailures && !(options && options.reportOnly)) { assert.equal( violations.length, 0, From a437442c4de8db7761ce4e8599b1b67804191c8c Mon Sep 17 00:00:00 2001 From: hshiroya Date: Wed, 18 Jun 2025 00:24:31 +0530 Subject: [PATCH 2/2] Changed original test case url --- cypress/e2e/test.cy.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cypress/e2e/test.cy.js b/cypress/e2e/test.cy.js index 2d73638..952f443 100644 --- a/cypress/e2e/test.cy.js +++ b/cypress/e2e/test.cy.js @@ -1,5 +1,5 @@ it('works!', () => { - cy.visit('https://www.ibm.com/in-en/careers/search'); + cy.visit('/'); cy.injectAxe(); cy.checkA11y(undefined, { retries: 0, interval: 10 }); });