dequelabs/axe-core

Expose a rule's `enabled` property in the official API

Open

#5.116 geöffnet am 24. Mai 2026

Auf GitHub ansehen
 (2 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)JavaScript (5.457 Stars) (783 Forks)batch import
feathelp wanted

Beschreibung

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.

Contributor Guide

Tech Stack
javascript
Domain
apiaccessibilitytesting
Issue Type
feature
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 hours
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
fresh
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
JavaScriptFamiliarity with axe core API
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75
Research-Richtung
Start by examining the existing `axe.getRules()` method in `doc/API.md` and its implementation. Look at how rules are stored in `axe. audit.rules` and how the `enabled` property is used. The goal is to add `enabled` to the returned rule objects or create a new method. Check any related issues or PRs for context.