Skip to content

Ignore markdown links inside HTML comments #259

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

Open
Ching Wei Kang (WilliamK112) wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Ignore markdown links inside HTML comments #259

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions src/test/documentLinks.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -459,8 +459,8 @@ suite('Link computer', () => {
assertLinksEqual(links, []);
});

test.skip('Should not detect links inside inline html comments', async () => {
// See #149678
test('Should not detect links inside inline html comments', async () => {
// See microsoft/vscode-markdown-languageservice#52
const links = await getLinksForText(joinLines(
`text <!-- <http://example.com> --> text`,
`text <!-- [text](./foo.md) --> text`,
Expand Down
6 changes: 6 additions & 0 deletions src/util/noLinkRanges.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import { rangeContains } from '../types/range.js';
import { ITextDocument } from '../types/textDocument.js';

const inlineCodePattern = /(?<!`)(`+)((?:.+?|.*?(?:(?:\r?\n).+?)*?)(?:\r?\n)?\1)(?!`)/gm;
const htmlCommentPattern = /<!--[\s\S]*?-->/g;

class InlineRanges {

Expand Down Expand Up @@ -60,6 +61,11 @@ export class NoLinkRanges {
const startPosition = document.positionAt(startOffset);
inlineRanges.add(lsp.Range.create(startPosition, document.positionAt(startOffset + match[0].length)));
}
for (const match of text.matchAll(htmlCommentPattern)) {
const startOffset = match.index ?? 0;
const startPosition = document.positionAt(startOffset);
inlineRanges.add(lsp.Range.create(startPosition, document.positionAt(startOffset + match[0].length)));
}

return new NoLinkRanges(multiline, inlineRanges);
}
Expand Down