feat: added support for consuming new rules (#683)

* feat: added support for consuming new rules

Author: jaig-0911

package.json

@@ -15,7 +15,7 @@
         "packages/*"
     ],
     "scripts": {
-        "build": "tsc --build && yarn workspace @sa11y/browser-lib build",
+        "build": "tsc --build && yarn workspace @sa11y/browser-lib build && lerna exec --scope @sa11y/preset-rules -- yarn copy-json",
         "build:ci": "yarn install --frozen-lockfile && yarn build",
         "build:clean": "tsc --build --clean && rimraf packages/**/dist && yarn build:ci",
         "build:watch": "tsc --build --watch",
@@ -76,6 +76,7 @@
         "chromedriver": "115.0.1",
         "commitizen": "4.3.0",
         "conventional-changelog-cli": "2.2.2",
+        "cpx": "1.5.0",
         "cspell": "6.31.3",
         "depcheck": "1.4.3",
         "doctoc": "2.2.1",

packages/common/__tests__/helpers.test.ts

@@ -5,7 +5,8 @@
  * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 
-import { useFilesToBeExempted, log, useCustomRules } from '../src/helpers';
+import path from 'path';
+import { useFilesToBeExempted, log, useCustomRules, processFiles } from '../src/helpers';
 
 describe('Your Module', () => {
     afterEach(() => {
@@ -85,4 +86,11 @@ describe('Your Module', () => {
         const result = useCustomRules();
         expect(result).toEqual(mockRules);
     });
+
+    it('should process only .json files and parse their content', () => {
+        const targetArray: Array<{ key: string }> = [];
+        const directoryPath = path.join(__dirname, '../testMocks/testProcessFiles');
+        processFiles<{ key: string }>(directoryPath, targetArray, '.json', JSON.parse);
+        expect(targetArray).toEqual([{ key: 'value' }]);
+    });
 });

packages/common/src/helpers.ts

@@ -12,6 +12,7 @@
 const sa11yAutoFilterListDefaultPackageName = 'sa11y-jest-automated-check-file-exclusion';
 
 import * as fs from 'fs';
+import path from 'path';
 export function log(...args: unknown[]): void {
     // Probably not worth it to mock and test console logging for this helper util
     /* istanbul ignore next */
@@ -50,3 +51,20 @@ export function useCustomRules(): string[] {
     }
     return [];
 }
+
+// Function to process files in a directory and push their content to a target array
+export const processFiles = <T>(
+    dir: string,
+    targetArray: T[],
+    extension: string,
+    parser: (data: string) => T
+): void => {
+    const files = fs.readdirSync(dir);
+    files.forEach((file) => {
+        if (path.extname(file) === extension) {
+            const filePath = path.join(dir, file);
+            const fileData = parser(fs.readFileSync(filePath, 'utf8'));
+            targetArray.push(fileData);
+        }
+    });
+};

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 } from './helpers';
+export { log, useFilesToBeExempted, useCustomRules, processFiles } from './helpers';

packages/common/testMocks/testProcessFiles/testProcessHelper.json

@@ -0,0 +1,3 @@
+{
+    "key": "value"
+}