@sa11y/jest 6.2.3 → 6.3.0

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.
@@ -1 +1 @@
1
- {"version":3,"file":"automatic.d.ts","sourceRoot":"","sources":["../src/automatic.ts"],"names":[],"mappings":"AAeA;;GAEG;AACH,MAAM,MAAM,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;AAcF,eAAO,MAAM,2BAA2B,aAAc,MAAM,GAAG,IAAI,SAElE,CAAC;AAEF,eAAO,MAAM,2BAA2B,qBAEvC,CAAC;AAEF;;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,CAsC9F;AAED;;;GAGG;AACH,wBAAgB,4BAA4B,CAAC,IAAI,GAAE,aAAoC,GAAG,IAAI,CAQ7F"}
1
+ {"version":3,"file":"automatic.d.ts","sourceRoot":"","sources":["../src/automatic.ts"],"names":[],"mappings":"AAeA;;GAEG;AACH,MAAM,MAAM,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;AAcF,eAAO,MAAM,2BAA2B,aAAc,MAAM,GAAG,IAAI,SAElE,CAAC;AAEF,eAAO,MAAM,2BAA2B,qBAEvC,CAAC;AAEF;;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,CA4C9F;AAED;;;GAGG;AACH,wBAAgB,4BAA4B,CAAC,IAAI,GAAE,aAAoC,GAAG,IAAI,CAQ7F"}
package/dist/automatic.js CHANGED
@@ -65,6 +65,7 @@ async function automaticCheck(opts = defaultAutoCheckOpts) {
65
65
  // Create a DOM walker filtering only elements (skipping text, comment nodes etc)
66
66
  const walker = document.createTreeWalker(document.body, NodeFilter.SHOW_ELEMENT);
67
67
  let currNode = walker.firstChild();
68
+ const customRules = await (0, common_1.useCustomRules)();
68
69
  try {
69
70
  while (currNode !== null) {
70
71
  // TODO (spike): Use a logger lib with log levels selectable at runtime
@@ -74,7 +75,10 @@ async function automaticCheck(opts = defaultAutoCheckOpts) {
74
75
  // : ${testPath}`
75
76
  // );
76
77
  // W-10004832 - Exclude descendancy based rules from automatic checks
77
- violations.push(...(await (0, assert_1.getViolationsJSDOM)(currNode, (0, setup_1.adaptA11yConfig)(preset_rules_1.defaultRuleset))));
78
+ if (customRules.length === 0)
79
+ violations.push(...(await (0, assert_1.getViolationsJSDOM)(currNode, (0, setup_1.adaptA11yConfig)(preset_rules_1.defaultRuleset))));
80
+ else
81
+ violations.push(...(await (0, assert_1.getViolationsJSDOM)(currNode, (0, setup_1.adaptA11yConfigCustomRules)(preset_rules_1.defaultRuleset, customRules))));
78
82
  currNode = walker.nextSibling();
79
83
  }
80
84
  }
package/dist/setup.d.ts CHANGED
@@ -19,5 +19,6 @@ export declare function registerSa11yMatcher(): void;
19
19
  /**
20
20
  * Customize sa11y preset rules specific to JSDOM
21
21
  */
22
+ export declare function adaptA11yConfigCustomRules(config: A11yConfig, customRules: string[]): A11yConfig;
22
23
  export declare function adaptA11yConfig(config: A11yConfig, filterRules?: string[]): A11yConfig;
23
24
  //# sourceMappingURL=setup.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"setup.d.ts","sourceRoot":"","sources":["../src/setup.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,UAAU,EAAwB,MAAM,eAAe,CAAC;AACjE,OAAO,EACH,aAAa,EAIhB,MAAM,aAAa,CAAC;AAGrB,eAAO,MAAM,aAAa,UAiBzB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG;IACpB,aAAa,EAAE,aAAa,CAAC;CAKhC,CAAC;AAkCF;;;GAGG;AACH,wBAAgB,KAAK,CAAC,IAAI,GAAE,SAA4B,GAAG,IAAI,CA4C9D;AAED;;GAEG;AACH,wBAAgB,oBAAoB,IAAI,IAAI,CAU3C;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,UAAU,EAAE,WAAW,WAAgB,GAAG,UAAU,CAK3F"}
1
+ {"version":3,"file":"setup.d.ts","sourceRoot":"","sources":["../src/setup.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,UAAU,EAAwB,MAAM,eAAe,CAAC;AACjE,OAAO,EACH,aAAa,EAIhB,MAAM,aAAa,CAAC;AAGrB,eAAO,MAAM,aAAa,UAiBzB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG;IACpB,aAAa,EAAE,aAAa,CAAC;CAKhC,CAAC;AAkCF;;;GAGG;AACH,wBAAgB,KAAK,CAAC,IAAI,GAAE,SAA4B,GAAG,IAAI,CA4C9D;AACD;;GAEG;AACH,wBAAgB,oBAAoB,IAAI,IAAI,CAU3C;AACD;;GAEG;AACH,wBAAgB,0BAA0B,CAAC,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,EAAE,GAAG,UAAU,CAIhG;AACD,wBAAgB,eAAe,CAAC,MAAM,EAAE,UAAU,EAAE,WAAW,WAAgB,GAAG,UAAU,CAK3F"}
package/dist/setup.js CHANGED
@@ -6,7 +6,7 @@
6
6
  * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause
7
7
  */
8
8
  Object.defineProperty(exports, "__esModule", { value: true });
9
- exports.adaptA11yConfig = exports.registerSa11yMatcher = exports.setup = exports.disabledRules = void 0;
9
+ exports.adaptA11yConfig = exports.adaptA11yConfigCustomRules = exports.registerSa11yMatcher = exports.setup = exports.disabledRules = void 0;
10
10
  const matcher_1 = require("./matcher");
11
11
  const common_1 = require("@sa11y/common");
12
12
  const automatic_1 = require("./automatic");
@@ -121,6 +121,12 @@ exports.registerSa11yMatcher = registerSa11yMatcher;
121
121
  /**
122
122
  * Customize sa11y preset rules specific to JSDOM
123
123
  */
124
+ function adaptA11yConfigCustomRules(config, customRules) {
125
+ const adaptedConfig = JSON.parse(JSON.stringify(config));
126
+ adaptedConfig.runOnly.values = customRules;
127
+ return adaptedConfig;
128
+ }
129
+ exports.adaptA11yConfigCustomRules = adaptA11yConfigCustomRules;
124
130
  function adaptA11yConfig(config, filterRules = exports.disabledRules) {
125
131
  // TODO (refactor): Move into preset-rules pkg as a generic rules filter util
126
132
  const adaptedConfig = JSON.parse(JSON.stringify(config));
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sa11y/jest",
3
- "version": "6.2.3",
3
+ "version": "6.3.0",
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,9 +24,9 @@
24
24
  ],
25
25
  "dependencies": {
26
26
  "@jest/test-result": "^27",
27
- "@sa11y/assert": "6.2.3",
28
- "@sa11y/format": "6.2.3",
29
- "@sa11y/preset-rules": "6.2.3",
27
+ "@sa11y/assert": "6.3.0",
28
+ "@sa11y/format": "6.3.0",
29
+ "@sa11y/preset-rules": "6.3.0",
30
30
  "jest-matcher-utils": "^27"
31
31
  },
32
32
  "peerDependencies": {
@@ -34,8 +34,8 @@
34
34
  },
35
35
  "devDependencies": {
36
36
  "@jest/globals": "28.1.3",
37
- "@sa11y/common": "6.2.3",
38
- "@sa11y/test-utils": "6.2.3"
37
+ "@sa11y/common": "6.3.0",
38
+ "@sa11y/test-utils": "6.3.0"
39
39
  },
40
40
  "publishConfig": {
41
41
  "access": "public"
@@ -43,5 +43,5 @@
43
43
  "engines": {
44
44
  "node": "^16 || ^18"
45
45
  },
46
- "gitHead": "434146395f40538917f42f31ab9195fe163f5233"
46
+ "gitHead": "3e9639864e77cf4eaa90769c000c8386f27d6e01"
47
47
  }