component-driven / component-driven/cypress-axe

Configure includedImpacts in cy.configureAxe instead of cy.checkA11y

Open
#161 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
641
Forks
90
Avg merge
6h 8m
Merged PRs (30d)
1

Description

It is now possible to use a custom includedImpacts key in the cy.checkA11y() function. Is it possible to use this key in cy.configureAxe()?
Such as:

cy.configureAxe({
   includedImpacts: ['critical']
})

or

cy.configureAxe({
   rules: [{ id: 'includedImpacts',  value:  ['critical'] }]
})

This would avoid some duplication.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by comparing the cy.configureAxe() and cy.checkA11y() entry points, focusing on how includedImpacts is currently accepted by cy.checkA11y(). Determine whether cy.configureAxe() can accept the same option or rules form, and consider the change complete when configuration avoids the described duplication and the existing checks still behave correctly.

Written by the indexing model from the issue text.

Assessment

Tech stack
cypress, typescript
Domain
accessibility, testing
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.