@sa11y/jest 3.0.2 → 4.0.0-alpha.0

package/README.md

@@ -180,11 +180,7 @@ SA11Y_AUTO=1 SA11Y_CLEANUP=1 jest
 -   Invoking `jest` with environment variables as above will enable automatic checks with no changes required to `setup()`
 -   The environment variables can be used to set up parallel builds e.g., in a CI environment without code changes to `setup()` to opt-in to automatic checks
 -   Setting `SA11Y_DEBUG=1` will output verbose logging
--   `SA11Y_AUTO_FILTER` can be used to specify a comma seperated list of test file paths to filter for automatic checks
-    -   When specified, automatic checks will be run only on given files
-    -   A file can be excluded from automatic checks by prefixing the filename with `!`
-        -   e.g. `SA11Y_AUTO_FILTER='!exclude.test.js'`
-    -   The file paths can be also be expressed as [regular expressions](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions/Cheatsheet) if necessary
+-   `SA11Y_AUTO_FILTER` can be used to specify a comma seperated list of test file paths to filter out from automatic checks. When specified automatic checks are skipped for given files.
 
 ### Sa11y results processor
 

package/dist/automatic.d.ts

@@ -7,6 +7,10 @@ export declare type AutoCheckOpts = {
     consolidateResults?: boolean;
     filesFilter?: string[];
 };
+/**
+ * Check if current test file needs to be skipped based on any provided filter
+ */
+export declare function skipTest(testPath: string | undefined, filesFilter?: string[]): boolean;
 /**
  * Run accessibility check on each element node in the body using {@link toBeAccessible}
  * @param opts - Options for automatic checks {@link AutoCheckOpts}

package/dist/automatic.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"automatic.d.ts","sourceRoot":"","sources":["../src/automatic.ts"],"names":[],"mappings":"AAYA;;GAEG;AACH,oBAAY,aAAa,GAAG;IACxB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAI7B,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;CAC1B,CAAC;AAYF;;;GAGG;AACH,wBAAsB,cAAc,CAAC,IAAI,GAAE,aAAoC,GAAG,OAAO,CAAC,IAAI,CAAC,CA6C9F;AAED;;;GAGG;AACH,wBAAgB,4BAA4B,CAAC,IAAI,GAAE,aAAoC,GAAG,IAAI,CAQ7F"}
+{"version":3,"file":"automatic.d.ts","sourceRoot":"","sources":["../src/automatic.ts"],"names":[],"mappings":"AAaA;;GAEG;AACH,oBAAY,aAAa,GAAG;IACxB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAI7B,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;CAC1B,CAAC;AAYF;;GAEG;AACH,wBAAgB,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,EAAE,WAAW,CAAC,EAAE,MAAM,EAAE,GAAG,OAAO,CAUtF;AAED;;;GAGG;AACH,wBAAsB,cAAc,CAAC,IAAI,GAAE,aAAoC,GAAG,OAAO,CAAC,IAAI,CAAC,CA+B9F;AAED;;;GAGG;AACH,wBAAgB,4BAA4B,CAAC,IAAI,GAAE,aAAoC,GAAG,IAAI,CAM7F"}

package/dist/automatic.js

@@ -6,11 +6,12 @@
  * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.registerSa11yAutomaticChecks = exports.automaticCheck = void 0;
+exports.registerSa11yAutomaticChecks = exports.automaticCheck = exports.skipTest = void 0;
 const common_1 = require("@sa11y/common");
 const assert_1 = require("@sa11y/assert");
 const format_1 = require("@sa11y/format");
 const matcher_1 = require("./matcher");
+const globals_1 = require("@jest/globals");
 /**
  * Default options when {@link registerSa11yAutomaticChecks} is invoked
  */
@@ -20,30 +21,32 @@ const defaultAutoCheckOpts = {
     consolidateResults: true,
     filesFilter: [],
 };
+/**
+ * Check if current test file needs to be skipped based on any provided filter
+ */
+function skipTest(testPath, filesFilter) {
+    if (!testPath || !filesFilter || !(filesFilter?.length > 0))
+        return false;
+    const skipTest = filesFilter.some((fileName) => testPath.toLowerCase().includes(fileName.toLowerCase()));
+    if (skipTest) {
+        (0, common_1.log)(`Skipping automatic accessibility check on ${testPath} as it matches given files filter: ${filesFilter.toString()}`);
+    }
+    return skipTest;
+}
+exports.skipTest = skipTest;
 /**
  * Run accessibility check on each element node in the body using {@link toBeAccessible}
  * @param opts - Options for automatic checks {@link AutoCheckOpts}
  */
 async function automaticCheck(opts = defaultAutoCheckOpts) {
-    var _a;
-    const violations = [];
-    const testPath = expect.getState().testPath;
-    // If option to run only on selected files is specified, then current path should
-    // match against at least one file
-    if (((_a = opts.filesFilter) === null || _a === void 0 ? void 0 : _a.length) &&
-        !opts.filesFilter
-            // Convenience shortcut converting '!' prefix to filename
-            // as negative lookahead assertion regex
-            .map((filename) => (filename.startsWith('!') ? `/(?!${filename})$` : filename))
-            .some((fileName) => RegExp(fileName).test(testPath))) {
-        (0, common_1.log)(`Skipping automatic accessibility check on ${testPath} as it does not match selected files provided: ${opts.filesFilter.toString()}`);
+    if (skipTest(globals_1.expect.getState().testPath, opts.filesFilter))
         return;
-    }
     // Skip automatic check if test is using fake timer as it would result in timeout
     if ((0, matcher_1.isTestUsingFakeTimer)()) {
         (0, common_1.log)('Skipping automatic accessibility check as Jest fake timer is in use.');
         return;
     }
+    const violations = [];
     // Create a DOM walker filtering only elements (skipping text, comment nodes etc)
     const walker = document.createTreeWalker(document.body, NodeFilter.SHOW_ELEMENT);
     let currNode = walker.firstChild();
@@ -77,9 +80,7 @@ function registerSa11yAutomaticChecks(opts = defaultAutoCheckOpts) {
     if (opts.runAfterEach) {
         // TODO (fix): Make registration idempotent
         (0, common_1.log)('Registering sa11y checks to be run automatically after each test');
-        afterEach(async () => {
-            await automaticCheck(opts);
-        });
+        afterEach(() => automaticCheck(opts));
     }
 }
 exports.registerSa11yAutomaticChecks = registerSa11yAutomaticChecks;

package/dist/resultsProcessor.js

@@ -54,13 +54,12 @@ function processA11yErrors(testSuite, testResult) {
             // TODO (spike) : What happens if there are ever multiple failureDetails?
             //  Ideally there shouldn't be as test execution should be stopped on failure
             format_1.A11yResults.add(error.a11yResults, suiteName).forEach((a11yResult) => {
-                var _a;
                 const className = `${suiteName}${metadataSeparator}${a11yResult.wcag}`;
                 // TODO (code cov): Fix - should be covered by existing tests
                 /* istanbul ignore next */
                 if (!Array.isArray(consolidatedErrors.get(className)))
                     consolidatedErrors.set(className, []);
-                (_a = consolidatedErrors.get(className)) === null || _a === void 0 ? void 0 : _a.push(createA11yTestResult(testResult, a11yResult));
+                consolidatedErrors.get(className)?.push(createA11yTestResult(testResult, a11yResult));
             });
         }
     });

package/dist/setup.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"setup.d.ts","sourceRoot":"","sources":["../src/setup.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC3C,OAAO,EAAE,aAAa,EAAgC,MAAM,aAAa,CAAC;AAE1E,eAAO,MAAM,aAAa,UAiBzB,CAAC;AAEF;;GAEG;AACH,oBAAY,SAAS,GAAG;IACpB,aAAa,EAAE,aAAa,CAAC;CAKhC,CAAC;AAaF;;;GAGG;AACH,wBAAgB,KAAK,CAAC,IAAI,GAAE,SAA4B,GAAG,IAAI,CAW9D;AAED;;GAEG;AACH,wBAAgB,oBAAoB,IAAI,IAAI,CAU3C;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,UAAU,EAAE,WAAW,WAAgB,GAAG,UAAU,CAK3F"}
+{"version":3,"file":"setup.d.ts","sourceRoot":"","sources":["../src/setup.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC3C,OAAO,EAAE,aAAa,EAAgC,MAAM,aAAa,CAAC;AAG1E,eAAO,MAAM,aAAa,UAiBzB,CAAC;AAEF;;GAEG;AACH,oBAAY,SAAS,GAAG;IACpB,aAAa,EAAE,aAAa,CAAC;CAKhC,CAAC;AAaF;;;GAGG;AACH,wBAAgB,KAAK,CAAC,IAAI,GAAE,SAA4B,GAAG,IAAI,CAW9D;AAED;;GAEG;AACH,wBAAgB,oBAAoB,IAAI,IAAI,CAU3C;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,UAAU,EAAE,WAAW,WAAgB,GAAG,UAAU,CAK3F"}

package/dist/setup.js

@@ -9,6 +9,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.adaptA11yConfig = exports.registerSa11yMatcher = exports.setup = exports.disabledRules = void 0;
 const matcher_1 = require("./matcher");
 const automatic_1 = require("./automatic");
+const globals_1 = require("@jest/globals");
 exports.disabledRules = [
     // Descendancy checks that would fail at unit/component level, but pass at page level
     'aria-required-children',
@@ -42,7 +43,6 @@ const defaultSa11yOpts = {
  * @param opts - {@link Sa11yOpts} to opt-in to automatic checks
  */
 function setup(opts = defaultSa11yOpts) {
-    var _a;
     registerSa11yMatcher();
     // Set defaults from env vars
     const autoCheckOpts = opts.autoCheckOpts;
@@ -50,7 +50,7 @@ function setup(opts = defaultSa11yOpts) {
     // Consolidate results if automatic checks is enabled
     autoCheckOpts.consolidateResults || (autoCheckOpts.consolidateResults = autoCheckOpts.runAfterEach);
     autoCheckOpts.cleanupAfterEach || (autoCheckOpts.cleanupAfterEach = !!process.env.SA11Y_CLEANUP);
-    if ((_a = process.env.SA11Y_AUTO_FILTER) === null || _a === void 0 ? void 0 : _a.trim().length)
+    if (process.env.SA11Y_AUTO_FILTER?.trim().length)
         autoCheckOpts.filesFilter || (autoCheckOpts.filesFilter = process.env.SA11Y_AUTO_FILTER.split(','));
     (0, automatic_1.registerSa11yAutomaticChecks)(autoCheckOpts);
 }
@@ -59,8 +59,8 @@ exports.setup = setup;
  * Register accessibility helpers toBeAccessible as jest matchers
  */
 function registerSa11yMatcher() {
-    if (expect !== undefined) {
-        expect.extend({ toBeAccessible: matcher_1.toBeAccessible });
+    if (globals_1.expect !== undefined) {
+        globals_1.expect.extend({ toBeAccessible: matcher_1.toBeAccessible });
     }
     else {
         throw new Error("Unable to find Jest's expect function." +

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@sa11y/jest",
-    "version": "3.0.2",
+    "version": "4.0.0-alpha.0",
     "description": "Accessibility testing matcher for Jest",
     "license": "BSD-3-Clause",
     "homepage": "https://github.com/salesforce/sa11y/tree/master/packages/jest#readme",
@@ -23,21 +23,22 @@
         "dist/**/*.d.ts*"
     ],
     "dependencies": {
-        "@jest/test-result": "26.6.2",
-        "@sa11y/assert": "3.0.2",
-        "@sa11y/format": "3.0.2",
-        "@sa11y/preset-rules": "3.0.2",
-        "jest-matcher-utils": "26.6.2"
+        "@jest/test-result": "^27",
+        "@sa11y/assert": "4.0.0-alpha.0",
+        "@sa11y/format": "4.0.0-alpha.0",
+        "@sa11y/preset-rules": "4.0.0-alpha.0",
+        "jest-matcher-utils": "^27"
     },
     "peerDependencies": {
-        "jest": ">=26.0.0"
+        "jest": ">=27.0.0"
     },
     "devDependencies": {
-        "@sa11y/common": "3.0.2",
-        "@sa11y/test-utils": "3.0.2"
+        "@jest/globals": "28.1.3",
+        "@sa11y/common": "4.0.0-alpha.0",
+        "@sa11y/test-utils": "4.0.0-alpha.0"
     },
     "publishConfig": {
         "access": "public"
     },
-    "gitHead": "32b02b7b174c5b0a175bf9751a4565f0a079b316"
+    "gitHead": "aeb87b6b27bfd56cf9f3de201456dd821e57b408"
 }