component-driven / component-driven/cypress-axe
Setting reviewOnFail = true on rule in config is completely ignoring issue
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 641
- Forks
- 90
- Avg merge
- 6h 8m
- Merged PRs (30d)
- 1
Description
Expected Behavior
Setting reviewOnFail = true to a particular rule in the "rules" config option should mean that, when a violation of the rule is captured, instead of showing it a violation in the Cypress test, it should show as a "Needs Review". The test should pass, but there should still be some sort of notification to the user that the rule was violated
Actual Behavior
Setting reviewOnFail to true for a given rule completely ignores the rule and replicates what happens when we set enabled = false. No information in the Cypress front-end or logs show that the issue "Needs Review"
Steps to Reproduce the Problem
1.Configure Axe like so:
cy.configureAxe({
rules: {
'id': 'image-alt',
'reviewOnFail': true
}
});
2. Create a page where there is an img tag without alt text
3. Run checkA11y on the page
Specifications
- Version:
"cypress": "^9.4.1",
"cypress-axe": "^0.14.0", - Platform:
Mac OS Big Sur
Chromium
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Reproduce the behavior using cy.configureAxe with the image-alt rule and reviewOnFail enabled, then run checkA11y on a page containing an image without alt text. Done means the Cypress test passes while still reporting the violation as Needs Review in the Cypress front end or logs.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cypress, typescript
- Domain
- accessibility, testing-qa
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100