Skip to content

Expose a rule's enabled property in the official API #5116

Description

@pomerantsev

Product

axe-core

Feature Description

To my knowledge, there's currently no official way to get the list of rules that are enabled when axe.run() is called with no options.

There's an axe.getRules() method, but that returns all rules, including the ones that are disabled by default.

There is an undocumented way to get such a list today (axe._audit.rules.filter(rule => rule.enabled)).

It would be great to expose the ability to filter rules by whether they're enabled as part of the official API, for example by adding the enabled key to the rule objects returned by axe.getRules(), or by introducing a new method.

Metadata

Metadata

Assignees

No one assigned

    Labels

    featNew feature or enhancementhelp wantedWe welcome PRs or discussions for issues marked as help wanted

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions