How to pass exclude option?

[stereobooster]

Hi,
thanks for maintaining the fork.

Maybe you know how to pass exclude option?

[mwmcode]

Hi @stereobooster ,

I tried to implement the changes that were planned for the next release of cypress-axe so this option has been replaced by shouldFailFn callback.

You can exclude a whole category/impact, for example exclude critical

cy.checkA11y({
  shouldFailFn: violations => violations.filter(v => v.impact !== 'critical')
});

or a certain violation like color-contrast:

cy.checkA11y({
  shouldFailFn: violations =>
    violations.filter(v.id !== 'color-contrast')
});

If you have certain violations/impacts that you want to exclude app wide, consider creating a custom command https://github.com/mcha-dev/cypress-axe-core#customised

[stereobooster]

I meant an option to exclude dom node, something like this:

context: {
  include: window
  exclude: ['[data-skip]']
}

[mwmcode]

Interesting! this has been abstracted in this implementation. Try this temporary workaround.

<img class="notme" src="" /> 

cy.wrap({ exclude: ['.notme']}).checkA11y();

[stereobooster]

Thanks.

My use case is: I have some components which use brand colors and lack contrast, so I want to ignore them until we get new color scheme from designers.

[mwmcode]

That's a valid scenario. Glad I could help.

[stereobooster]

WDYT about following API:

cy.get('bla').checkA11y({ exclude: ['.notme']});

?

[mwmcode]

It might not be as straightforward as that. I don't want to spread the context props over the current config options.

Will look into it later, for now I will update the readme to include the workaround.