Skip to content

refactor: use getLocFromIndex in no-multiple-h1 #542

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 4 commits into from
Sep 29, 2025
Merged

refactor: use getLocFromIndex in no-multiple-h1 #542

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
15e153f
refactor: use `getLocFromIndex` in `no-multiple-h1`
lumirlumir Sep 29, 2025
c4c92ed
wip
lumirlumir Sep 29, 2025
a421db1
wip
lumirlumir Sep 29, 2025
0004952
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
63 changes: 12 additions & 51 deletions src/rules/no-multiple-h1.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,15 @@
// Imports
//-----------------------------------------------------------------------------

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

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

/**
* @import { MarkdownRuleDefinition } from "../types.js";
* @import { Yaml } from "mdast";
* @import { MarkdownRuleDefinition, Toml, Json } from "../types.js";
* @typedef {"multipleH1"} NoMultipleH1MessageIds
* @typedef {[{ frontmatterTitle?: string }]} NoMultipleH1Options
* @typedef {MarkdownRuleDefinition<{ RuleOptions: NoMultipleH1Options, MessageIds: NoMultipleH1MessageIds }>} NoMultipleH1RuleDefinition
Expand Down Expand Up @@ -70,25 +67,14 @@ export default {
},

create(context) {
const { sourceCode } = context;
const [{ frontmatterTitle }] = context.options;
const titlePattern =
frontmatterTitle === "" ? null : new RegExp(frontmatterTitle, "iu");
let h1Count = 0;

return {
yaml(node) {
if (frontmatterHasTitle(node.value, titlePattern)) {
h1Count++;
}
},

toml(node) {
if (frontmatterHasTitle(node.value, titlePattern)) {
h1Count++;
}
},

json(node) {
"yaml, toml, json"(/** @type {Yaml | Toml | Json} */ node) {
if (frontmatterHasTitle(node.value, titlePattern)) {
h1Count++;
}
Expand All @@ -97,45 +83,20 @@ export default {
html(node) {
const text = stripHtmlComments(node.value);

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

while ((match = h1TagPattern.exec(text)) !== null) {
h1Count++;
if (h1Count > 1) {
const {
lineOffset: startLineOffset,
columnOffset: startColumnOffset,
} = findOffsets(node.value, match.index);

const {
lineOffset: endLineOffset,
columnOffset: endColumnOffset,
} = findOffsets(
node.value,
match.index + match[0].length,
);

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
: 1) + startColumnOffset;
const endColumn =
(endLine === nodeStartLine ? nodeStartColumn : 1) +
endColumnOffset;
const startOffset = // Adjust `h1TagPattern` match index to the full source code.
match.index + node.position.start.offset;
const endOffset = startOffset + match[0].length;

context.report({
loc: {
start: {
line: startLine,
column: startColumn,
},
end: {
line: endLine,
column: endColumn,
},
start: sourceCode.getLocFromIndex(startOffset),
end: sourceCode.getLocFromIndex(endOffset),
},
messageId: "multipleH1",
});
Expand Down
Loading