fix: report locations in no-multiple-h1 and require-alt-text (#551)

* fix: report locations in `no-multiple-h1` and require-alt-text

* update tests to avoid problems with dedent in Bun

* fix note

Author: mdjermanovic

src/util.js

@@ -71,12 +71,18 @@ export function frontmatterHasTitle(value, pattern) {
 }
 
 /**
- * Remove all HTML comments from a string.
+ * Replaces all HTML comments with whitespace.
+ * This preserves offsets and locations of characters
+ * outside HTML comments by keeping line breaks and replacing
+ * other code units with a space character.
  * @param {string} value The string to remove HTML comments from.
  * @returns {string} The string with HTML comments removed.
  */
 export function stripHtmlComments(value) {
 	return value.replace(htmlCommentPattern, match =>
-		match.replace(/[^\n]/gu, " "),
+		/* eslint-disable-next-line require-unicode-regexp
+		   -- we want to replace each code unit with a space
+		*/
+		match.replace(/[^\r\n]/g, " "),
 	);
 }

tests/rules/no-multiple-h1.test.js

@@ -1202,5 +1202,18 @@ ruleTester.run("no-multiple-h1", rule, {
 				},
 			],
 		},
+		{
+			// NOTE: dedent`` converts 👍🚀 to \u{1f44d}\u{1f680} in Bun, causing unexpected report locations
+			code: "<h1>Heading 1</h1>\n<!-- comment with surrogate pairs: 👍🚀 --> <h1>Another H1</h1>",
+			errors: [
+				{
+					messageId: "multipleH1",
+					line: 2,
+					column: 45,
+					endLine: 2,
+					endColumn: 64,
+				},
+			],
+		},
 	],
 });

tests/rules/require-alt-text.test.js

@@ -309,5 +309,18 @@ ruleTester.run("require-alt-text", rule, {
 				},
 			],
 		},
+		{
+			// NOTE: dedent`` converts 👍🚀 to \u{1f44d}\u{1f680} in Bun, causing unexpected report locations
+			code: '<!-- comment with surrogate pairs: 👍🚀 --> <img src="image.png" />',
+			errors: [
+				{
+					messageId: "altTextRequired",
+					line: 1,
+					column: 45,
+					endLine: 1,
+					endColumn: 68,
+				},
+			],
+		},
 	],
 });