fix: report locations with <CR> linebreaks in no-reference-like-urls (#525)

* fix: report locations with <CR> linebreaks in `no-reference-like-urls`

* update regex end

* add type for node

Co-authored-by: 루밀LuMir <[email protected]>

* update type names

---------

Co-authored-by: 루밀LuMir <[email protected]>

Author: mdjermanovic

src/rules/no-reference-like-urls.js

@@ -8,19 +8,17 @@
 //-----------------------------------------------------------------------------
 
 import { normalizeIdentifier } from "micromark-util-normalize-identifier";
-import { findOffsets } from "../util.js";
 
 //-----------------------------------------------------------------------------
 // Type Definitions
 //-----------------------------------------------------------------------------
 
 /**
- * @import { SourceRange } from "@eslint/core"
- * @import { Heading, Paragraph, TableCell } from "mdast";
+ * @import { Image, Link } from "mdast";
  * @import { MarkdownRuleDefinition } from "../types.js";
- * @typedef {"referenceLikeUrl"} NoReferenceLikeUrlMessageIds
- * @typedef {[]} NoReferenceLikeUrlOptions
- * @typedef {MarkdownRuleDefinition<{ RuleOptions: NoReferenceLikeUrlOptions, MessageIds: NoReferenceLikeUrlMessageIds }>} NoReferenceLikeUrlRuleDefinition
+ * @typedef {"referenceLikeUrl"} NoReferenceLikeUrlsMessageIds
+ * @typedef {[]} NoReferenceLikeUrlsOptions
+ * @typedef {MarkdownRuleDefinition<{ RuleOptions: NoReferenceLikeUrlsOptions, MessageIds: NoReferenceLikeUrlsMessageIds }>} NoReferenceLikeUrlsRuleDefinition
  */
 
 //-----------------------------------------------------------------------------
@@ -29,23 +27,13 @@ import { findOffsets } from "../util.js";
 
 /** Pattern to match both inline links: `[text](url)` and images: `![alt](url)`, with optional title */
 const linkOrImagePattern =
-	/(?<=(?<!\\)(?:\\{2})*)(?<imageBang>!)?\[(?<label>(?:\\.|[^()\\]|\([\s\S]*\))*?)\]\((?<destination>[ \t]*(?:\r\n?|\n)?(?<![ \t])[ \t]*(?:<[^>]*>|[^ \t()]+))(?:[ \t]*(?:\r\n?|\n)?(?<![ \t])[ \t]*(?<title>"[^"]*"|'[^']*'|\([^)]*\)))?[ \t]*(?:\r\n?|\n)?(?<![ \t])[ \t]*\)(?!\()/gu;
-
-/**
- * Checks if a given index is within any skip range.
- * @param {number} index The index to check
- * @param {Array<SourceRange>} skipRanges The skip ranges
- * @returns {boolean} True if index is in a skip range
- */
-function isInSkipRange(index, skipRanges) {
-	return skipRanges.some(range => range[0] <= index && index < range[1]);
-}
+	/(?<imageBang>!)?\[(?<label>(?:\\.|[^()\\]|\([\s\S]*\))*?)\]\((?<destination>[ \t]*(?:\r\n?|\n)?(?<![ \t])[ \t]*(?:<[^>]*>|[^ \t()]+))(?:[ \t]*(?:\r\n?|\n)?(?<![ \t])[ \t]*(?<title>"[^"]*"|'[^']*'|\([^)]*\)))?[ \t]*(?:\r\n?|\n)?(?<![ \t])[ \t]*\)$/u;
 
 //-----------------------------------------------------------------------------
 // Rule Definition
 //-----------------------------------------------------------------------------
 
-/** @type {NoReferenceLikeUrlRuleDefinition} */
+/** @type {NoReferenceLikeUrlsRuleDefinition} */
 export default {
 	meta: {
 		type: "problem",
@@ -67,66 +55,33 @@ export default {
 
 	create(context) {
 		const { sourceCode } = context;
-		/** @type {Array<SourceRange>} */
-		const skipRanges = [];
 		/** @type {Set<string>} */
 		const definitionIdentifiers = new Set();
-		/** @type {Array<Heading | Paragraph | TableCell>} */
+		/** @type {Array<Image | Link>} */
 		const relevantNodes = [];
 
 		return {
 			definition(node) {
 				definitionIdentifiers.add(node.identifier);
 			},
 
-			heading(node) {
-				relevantNodes.push(node);
-			},
-
-			"heading :matches(html, inlineCode)"(node) {
-				skipRanges.push(sourceCode.getRange(node));
-			},
-
-			paragraph(node) {
+			"image, link"(/** @type {Image | Link} */ node) {
 				relevantNodes.push(node);
 			},
 
-			"paragraph :matches(html, inlineCode)"(node) {
-				skipRanges.push(sourceCode.getRange(node));
-			},
-
-			tableCell(node) {
-				relevantNodes.push(node);
-			},
-
-			"tableCell :matches(html, inlineCode)"(node) {
-				skipRanges.push(sourceCode.getRange(node));
-			},
-
 			"root:exit"() {
 				for (const node of relevantNodes) {
 					const text = sourceCode.getText(node);
 
-					let match;
-					while ((match = linkOrImagePattern.exec(text)) !== null) {
+					const match = linkOrImagePattern.exec(text);
+					if (match !== null) {
 						const {
 							imageBang,
 							label,
 							destination,
 							title: titleRaw,
 						} = match.groups;
 						const title = titleRaw?.slice(1, -1);
-						const matchIndex = match.index;
-						const matchLength = match[0].length;
-
-						if (
-							isInSkipRange(
-								matchIndex + node.position.start.offset,
-								skipRanges,
-							)
-						) {
-							continue;
-						}
 
 						const isImage = !!imageBang;
 						const type = isImage ? "image" : "link";
@@ -135,37 +90,8 @@ export default {
 							normalizeIdentifier(destination).toLowerCase();
 
 						if (definitionIdentifiers.has(url)) {
-							const {
-								lineOffset: startLineOffset,
-								columnOffset: startColumnOffset,
-							} = findOffsets(text, matchIndex);
-							const {
-								lineOffset: endLineOffset,
-								columnOffset: endColumnOffset,
-							} = findOffsets(text, matchIndex + matchLength);
-
-							const baseColumn = 1;
-							const nodeStartLine = node.position.start.line;
-							const nodeStartColumn = node.position.start.column;
-							const startLine = nodeStartLine + startLineOffset;
-							const endLine = nodeStartLine + endLineOffset;
-							const startColumn =
-								(startLine === nodeStartLine
-									? nodeStartColumn
-									: baseColumn) + startColumnOffset;
-							const endColumn =
-								(endLine === nodeStartLine
-									? nodeStartColumn
-									: baseColumn) + endColumnOffset;
-
 							context.report({
-								loc: {
-									start: {
-										line: startLine,
-										column: startColumn,
-									},
-									end: { line: endLine, column: endColumn },
-								},
+								loc: node.position,
 								messageId: "referenceLikeUrl",
 								data: {
 									type,
@@ -177,12 +103,8 @@ export default {
 										return null;
 									}
 
-									const startOffset =
-										node.position.start.offset + matchIndex;
-									const endOffset = startOffset + matchLength;
-
-									return fixer.replaceTextRange(
-										[startOffset, endOffset],
+									return fixer.replaceText(
+										node,
 										`${prefix}[${label}][${destination}]`,
 									);
 								},

tests/rules/no-reference-like-urls.test.js

@@ -267,8 +267,8 @@ ruleTester.run("no-reference-like-urls", rule, {
 					data: { type: "link", prefix: "" },
 					line: 1,
 					column: 1,
-					endLine: 1,
-					endColumn: 20,
+					endLine: 2,
+					endColumn: 9,
 				},
 			],
 		},
@@ -333,8 +333,8 @@ ruleTester.run("no-reference-like-urls", rule, {
 					data: { type: "image", prefix: "!" },
 					line: 1,
 					column: 1,
-					endLine: 1,
-					endColumn: 21,
+					endLine: 2,
+					endColumn: 9,
 				},
 			],
 		},