feat: output full actual location in rule tester if different (#19904)

ST-DDT · mdjermanovic · web-flow · commit 35cf44c22e36 · 2025-07-07T14:35:56.000-04:00
* test: output full location in rule tester

* refactor: treat lcoation as atomic unit

* refactor: use default assertion message

* Update lib/rule-tester/rule-tester.js

Co-authored-by: Milos Djermanovic &lt;milos.djermanovic@gmail.com&gt;

* test: update expected error message

---------

Co-authored-by: Milos Djermanovic &lt;milos.djermanovic@gmail.com&gt;
diff --git a/lib/rule-tester/rule-tester.js b/lib/rule-tester/rule-tester.js
@@ -1236,35 +1236,34 @@ class RuleTester {
 							);
 						}
 
+						const actualLocation = {};
+						const expectedLocation = {};
+
 						if (hasOwnProperty(error, "line")) {
-							assert.strictEqual(
-								message.line,
-								error.line,
-								`Error line should be ${error.line}`,
-							);
+							actualLocation.line = message.line;
+							expectedLocation.line = error.line;
 						}
 
 						if (hasOwnProperty(error, "column")) {
-							assert.strictEqual(
-								message.column,
-								error.column,
-								`Error column should be ${error.column}`,
-							);
+							actualLocation.column = message.column;
+							expectedLocation.column = error.column;
 						}
 
 						if (hasOwnProperty(error, "endLine")) {
-							assert.strictEqual(
-								message.endLine,
-								error.endLine,
-								`Error endLine should be ${error.endLine}`,
-							);
+							actualLocation.endLine = message.endLine;
+							expectedLocation.endLine = error.endLine;
 						}
 
 						if (hasOwnProperty(error, "endColumn")) {
-							assert.strictEqual(
-								message.endColumn,
-								error.endColumn,
-								`Error endColumn should be ${error.endColumn}`,
+							actualLocation.endColumn = message.endColumn;
+							expectedLocation.endColumn = error.endColumn;
+						}
+
+						if (Object.keys(expectedLocation).length > 0) {
+							assert.deepStrictEqual(
+								actualLocation,
+								expectedLocation,
+								"Actual error location does not match expected error location.",
 							);
 						}
 
diff --git a/tests/lib/rule-tester/rule-tester.js b/tests/lib/rule-tester/rule-tester.js
@@ -1292,7 +1292,7 @@ describe("RuleTester", () => {
 					],
 				},
 			);
-		}, /Error line should be 5/u);
+		}, "Actual error location does not match expected error location.");
 	});
 
 	it("should not skip line assertion if line is a falsy value", () => {
@@ -1316,12 +1316,11 @@ describe("RuleTester", () => {
 					],
 				},
 			);
-		}, /Error line should be 0/u);
+		}, "Actual error location does not match expected error location.");
 	});
 
 	it("should throw an error if invalid code specifies wrong column", () => {
-		const wrongColumn = 10,
-			expectedErrorMessage = "Error column should be 1";
+		const wrongColumn = 10;
 
 		assert.throws(() => {
 			ruleTester.run(
@@ -1342,7 +1341,7 @@ describe("RuleTester", () => {
 					],
 				},
 			);
-		}, expectedErrorMessage);
+		}, "Actual error location does not match expected error location.");
 	});
 
 	it("should throw error for empty error array", () => {
@@ -1398,7 +1397,7 @@ describe("RuleTester", () => {
 					],
 				},
 			);
-		}, /Error column should be 0/u);
+		}, "Actual error location does not match expected error location.");
 	});
 
 	it("should throw an error if invalid code specifies wrong endLine", () => {
@@ -1423,7 +1422,7 @@ describe("RuleTester", () => {
 					],
 				},
 			);
-		}, "Error endLine should be 10");
+		}, "Actual error location does not match expected error location.");
 	});
 
 	it("should throw an error if invalid code specifies wrong endColumn", () => {
@@ -1448,7 +1447,7 @@ describe("RuleTester", () => {
 					],
 				},
 			);
-		}, "Error endColumn should be 10");
+		}, "Actual error location does not match expected error location.");
 	});
 
 	it("should throw an error if invalid code has the wrong number of errors", () => {
