@sa11y/jest 7.2.6 → 7.2.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +21 -0
- package/package.json +8 -8
package/README.md
CHANGED
|
@@ -17,10 +17,12 @@ Accessibility matcher for [Jest](https://jestjs.io)
|
|
|
17
17
|
- [Using environment variables](#using-environment-variables)
|
|
18
18
|
- [Sa11y results processor](#sa11y-results-processor)
|
|
19
19
|
- [JSON result transformation](#json-result-transformation)
|
|
20
|
+
- [Group violation results processor](#group-violation-results-processor)
|
|
20
21
|
- [Limitations](#limitations)
|
|
21
22
|
- [Disabled Checks](#disabled-checks)
|
|
22
23
|
- [Related Packages](#related-packages)
|
|
23
24
|
- [Options](#options)
|
|
25
|
+
- [Environment Variables](#environment-variables)
|
|
24
26
|
|
|
25
27
|
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
|
|
26
28
|
|
|
@@ -277,6 +279,16 @@ With sa11y results processor:
|
|
|
277
279
|
}
|
|
278
280
|
```
|
|
279
281
|
|
|
282
|
+
#### Group violation results processor
|
|
283
|
+
|
|
284
|
+
- Group violation results processor affects only the JSON result output
|
|
285
|
+
- It does not affect the default console reporter or output of any other reporter (e.g., HTML reporter)
|
|
286
|
+
- a11y errors within a single test file will be de-duped by rule ID and CSS selectors
|
|
287
|
+
- a11y errors will be transformed into their own test failures
|
|
288
|
+
- This would extract the a11y errors from the original tests and create additional test failures with the WCAG version, level, rule ID, CSS selectors as key
|
|
289
|
+
- bringing a11y metadata to forefront instead of being part of stacktrace
|
|
290
|
+
- The JSON output can be transformed into JUnit XML format e.g., using [jest-junit](https://github.com/jest-community/jest-junit)
|
|
291
|
+
|
|
280
292
|
### Limitations
|
|
281
293
|
|
|
282
294
|
Automatic checks currently has the following limitations.
|
|
@@ -314,3 +326,12 @@ Automatic checks currently has the following limitations.
|
|
|
314
326
|
- `filesFilter`: Array of file path substrings to skip automatic checks for
|
|
315
327
|
- `runDOMMutationObserver`: Enable DOM mutation observer mode
|
|
316
328
|
- `enableIncompleteResults`: Include incomplete results
|
|
329
|
+
|
|
330
|
+
## Environment Variables
|
|
331
|
+
|
|
332
|
+
- `SA11Y_AUTO`: Enable automatic checks (`1` to enable)
|
|
333
|
+
- `SA11Y_CLEANUP`: Clean up the DOM after checking (`1` to enable)
|
|
334
|
+
- `SA11Y_DEBUG`: Output verbose logging (`1` to enable)
|
|
335
|
+
- `SA11Y_AUTO_FILTER`: Comma-separated list of test file paths to filter out from automatic checks
|
|
336
|
+
- `SA11Y_RULESET`: Override the default ruleset (`base`, `extended`, or `full`)
|
|
337
|
+
- `SA11Y_RULESET_PRIORITY`: Select rules of specified priority in a ruleset
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@sa11y/jest",
|
|
3
|
-
"version": "7.2.
|
|
3
|
+
"version": "7.2.7",
|
|
4
4
|
"description": "Accessibility testing matcher for Jest",
|
|
5
5
|
"license": "BSD-3-Clause",
|
|
6
6
|
"homepage": "https://github.com/salesforce/sa11y/tree/master/packages/jest#readme",
|
|
@@ -24,10 +24,10 @@
|
|
|
24
24
|
],
|
|
25
25
|
"dependencies": {
|
|
26
26
|
"@jest/test-result": "^27",
|
|
27
|
-
"@sa11y/assert": "7.2.
|
|
28
|
-
"@sa11y/format": "7.2.
|
|
29
|
-
"@sa11y/matcher": "7.2.
|
|
30
|
-
"@sa11y/preset-rules": "7.2.
|
|
27
|
+
"@sa11y/assert": "7.2.7",
|
|
28
|
+
"@sa11y/format": "7.2.7",
|
|
29
|
+
"@sa11y/matcher": "7.2.7",
|
|
30
|
+
"@sa11y/preset-rules": "7.2.7",
|
|
31
31
|
"jest-matcher-utils": "^27"
|
|
32
32
|
},
|
|
33
33
|
"peerDependencies": {
|
|
@@ -35,8 +35,8 @@
|
|
|
35
35
|
},
|
|
36
36
|
"devDependencies": {
|
|
37
37
|
"@jest/globals": "28.1.3",
|
|
38
|
-
"@sa11y/common": "7.2.
|
|
39
|
-
"@sa11y/test-utils": "7.2.
|
|
38
|
+
"@sa11y/common": "7.2.7",
|
|
39
|
+
"@sa11y/test-utils": "7.2.7"
|
|
40
40
|
},
|
|
41
41
|
"publishConfig": {
|
|
42
42
|
"access": "public"
|
|
@@ -44,5 +44,5 @@
|
|
|
44
44
|
"engines": {
|
|
45
45
|
"node": "^18 || ^20"
|
|
46
46
|
},
|
|
47
|
-
"gitHead": "
|
|
47
|
+
"gitHead": "7960c89d90e982c76676107719886536483445d3"
|
|
48
48
|
}
|