@sa11y/jest 6.6.2 → 6.7.1-alpha.1

package/dist/groupViolationResultsProcessor.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"groupViolationResultsProcessor.d.ts","sourceRoot":"","sources":["../src/groupViolationResultsProcessor.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,gBAAgB,EAA+B,MAAM,mBAAmB,CAAC;AAsHlF;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,UAAU,gBAAgB,CAAC,OAAO,EAAE,gBAAgB,GAAG,gBAAgB,CAapF"}
+{"version":3,"file":"groupViolationResultsProcessor.d.ts","sourceRoot":"","sources":["../src/groupViolationResultsProcessor.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,gBAAgB,EAA+B,MAAM,mBAAmB,CAAC;AA0JlF;;;;;;GAMG;AACH,MAAM,CAAC,OAAO,UAAU,gBAAgB,CAAC,OAAO,EAAE,gBAAgB,GAAG,gBAAgB,CAapF"}

package/dist/groupViolationResultsProcessor.js

@@ -2,15 +2,45 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const common_1 = require("@sa11y/common");
 const format_1 = require("@sa11y/format");
+const formatSpacing = ' '.repeat(2);
+const formatForError = ' '.repeat(4);
+const axeMessages = {
+    toSolveAny: `\n${formatForError}- More Info: To solve the problem, you need to fix at least (1) of the following:\n`,
+    toSolveFirst: `\n${formatForError}- More Info: To solve the problem, you need to fix one of the following:\n`,
+    toSolveSecond: `\n${formatForError}- And fix the following:\n`,
+};
 /**
  * Create a test failure html elements array grouped by rule violation
  */
 function createA11yErrorElements(errorElements) {
     const a11yErrorElements = [];
     errorElements.forEach((errorElement, index) => {
-        a11yErrorElements.push(`- (${index + 1}) HTML element : ${errorElement.html.replace(/&lt;/g, '<').replace(/&gt;/, '>')}
-             - CSS selector(s) : ${errorElement.selectors.replace(/&gt;/, '>')}
-             - HTML Tag Hierarchy : ${errorElement.hierarchy}`);
+        let errorMessage = `${formatForError}(${index + 1})  - HTML element : ${errorElement.html
+            .replace(/&lt;/g, '<')
+            .replace(/&gt;/, '>')}
+        ${formatForError}- CSS selector(s) : ${errorElement.selectors.replace(/&gt;/, '>')}
+        ${formatForError}- HTML Tag Hierarchy : ${errorElement.hierarchy}`;
+        if (errorElement.any && errorElement.any.length > 0) {
+            errorMessage += `${axeMessages.toSolveAny}${errorElement.any}`;
+            if (errorElement.all && errorElement.all.length > 0) {
+                errorMessage += `${axeMessages.toSolveSecond}${errorElement.all}`;
+            }
+            if (errorElement.none && errorElement.none.length > 0) {
+                errorMessage += `${axeMessages.toSolveSecond}${errorElement.none}`;
+            }
+        }
+        else if (errorElement.all && errorElement.all.length > 0) {
+            errorMessage += `${axeMessages.toSolveFirst}${errorElement.all}`;
+            if (errorElement.none && errorElement.none.length > 0) {
+                errorMessage += `${axeMessages.toSolveSecond}${errorElement.none}`;
+            }
+        }
+        else {
+            if (errorElement.none && errorElement.none.length > 0) {
+                errorMessage += `${axeMessages.toSolveFirst}${errorElement.none}`;
+            }
+        }
+        a11yErrorElements.push(errorMessage);
     });
     return a11yErrorElements.join('\n');
 }
@@ -19,11 +49,11 @@ function createA11yErrorElements(errorElements) {
  */
 function createA11yRuleViolation(a11yRule, ruleIndex) {
     return `(${ruleIndex}) [${a11yRule.id}] ${a11yRule.description}
-            * Help URL: ${a11yRule.helpUrl}
-            * WCAG Criteria: ${a11yRule.wcagCriteria}
-            * More info: ${a11yRule.summary}
-            * Error element(s) : ${a11yRule.errorElements.length}
-            ${createA11yErrorElements(a11yRule.errorElements)}`;
+    ${formatSpacing}* Error element(s) : ${a11yRule.errorElements.length}
+    \n${createA11yErrorElements(a11yRule.errorElements)}
+    ${formatSpacing}* Help:
+    ${formatSpacing}${formatSpacing}• Help URL: ${a11yRule.helpUrl}
+    ${formatSpacing}${formatSpacing}• WCAG Criteria: ${a11yRule.wcagCriteria}`;
 }
 /**
  * Convert any a11y errors from test failures into their own test suite, results
@@ -62,7 +92,10 @@ function processA11yErrors(results, testSuite, testResult) {
                 a11yRuleViolations[a11yResult.wcag].errorElements.push({
                     html: a11yResult.html,
                     selectors: a11yResult.selectors,
-                    hierarchy: a11yResult.key,
+                    hierarchy: a11yResult.ancestry,
+                    any: a11yResult.any,
+                    all: a11yResult.all,
+                    none: a11yResult.none,
                 });
             });
             const a11yFailureMessage = `
@@ -72,6 +105,8 @@ function processA11yErrors(results, testSuite, testResult) {
             ${Object.values(a11yRuleViolations)
                 .map((a11yRuleViolation, index) => createA11yRuleViolation(a11yRuleViolation, index + 1))
                 .join('\n')}
+
+
             For more info about automated accessibility testing: https://sfdc.co/a11y-test
             For tips on fixing accessibility bugs: https://sfdc.co/a11y
             For technical questions regarding Salesforce accessibility tools, contact our Sa11y team: http://sfdc.co/sa11y-users

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@sa11y/jest",
-    "version": "6.6.2",
+    "version": "6.7.1-alpha.1",
     "description": "Accessibility testing matcher for Jest",
     "license": "BSD-3-Clause",
     "homepage": "https://github.com/salesforce/sa11y/tree/master/packages/jest#readme",
@@ -24,9 +24,9 @@
     ],
     "dependencies": {
         "@jest/test-result": "^27",
-        "@sa11y/assert": "6.6.2",
-        "@sa11y/format": "6.6.2",
-        "@sa11y/preset-rules": "6.6.2",
+        "@sa11y/assert": "6.7.1-alpha.1",
+        "@sa11y/format": "6.7.1-alpha.1",
+        "@sa11y/preset-rules": "6.7.1-alpha.1",
         "jest-matcher-utils": "^27"
     },
     "peerDependencies": {
@@ -34,8 +34,8 @@
     },
     "devDependencies": {
         "@jest/globals": "28.1.3",
-        "@sa11y/common": "6.6.2",
-        "@sa11y/test-utils": "6.6.2"
+        "@sa11y/common": "6.7.1-alpha.1",
+        "@sa11y/test-utils": "6.7.1-alpha.1"
     },
     "publishConfig": {
         "access": "public"
@@ -43,5 +43,5 @@
     "engines": {
         "node": "^16 || ^18"
     },
-    "gitHead": "03c66b2df14c3d80601e50e911a3eb40e8b5cbcd"
+    "gitHead": "42a62e360fcd24a0d072a24d6d18a64a41b9fd92"
 }