@sa11y/jest 7.1.4 → 7.2.0-alpha.2

package/README.md

@@ -20,6 +20,7 @@ Accessibility matcher for [Jest](https://jestjs.io)
   - [Limitations](#limitations)
   - [Disabled Checks](#disabled-checks)
 - [Related Packages](#related-packages)
+  - [Options](#options)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 
@@ -52,6 +53,14 @@ const { setup } = require('@sa11y/jest'); // CommonJS
 import { setup } from '@sa11y/jest'; // ES6
 // Register the sa11y matcher
 setup();
+
+// Register with custom options for automatic checks and DOM saving
+setup({
+    autoCheckOpts: { runAfterEach: true, cleanupAfterEach: true },
+    renderedDOMSaveOpts: {
+        /* your RenderedDOMSaveOpts here */
+    },
+});
 ```
 
 -   Add or Modify the Jest config at project root to invoke the Jest setup file as setup above.
@@ -169,6 +178,14 @@ setup({ autoCheckOpts: { runAfterEach: true } });
 
 // To optionally cleanup the body after running a11y checks
 setup({ autoCheckOpts: { runAfterEach: true, cleanupAfterEach: true } });
+
+// To customize how/where the rendered DOM is saved during automatic checks
+setup({
+    autoCheckOpts: { runAfterEach: true },
+    renderedDOMSaveOpts: {
+        /* your RenderedDOMSaveOpts here */
+    },
+});
 ```
 
 ### Using environment variables
@@ -283,3 +300,17 @@ Automatic checks currently has the following limitations.
 ## Related Packages
 
 -   [`@sa11y/matcher`](../matcher/README.md): Provides the core accessibility checking APIs used by this package. Use it directly for custom test runners or advanced integrations.
+
+### Options
+
+-   `autoCheckOpts`: Options for automatic accessibility checks (see below)
+-   `renderedDOMSaveOpts`: Options for saving the rendered DOM during automatic checks. Allows customizing how and where the DOM is saved for debugging or reporting purposes. See [`@sa11y/matcher` RenderedDOMSaveOpts](../matcher/README.md#rendereddomsaveopts) for details.
+
+**autoCheckOpts:**
+
+-   `runAfterEach`: Run after each test (for integration with test runners)
+-   `cleanupAfterEach`: Clean up the DOM after checking
+-   `consolidateResults`: Deduplicate results
+-   `filesFilter`: Array of file path substrings to skip automatic checks for
+-   `runDOMMutationObserver`: Enable DOM mutation observer mode
+-   `enableIncompleteResults`: Include incomplete results

package/dist/automatic.d.ts

@@ -1,3 +1,3 @@
-import type { AutoCheckOpts } from '@sa11y/matcher';
-export declare function registerSa11yAutomaticChecks(opts?: AutoCheckOpts): void;
+import type { AutoCheckOpts, RenderedDOMSaveOpts } from '@sa11y/matcher';
+export declare function registerSa11yAutomaticChecks(opts?: AutoCheckOpts, renderedDOMSaveOpts?: RenderedDOMSaveOpts): void;
 //# sourceMappingURL=automatic.d.ts.map

package/dist/automatic.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"automatic.d.ts","sourceRoot":"","sources":["../src/automatic.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAEpD,wBAAgB,4BAA4B,CAAC,IAAI,GAAE,aAAoC,GAAG,IAAI,CAc7F"}
+{"version":3,"file":"automatic.d.ts","sourceRoot":"","sources":["../src/automatic.ts"],"names":[],"mappings":"AAeA,OAAO,KAAK,EAAE,aAAa,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AAEzE,wBAAgB,4BAA4B,CACxC,IAAI,GAAE,aAAoC,EAC1C,mBAAmB,GAAE,mBAAgD,GACtE,IAAI,CAoBN"}

package/dist/automatic.js

@@ -10,7 +10,7 @@ exports.registerSa11yAutomaticChecks = void 0;
 const globals_1 = require("@jest/globals");
 const matcher_1 = require("@sa11y/matcher");
 const matcher_2 = require("./matcher");
-function registerSa11yAutomaticChecks(opts = matcher_1.defaultAutoCheckOpts) {
+function registerSa11yAutomaticChecks(opts = matcher_1.defaultAutoCheckOpts, renderedDOMSaveOpts = matcher_1.defaultRenderedDOMSaveOpts) {
     if (!opts.runAfterEach)
         return;
     const observer = new MutationObserver(matcher_1.mutationObserverCallback);
@@ -22,7 +22,7 @@ function registerSa11yAutomaticChecks(opts = matcher_1.defaultAutoCheckOpts) {
     afterEach(async () => {
         if (opts.runDOMMutationObserver)
             observer.disconnect();
-        await (0, matcher_1.runAutomaticCheck)(opts, globals_1.expect.getState().testPath, matcher_2.isTestUsingFakeTimer);
+        await (0, matcher_1.runAutomaticCheck)(opts, renderedDOMSaveOpts, globals_1.expect.getState().testPath, globals_1.expect.getState().currentTestName, matcher_2.isTestUsingFakeTimer);
     });
 }
 exports.registerSa11yAutomaticChecks = registerSa11yAutomaticChecks;

package/dist/setup.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"setup.d.ts","sourceRoot":"","sources":["../src/setup.ts"],"names":[],"mappings":"AAiBA,wBAAgB,KAAK,CAAC,IAAI,gDAAmB,GAAG,IAAI,CAanD;AACD,wBAAgB,oBAAoB,IAAI,IAAI,CAU3C"}
+{"version":3,"file":"setup.d.ts","sourceRoot":"","sources":["../src/setup.ts"],"names":[],"mappings":"AAiBA,wBAAgB,KAAK,CAAC,IAAI,gDAAmB,GAAG,IAAI,CAenD;AACD,wBAAgB,oBAAoB,IAAI,IAAI,CAU3C"}

package/dist/setup.js

@@ -21,7 +21,8 @@ function setup(opts = matcher_1.defaultSa11yOpts) {
     (0, matcher_1.registerCustomSa11yRules)();
     const autoCheckOpts = opts.autoCheckOpts;
     (0, matcher_1.updateAutoCheckOpts)(autoCheckOpts);
-    (0, automatic_1.registerSa11yAutomaticChecks)(autoCheckOpts);
+    const renderedDOMSaveOpts = opts.renderedDOMSaveOpts;
+    (0, automatic_1.registerSa11yAutomaticChecks)(autoCheckOpts, renderedDOMSaveOpts);
 }
 exports.setup = setup;
 function registerSa11yMatcher() {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@sa11y/jest",
-    "version": "7.1.4",
+    "version": "7.2.0-alpha.2",
     "description": "Accessibility testing matcher for Jest",
     "license": "BSD-3-Clause",
     "homepage": "https://github.com/salesforce/sa11y/tree/master/packages/jest#readme",
@@ -24,10 +24,10 @@
     ],
     "dependencies": {
         "@jest/test-result": "^27",
-        "@sa11y/assert": "7.1.4",
-        "@sa11y/format": "7.1.4",
-        "@sa11y/matcher": "7.1.4",
-        "@sa11y/preset-rules": "7.1.4",
+        "@sa11y/assert": "7.2.0-alpha.2",
+        "@sa11y/format": "7.2.0-alpha.2",
+        "@sa11y/matcher": "7.2.0-alpha.2",
+        "@sa11y/preset-rules": "7.2.0-alpha.2",
         "jest-matcher-utils": "^27"
     },
     "peerDependencies": {
@@ -35,8 +35,8 @@
     },
     "devDependencies": {
         "@jest/globals": "28.1.3",
-        "@sa11y/common": "7.1.4",
-        "@sa11y/test-utils": "7.1.4"
+        "@sa11y/common": "7.2.0-alpha.2",
+        "@sa11y/test-utils": "7.2.0-alpha.2"
     },
     "publishConfig": {
         "access": "public"
@@ -44,5 +44,5 @@
     "engines": {
         "node": "^18 || ^20"
     },
-    "gitHead": "258e6f748dcee8e91328c9342a21ae8cd90c533c"
+    "gitHead": "064631247ec53ade5ea3658c4bee71125633f96d"
 }