Skip to content

refactor: use getlocfromindex in no-missing-label-refs #547

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 2 commits into from
Oct 2, 2025
Merged

refactor: use getlocfromindex in no-missing-label-refs #547

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a4f6a52
refactor: use `getlocfromindex` in `no-missing-label-refs`
lumirlumir Oct 1, 2025
eb8e377
Update src/rules/no-missing-label-refs.js
lumirlumir Oct 1, 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
35 changes: 11 additions & 24 deletions src/rules/no-missing-label-refs.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
// Imports
//-----------------------------------------------------------------------------

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

//-----------------------------------------------------------------------------
// Type Definitions
Expand All @@ -17,6 +17,7 @@ import { findOffsets, illegalShorthandTailPattern } from "../util.js";
* @import { Position } from "unist";
* @import { Text } from "mdast";
* @import { MarkdownRuleDefinition } from "../types.js";
* @import { MarkdownSourceCode } from "../language/markdown-source-code.js";
* @typedef {"notFound"} NoMissingLabelRefsMessageIds
* @typedef {[{ allowLabels?: string[] }]} NoMissingLabelRefsOptions
* @typedef {MarkdownRuleDefinition<{ RuleOptions: NoMissingLabelRefsOptions, MessageIds: NoMissingLabelRefsMessageIds }>} NoMissingLabelRefsRuleDefinition
Expand All @@ -29,14 +30,13 @@ import { findOffsets, illegalShorthandTailPattern } from "../util.js";
/**
* Finds missing references in a node.
* @param {Text} node The node to check.
* @param {string} nodeText The text of the node.
* @param {MarkdownSourceCode} sourceCode The Markdown source code object.
* @returns {Array<{label:string,position:Position}>} The missing references.
*/
function findMissingReferences(node, nodeText) {
function findMissingReferences(node, sourceCode) {
/** @type {Array<{label:string,position:Position}>} */
const missing = [];
const nodeStartLine = node.position.start.line;
const nodeStartColumn = node.position.start.column;
const nodeText = sourceCode.getText(node);

/**
* Matches substrings like `"[foo]"`, `"[]"`, `"[foo][bar]"`, `"[foo][]"`, `"[][bar]"`, or `"[][]"`.
Expand All @@ -46,6 +46,7 @@ function findMissingReferences(node, nodeText) {
const labelPattern =
/(?<=(?<!\\)(?:\\{2})*)\[(?<left>(?:\\.|[^[\]\\])*)\](?:\[(?<right>(?:\\.|[^\]\\])*)\])?/dgu;

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

/*
Expand Down Expand Up @@ -75,28 +76,14 @@ function findMissingReferences(node, nodeText) {
labelIndices = match.indices.groups.left;
}

const { lineOffset: startLineOffset, columnOffset: startColumnOffset } =
findOffsets(nodeText, labelIndices[0]);
const { lineOffset: endLineOffset, columnOffset: endColumnOffset } =
findOffsets(nodeText, labelIndices[1]);
const startOffset = labelIndices[0] + node.position.start.offset;
const endOffset = labelIndices[1] + node.position.start.offset;

missing.push({
label: label.trim(),
position: {
start: {
line: nodeStartLine + startLineOffset,
column:
startLineOffset > 0
? startColumnOffset + 1
: nodeStartColumn + startColumnOffset,
},
end: {
line: nodeStartLine + endLineOffset,
column:
endLineOffset > 0
? endColumnOffset + 1
: nodeStartColumn + endColumnOffset,
},
start: sourceCode.getLocFromIndex(startOffset),
end: sourceCode.getLocFromIndex(endOffset),
},
});
}
Expand Down Expand Up @@ -169,7 +156,7 @@ export default {
text(node) {
const missingReferences = findMissingReferences(
node,
sourceCode.getText(node),
sourceCode,
);

for (const missingReference of missingReferences) {
Expand Down