Merge pull request #264 from zaccolley/patch-1

Improved error message if results are unexpected
NickColley · Mar 23, 2023 · 07e1ef0 · 07e1ef0
2 parents b72f1b7 + 49c8789
commit 07e1ef0
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/__tests__/index.test.js b/__tests__/index.test.js
@@ -218,7 +218,9 @@ describe("jest-axe", () => {
       const matcherFunction = toHaveNoViolations.toHaveNoViolations;
       expect(() => {
         matcherFunction({});
-      }).toThrow("No violations found in aXe results object");
+      }).toThrow(
+        "Unexpected aXe results object. No violations property found.\nDid you change the `reporter` in your aXe configuration?"
+      );
     });
 
     it("returns pass as true when no violations are present", () => {

diff --git a/index.js b/index.js
@@ -123,7 +123,9 @@ function filterViolations(violations, impactLevels) {
 const toHaveNoViolations = {
   toHaveNoViolations(results) {
     if (typeof results.violations === "undefined") {
-      throw new Error("No violations found in aXe results object");
+      throw new Error(
+        "Unexpected aXe results object. No violations property found.\nDid you change the `reporter` in your aXe configuration?"
+      );
     }
 
     const violations = filterViolations(