Skip to content

feat: add reportOnly flag to checkA11y #186

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

hitshiroya
Copy link

Summary

This PR introduces a reportOnly flag to the checkA11y Cypress command. When enabled, it allows users to see accessibility violations without failing the test.

Why?

Some users may want to report accessibility issues in CI but not fail the pipeline. This flag supports that use case. specially for report generation.

Notes

  • Backward compatible
  • Default behavior remains unchanged
  • Example usage:
  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 });
});
Screenshot 2025-06-18 at 12 19 53 AM

@hitshiroya
Copy link
Author

Hi, @NicholasBoll. Could you review this code changes, please?
Thanks,
Hit

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant