feat(getRules): include rule enabled state in returned objects

axe.d.ts

@@ -334,7 +334,7 @@ declare namespace axe {
     matches?: string | ((node: Element, virtualNode: VirtualNode) => boolean);
     reviewOnFail?: boolean;
     actIds?: string[];
-    metadata?: Omit<RuleMetadata, 'ruleId' | 'tags' | 'actIds'>;
+    metadata?: Omit<RuleMetadata, 'ruleId' | 'tags' | 'actIds' | 'enabled'>;
   }
   interface AxePlugin {
     id: string;
@@ -352,6 +352,7 @@ declare namespace axe {
     helpUrl: string;
     tags: string[];
     actIds?: string[];
+    enabled: boolean;
   }
   interface SerialDqElement {
     source: string;

doc/API.md

@@ -137,7 +137,7 @@ Returns a list of all rules with their ID and description
 
 - `tags` - **optional** Array of tags used to filter returned rules. If omitted, it will return all rules. See [axe-core tags](#axe-core-tags).
 
-**Returns:** Array of rules that match the input filter with each entry having a format of `{ruleId: <id>, description: <desc>, helpUrl: <url>, help: <help>, tags: <tags>}`
+**Returns:** Array of rules that match the input filter with each entry having a format of `{ruleId: <id>, description: <desc>, helpUrl: <url>, help: <help>, tags: <tags>, enabled: <boolean>}`. `enabled` is `true` for rules that run by default when `axe.run()` is called with no options, and `false` for rules that are disabled by default.
 
 #### Example 1
 
@@ -163,7 +163,8 @@ In this example, we pass in the WCAG 2 A and AA tags into `axe.getRules` to retr
       "section508",
       "section508.22.a"
     ],
-    actIds: ['c487ae']
+    actIds: ['c487ae'],
+    enabled: true
   },
   {
     description: "Ensure ARIA attributes are allowed for an element's role",
@@ -174,7 +175,8 @@ In this example, we pass in the WCAG 2 A and AA tags into `axe.getRules` to retr
       "cat.aria",
       "wcag2a",
       "wcag412"
-    ]
+    ],
+    enabled: true
   }
   …
 ]

lib/core/public/get-rules.js

@@ -22,7 +22,8 @@ function getRules(tags) {
       help: rd.help,
       helpUrl: rd.helpUrl,
       tags: matchingRule.tags,
-      actIds: matchingRule.actIds
+      actIds: matchingRule.actIds,
+      enabled: matchingRule.enabled
     };
   });
 }

test/core/public/get-rules.js

@@ -16,7 +16,8 @@ describe('axe.getRules', () => {
           id: 'awesomeRule2',
           any: [],
           tags: ['tag1', 'tag2'],
-          actIds: ['abc123', 'xyz789']
+          actIds: ['abc123', 'xyz789'],
+          enabled: false
         }
       ],
       data: {
@@ -103,6 +104,13 @@ describe('axe.getRules', () => {
     assert.deepEqual(retValue[1].actIds, ['abc123', 'xyz789']);
   });
 
+  it('should return the enabled state of each rule', () => {
+    const retValue = axe.getRules();
+    assert.lengthOf(retValue, 2);
+    assert.equal(retValue[0].enabled, true);
+    assert.equal(retValue[1].enabled, false);
+  });
+
   it('should return all rules if given empty array', () => {
     const retValue = axe.getRules([]);
     assert.equal(retValue[0].ruleId, 'awesomeRule1');