Skip to content

refactor: use getLocFromIndex in no-reversed-media-syntax #541

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 29, 2025
Merged

refactor: use getLocFromIndex in no-reversed-media-syntax #541

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6874d86
refactor: use `getLocFromIndex` in `no-reversed-media-syntax`
lumirlumir Sep 29, 2025
de39238
wip
lumirlumir Sep 29, 2025
39683a6
wip
lumirlumir Sep 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
84 changes: 19 additions & 65 deletions src/rules/no-reversed-media-syntax.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,13 @@
* @author xbinaryx
*/

//-----------------------------------------------------------------------------
// Imports
//-----------------------------------------------------------------------------

import { findOffsets } from "../util.js";

//-----------------------------------------------------------------------------
// Type Definitions
//-----------------------------------------------------------------------------

/**
* @import { SourceRange } from "@eslint/core"
* @import { Heading, Paragraph, TableCell } from "mdast";
* @import { Heading, Paragraph, TableCell, Html, InlineCode } from "mdast";
* @import { MarkdownRuleDefinition } from "../types.js";
* @typedef {"reversedSyntax"} NoReversedMediaSyntaxMessageIds
* @typedef {[]} NoReversedMediaSyntaxOptions
Expand All @@ -28,7 +22,7 @@ import { findOffsets } from "../util.js";

/** Matches reversed link/image syntax like `(text)[url]`, ignoring escaped characters like `\(text\)[url]`. */
const reversedPattern =
/(?<=(?<!\\)(?:\\{2})*)\(((?:\\.|[^()\\]|\([\s\S]*\))*)\)\[((?:\\.|[^\]\\\n])*)\](?!\()/gu;
/(?<=(?<!\\)(?:\\{2})*)\((?<label>(?:\\.|[^()\\]|\([\s\S]*\))*)\)\[(?<url>(?:\\.|[^\]\\\n])*)\](?!\()/dgu;

/**
* Checks if a match is within any skip range
Expand Down Expand Up @@ -69,7 +63,7 @@ export default {
const { sourceCode } = context;

/** @type {Array<SourceRange>} */
let skipRanges = [];
const skipRanges = [];

/**
* Finds reversed link/image syntax in a node.
Expand All @@ -78,61 +72,27 @@ export default {
*/
function findReversedMediaSyntax(node) {
const text = sourceCode.getText(node);

/** @type {RegExpExecArray} */
let match;

while ((match = reversedPattern.exec(text)) !== null) {
const [reversedSyntax, label, url] = match;
const matchIndex = match.index;
const matchLength = reversedSyntax.length;

if (
isInSkipRange(
matchIndex + node.position.start.offset,
skipRanges,
)
) {
const { label, url } = match.groups;
const [startOffset, endOffset] = match.indices[0].map(
index => index + node.position.start.offset,
); // Adjust `reversedPattern` match indices to the full source code.

if (isInSkipRange(startOffset, skipRanges)) {
continue;
}

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,
},
start: sourceCode.getLocFromIndex(startOffset),
end: sourceCode.getLocFromIndex(endOffset),
},
messageId: "reversedSyntax",
fix(fixer) {
const startOffset =
node.position.start.offset + matchIndex;
const endOffset = startOffset + matchLength;

return fixer.replaceTextRange(
[startOffset, endOffset],
`[${label}](${url})`,
Expand All @@ -143,31 +103,25 @@ export default {
}

return {
"heading :matches(html, inlineCode)"(node) {
":matches(heading, paragraph, tableCell) :matches(html, inlineCode)"(
/** @type {Html | InlineCode} */ node,
) {
skipRanges.push(sourceCode.getRange(node));
},

"heading:exit"(node) {
findReversedMediaSyntax(node);
skipRanges = [];
},

"paragraph :matches(html, inlineCode)"(node) {
skipRanges.push(sourceCode.getRange(node));
skipRanges.length = 0;
},

"paragraph:exit"(node) {
findReversedMediaSyntax(node);
skipRanges = [];
},

"tableCell :matches(html, inlineCode)"(node) {
skipRanges.push(sourceCode.getRange(node));
skipRanges.length = 0;
},

"tableCell:exit"(node) {
findReversedMediaSyntax(node);
skipRanges = [];
skipRanges.length = 0;
},
};
},
Expand Down
Loading