Fix report() error message responsibility for a missing node or line number (#7474)

ybiquitous · jeddy3 · web-flow · commit eebb78694ee8 · 2024-01-21T00:00:09.000+09:00
Including a rule name in the error message helps us understand why an error happens.

Co-authored-by: Richard Hallows &lt;jeddy3@users.noreply.github.com&gt;
diff --git a/.changeset/weak-maps-tease.md b/.changeset/weak-maps-tease.md
@@ -0,0 +1,5 @@
+---
+"stylelint": patch
+---
+
+Fixed: `report()` error message responsibility for a missing node or line number
diff --git a/lib/utils/__tests__/report.test.mjs b/lib/utils/__tests__/report.test.mjs
@@ -419,3 +419,14 @@ test('with custom message function', () => {
 	expect(spyArgs[0]).toBe('a=str, b=123');
 	expect(spyArgs[1].node).toBe(v.node);
 });
+
+test('without node nor line', () => {
+	const v = {
+		ruleName: 'foo',
+		result: {},
+	};
+
+	expect(() => report(v)).toThrow(
+		'The "foo" rule failed to pass either a node or a line number to the `report()` function.',
+	);
+});
diff --git a/lib/utils/report.cjs b/lib/utils/report.cjs
@@ -47,7 +47,9 @@ function report(problem) {
 	const startLine = line || (start && start.line);
 
 	if (!startLine) {
-		throw new Error('You must pass either a node or a line number');
+		throw new Error(
+			`The "${ruleName}" rule failed to pass either a node or a line number to the \`report()\` function.`,
+		);
 	}
 
 	const { ignoreDisables } = result.stylelint.config || {};
diff --git a/lib/utils/report.mjs b/lib/utils/report.mjs
@@ -43,7 +43,9 @@ export default function report(problem) {
 	const startLine = line || (start && start.line);
 
 	if (!startLine) {
-		throw new Error('You must pass either a node or a line number');
+		throw new Error(
+			`The "${ruleName}" rule failed to pass either a node or a line number to the \`report()\` function.`,
+		);
 	}
 
 	const { ignoreDisables } = result.stylelint.config || {};

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +"stylelint": patch
 +---
++
 +Fixed: `report()` error message responsibility for a missing node or line number
Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,9 @@ function report(problem) {`
`47`	`47`	`const startLine = line \|\| (start && start.line);`
`48`	`48`
`49`	`49`	`if (!startLine) {`
`50`		`- throw new Error('You must pass either a node or a line number');`
	`50`	`+ throw new Error(`
	`51`	+ `The "${ruleName}" rule failed to pass either a node or a line number to the \`report()\` function.`,
	`52`	`+ );`
`51`	`53`	`}`
`52`	`54`
`53`	`55`	`const { ignoreDisables } = result.stylelint.config \|\| {};`
Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,9 @@ export default function report(problem) {`
`43`	`43`	`const startLine = line \|\| (start && start.line);`
`44`	`44`
`45`	`45`	`if (!startLine) {`
`46`		`- throw new Error('You must pass either a node or a line number');`
	`46`	`+ throw new Error(`
	`47`	+ `The "${ruleName}" rule failed to pass either a node or a line number to the \`report()\` function.`,
	`48`	`+ );`
`47`	`49`	`}`
`48`	`50`
`49`	`51`	`const { ignoreDisables } = result.stylelint.config \|\| {};`