fix: no-invalid-label-refs do not report correct position (#366)

Author: lumirlumir

src/rules/no-invalid-label-refs.js

@@ -15,6 +15,7 @@ import { findOffsets, illegalShorthandTailPattern } from "../util.js";
 
 /** @typedef {import("unist").Position} Position */
 /** @typedef {import("mdast").Text} TextNode */
+/** @typedef {Parameters<import("../types.ts").MarkdownRuleDefinition['create']>[0]['sourceCode']} sourceCode */
 /**
  * @typedef {import("../types.ts").MarkdownRuleDefinition<{ RuleOptions: []; }>}
  * NoInvalidLabelRuleDefinition
@@ -30,10 +31,12 @@ const labelPattern = /\]\[([^\]]+)\]/u;
 /**
  * Finds missing references in a node.
  * @param {TextNode} node The node to check.
- * @param {string} docText The text of the node.
+ * @param {sourceCode} sourceCode The Markdown source code object.
  * @returns {Array<{label:string,position:Position}>} The missing references.
  */
-function findInvalidLabelReferences(node, docText) {
+function findInvalidLabelReferences(node, sourceCode) {
+	const nodeText = sourceCode.getText(node);
+	const docText = sourceCode.text;
 	const invalid = [];
 	let startIndex = 0;
 	const offset = node.position.start.offset;
@@ -47,8 +50,8 @@ function findInvalidLabelReferences(node, docText) {
 	 * It then moves the start index to the end of the label reference and
 	 * continues searching the text until the end of the text is found.
 	 */
-	while (startIndex < node.value.length) {
-		const value = node.value.slice(startIndex);
+	while (startIndex < nodeText.length) {
+		const value = nodeText.slice(startIndex);
 		const match = value.match(labelPattern);
 
 		if (!match) {
@@ -87,11 +90,11 @@ function findInvalidLabelReferences(node, docText) {
 
 		// find location of [ in the document text
 		const { lineOffset: startLineOffset, columnOffset: startColumnOffset } =
-			findOffsets(node.value, nodeMatchIndex + 1);
+			findOffsets(nodeText, nodeMatchIndex + 1);
 
 		// find location of [ in the document text
 		const { lineOffset: endLineOffset, columnOffset: endColumnOffset } =
-			findOffsets(node.value, nodeMatchIndex + match[0].length);
+			findOffsets(nodeText, nodeMatchIndex + match[0].length);
 
 		const startLine = nodeStartLine + startLineOffset;
 		const startColumn = nodeStartColumn + startColumnOffset;
@@ -147,7 +150,7 @@ export default {
 			text(node) {
 				const invalidReferences = findInvalidLabelReferences(
 					node,
-					sourceCode.text,
+					sourceCode,
 				);
 
 				for (const invalidReference of invalidReferences) {

tests/rules/no-invalid-label-refs.test.js

@@ -127,5 +127,44 @@ ruleTester.run("no-invalid-label-refs", rule, {
 				},
 			],
 		},
+		{
+			code: "eslint [eslint][ ]",
+			errors: [
+				{
+					messageId: "invalidLabelRef",
+					data: { label: "eslint" },
+					line: 1,
+					column: 16,
+					endLine: 1,
+					endColumn: 19,
+				},
+			],
+		},
+		{
+			code: "\\\\eslint [eslint][ ]",
+			errors: [
+				{
+					messageId: "invalidLabelRef",
+					data: { label: "eslint" },
+					line: 1,
+					column: 18,
+					endLine: 1,
+					endColumn: 21,
+				},
+			],
+		},
+		{
+			code: "es\\\\lint\\\\ [eslint][ ]",
+			errors: [
+				{
+					messageId: "invalidLabelRef",
+					data: { label: "eslint" },
+					line: 1,
+					column: 20,
+					endLine: 1,
+					endColumn: 23,
+				},
+			],
+		},
 	],
 });