component-driven / component-driven/cypress-axe

Support of Result Types 'passes', 'incomplete' and 'inapplicable' in the violation callback function

Open
#191 1 comment 8 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

To allow the callback function in the cy.checkA11y() command to return not only an array of violations but also a Result object (as in axe-core), which includes passes, incomplete, and inapplicable results, especially incomplete.

Incomplete results are particularly useful, as they help users identify areas that require additional attention and manual review.

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 locating the cy.checkA11y() violation callback handling and its existing tests. Review how callbacks currently accept arrays, then define done as accepting an axe-core Result object with passes, incomplete, and inapplicable results, especially incomplete, while preserving existing behavior.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.