fix: axe-core dependency in preset-rule (#689)

* fix: axe-core dependency in preset-rule

* fix: changed customRules implementation

---------

Co-authored-by: Navateja Alagam <navateja215@gmail.com>

packages/browser-lib/src/index.ts

@@ -7,7 +7,8 @@
 
 import * as axe from 'axe-core';
 import { exceptionListFilter, appendWcag } from '@sa11y/format';
-import { defaultRuleset, registerCustomRules } from '@sa11y/preset-rules';
+import { registerCustomRules } from '@sa11y/common';
+import { defaultRuleset, changesData, rulesData, checkData } from '@sa11y/preset-rules';
 export { base, extended, full } from '@sa11y/preset-rules';
 export const namespace = 'sa11y';
 
@@ -32,7 +33,7 @@ export async function checkAccessibility(
     //  which could then result in getting rid of the rollup typescript plugins.
 
     // To register custom rules
-    registerCustomRules();
+    registerCustomRules(changesData, rulesData, checkData);
 
     const results = await axe.run(scope || document, rules);
     const filteredResults = exceptionListFilter(results.violations, exceptionList);

packages/common/__tests__/helpers.test.ts

@@ -6,7 +6,9 @@
  */
 
 import path from 'path';
-import { useFilesToBeExempted, log, useCustomRules, processFiles } from '../src/helpers';
+import { useFilesToBeExempted, log, useCustomRules, processFiles, registerCustomRules } from '../src/helpers';
+import axe from 'axe-core';
+jest.mock('axe-core');
 
 describe('Your Module', () => {
     afterEach(() => {
@@ -93,4 +95,16 @@ describe('Your Module', () => {
         processFiles<{ key: string }>(directoryPath, targetArray, '.json', JSON.parse);
         expect(targetArray).toEqual([{ key: 'value' }]);
     });
+
+    it('register custom Rules', () => {
+        const mockConfigure = axe.configure as jest.MockedFunction<typeof axe.configure>;
+        const mockRules = [{ id: 'rule1' }] as axe.Rule[];
+        const mockChecks = [{ id: 'check1' }] as axe.Check[];
+        const mockChanges = { rules: [{ id: 'rule2' }] } as { rules: axe.Rule[] };
+        registerCustomRules(mockChanges, mockRules, mockChecks);
+        expect(mockConfigure).toHaveBeenCalledWith({
+            rules: [...mockChanges.rules, ...mockRules],
+            checks: [...mockChecks],
+        });
+    });
 });

packages/common/src/helpers.ts

@@ -11,6 +11,7 @@
  */
 const sa11yAutoFilterListDefaultPackageName = 'sa11y-jest-automated-check-file-exclusion';
 
+import axe from 'axe-core';
 import * as fs from 'fs';
 import path from 'path';
 export function log(...args: unknown[]): void {
@@ -68,3 +69,27 @@ export const processFiles = <T>(
         }
     });
 };
+
+export const registerCustomRules = (
+    changesData: { rules: axe.Rule[] },
+    rulesData: axe.Rule[],
+    checksData: axe.Check[]
+): void => {
+    const newChecks: axe.Check[] = [];
+    const newRules: axe.Rule[] = [];
+
+    // Read and parse existing rule changes
+    const { rules } = changesData;
+    const newRulesData = rulesData;
+    const newChecksData = checksData;
+
+    if (rules && Array.isArray(rules)) {
+        newRules.push(...rules);
+    }
+    newRules.push(...newRulesData);
+    newChecks.push(...newChecksData);
+
+    // Configure axe with the new checks and rules
+    const spec: axe.Spec = { rules: newRules, checks: newChecks };
+    axe.configure(spec);
+};

packages/common/src/index.ts

@@ -8,4 +8,4 @@
 export { A11yConfig, AxeResults, axeRuntimeExceptionMsgPrefix, axeVersion, getAxeRules, getViolations } from './axe';
 export { WdioAssertFunction, WdioOptions } from './wdio';
 export { errMsgHeader, ExceptionList } from './format';
-export { log, useFilesToBeExempted, useCustomRules, processFiles } from './helpers';
+export { log, useFilesToBeExempted, useCustomRules, processFiles, registerCustomRules } from './helpers';

packages/jest/__tests__/automatic.test.ts

@@ -19,7 +19,6 @@ import {
 } from '@sa11y/test-utils';
 import * as Sa11yCommon from '@sa11y/common';
 import { expect, jest } from '@jest/globals';
-import { registerCustomRules } from '@sa11y/preset-rules';
 
 describe('automatic checks registration', () => {
     const prevEnv = process.env;

packages/jest/src/setup.ts

@@ -6,15 +6,15 @@
  */
 
 import { toBeAccessible } from './matcher';
-import { A11yConfig, useFilesToBeExempted } from '@sa11y/common';
+import { A11yConfig, useFilesToBeExempted, registerCustomRules } from '@sa11y/common';
 import {
     AutoCheckOpts,
     registerSa11yAutomaticChecks,
     getOriginalDocumentBodyHtml,
     setOriginalDocumentBodyHtml,
 } from './automatic';
 import { expect } from '@jest/globals';
-import { registerCustomRules } from '@sa11y/preset-rules';
+import { changesData, rulesData, checkData } from '@sa11y/preset-rules';
 
 export const disabledRules = [
     // Descendancy checks that would fail at unit/component level, but pass at page level
@@ -93,7 +93,7 @@ export function setup(opts: Sa11yOpts = defaultSa11yOpts): void {
         }
     }
     registerSa11yMatcher();
-    registerCustomRules();
+    registerCustomRules(changesData, rulesData, checkData);
     // Set defaults from env vars
     const autoCheckOpts = opts.autoCheckOpts;
     autoCheckOpts.runAfterEach ||= !!process.env.SA11Y_AUTO;

packages/preset-rules/src/index.ts

@@ -11,4 +11,7 @@ export { extended } from './extended';
 export { base } from './base';
 export { full, excludedRules } from './full';
 export { WcagMetadata } from './wcag';
-export { registerCustomRules } from './customRules';
+import changesData from './custom-rules/changes';
+import rulesData from './custom-rules/rules';
+import checkData from './custom-rules/checks';
+export { changesData, rulesData, checkData };