Skip to content

#57104 add code folding in markdown based on bullet point hierarchy #57877

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

Closed
wants to merge 1 commit into from
Closed

#57104 add code folding in markdown based on bullet point hierarchy #57877

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
59 changes: 56 additions & 3 deletions extensions/markdown-language-features/src/tableOfContentsProvider.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@

import * as vscode from 'vscode';
import { MarkdownEngine } from './markdownEngine';
import { Token } from 'markdown-it';
import { Slug, githubSlugifier } from './slugify';

export interface TocEntry {
Expand Down Expand Up @@ -48,15 +49,22 @@ export class TableOfContentsProvider {
}

private async buildToc(document: SkinnyTextDocument): Promise<TocEntry[]> {
const toc: TocEntry[] = [];
const tokens = await this.engine.parse(document.uri, document.getText());
return [
...this.buildHeadingToc(document, tokens),
...this.buildBulletToc(document, tokens),
];
}

private buildHeadingToc(document: SkinnyTextDocument, tokens: Token[]) {
const toc: TocEntry[] = [];

for (const heading of tokens.filter(token => token.type === 'heading_open')) {
const lineNumber = heading.map[0];
const line = document.lineAt(lineNumber);
toc.push({
slug: githubSlugifier.fromHeading(line.text),
text: TableOfContentsProvider.getHeaderText(line.text),
text: TableOfContentsProvider.getText(line.text),
level: TableOfContentsProvider.getHeaderLevel(heading.markup),
line: lineNumber,
location: new vscode.Location(document.uri, line.range)
Expand All @@ -83,6 +91,51 @@ export class TableOfContentsProvider {
});
}

private buildBulletToc(document: SkinnyTextDocument, tokens: Token[]) {
const toc: TocEntry[] = [];
const trimedToc: TocEntry[] = [];

let bulletLevel = 1;
tokens.forEach(token => {
if (token.type === 'list_item_open') {
const lineNumber = token.map[0];
const line = document.lineAt(lineNumber);
toc.push({
slug: githubSlugifier.fromHeading(line.text),
text: TableOfContentsProvider.getText(line.text),
level: bulletLevel++,
line: lineNumber,
location: new vscode.Location(document.uri, line.range)
});
} else if (token.type === 'list_item_close') {
bulletLevel--;
}
});

toc.forEach((entry, startIndex) => {
let end: number | undefined = undefined;
for (let i = startIndex + 1; i < toc.length; ++i) {
if (toc[i].level <= entry.level) {
end = toc[i].line - 1;
break;
}
}
if (typeof end === 'undefined' && startIndex !== toc.length) {
end = toc[toc.length - 1].line;
}
if (typeof end === 'number') {
trimedToc.push({
...entry,
location: new vscode.Location(document.uri,
new vscode.Range(
entry.location.range.start,
new vscode.Position(end, document.lineAt(end).range.end.character)))
});
}
});
return trimedToc;
}

private static getHeaderLevel(markup: string): number {
if (markup === '=') {
return 1;
Expand All @@ -93,7 +146,7 @@ export class TableOfContentsProvider {
}
}

private static getHeaderText(header: string): string {
private static getText(header: string): string {
return header.replace(/^\s*#+\s*(.*?)\s*#*$/, (_, word) => word.trim());
}
}