Microsoft/vscode
1
0
Fork 0
mirror of https://github.com/microsoft/vscode.git synced 2025-12-24 12:19:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fixing markdown unit tests

Browse Source
This commit is contained in:
Matt Bierner
2019-01-09 18:15:34 -08:00
parent 9140285092
commit e325cce9bc
4 changed files with 35 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

57
extensions/markdown-language-features/src/markdownEngine.ts
View File

@@ -13,16 +13,19 @@ import { SkinnyTextDocument } from './tableOfContentsProvider';
import { getUriForLinkWithKnownExternalScheme } from './util/links';
const FrontMatterRegex = /^---\s*[^]*?(-{3}|\.{3})\s*/;
const UNICODE_NEWLINE_REGEX = /\u2028|\u2029/g;
export class MarkdownEngine {
private md?: MarkdownIt;
private firstLine?: number;
private currentDocument?: vscode.Uri;
private _slugCount = new Map<string, number>();
private cachedTokens = new Map<vscode.Uri, Token[]>();
private _cache?: {
readonly document: vscode.Uri;
readonly version: number;
readonly tokens: Token[]
};
public constructor(
private readonly extensionPreviewResourceProvider: MarkdownContributions,
@@ -86,24 +89,32 @@ export class MarkdownEngine {
return this.md;
}
private stripFrontmatter(text: string): { text: string, offset: number } {
private stripFrontmatter(text: string): { frontMatter?: string, body: string, lineOffset: number } {
let offset = 0;
const frontMatterMatch = FrontMatterRegex.exec(text);
let frontMatter: string | undefined;
if (frontMatterMatch) {
const frontMatter = frontMatterMatch[0];
frontMatter = frontMatterMatch[0];
offset = frontMatter.split(/\r\n|\n|\r/g).length - 1;
text = text.substr(frontMatter.length);
}
return { text, offset };
return { frontMatter, body: text, lineOffset: offset };
}
private tokenize(document: SkinnyTextDocument, engine: MarkdownIt): Token[] {
const UNICODE_NEWLINE_REGEX = /\u2028|\u2029/g;
const { text, offset } = this.stripFrontmatter(document.getText());
const { body: text, lineOffset: offset } = this.stripFrontmatter(document.getText());
const uri = document.uri;
if (this.cachedTokens.has(uri)) {
return this.cachedTokens.get(uri)!;
if (this._cache
&& this._cache.document.toString() === uri.toString()
&& this._cache.version === document.version
) {
return this._cache.tokens;
}
this.currentDocument = document.uri;
this._slugCount = new Map<string, number>();
this.firstLine = offset;
const tokens = engine.parse(text.replace(UNICODE_NEWLINE_REGEX, ''), {}).map(token => {
if (token.map) {
token.map[0] += offset;
@@ -111,29 +122,21 @@ export class MarkdownEngine {
}
return token;
});
this.cachedTokens.set(uri, tokens);
this._cache = {
tokens,
document: uri,
version: document.version
};
return tokens;
}
public async render(document: SkinnyTextDocument, stripFrontmatter: boolean): Promise<string> {
let offset = 0;
let text = document.getText();
if (stripFrontmatter) {
const markdownContent = this.stripFrontmatter(text);
offset = markdownContent.offset;
text = markdownContent.text;
}
this.currentDocument = document.uri;
this.firstLine = offset;
this._slugCount = new Map<string, number>();
public async render(document: SkinnyTextDocument, _stripFrontmatter: boolean): Promise<string> {
const engine = await this.getEngine(document.uri);
return engine.renderer.render(this.tokenize(document, engine), this.md, {});
const html = engine.renderer.render(this.tokenize(document, engine), this.md, {});
return html;
}
public async parse(document: SkinnyTextDocument): Promise<Token[]> {
this.currentDocument = document.uri;
this._slugCount = new Map<string, number>();
const engine = await this.getEngine(document.uri);
return this.tokenize(document, engine);
}

1
extensions/markdown-language-features/src/tableOfContentsProvider.ts
View File

@@ -17,6 +17,7 @@ export interface TocEntry {
export interface SkinnyTextDocument {
readonly uri: vscode.Uri;
readonly version: number;
readonly lineCount: number;
getText(): string;
lineAt(line: number): vscode.TextLine;

4
extensions/markdown-language-features/src/test/inMemoryDocument.ts
View File

@@ -10,7 +10,8 @@ export class InMemoryDocument implements vscode.TextDocument {
constructor(
public readonly uri: vscode.Uri,
private readonly _contents: string
private readonly _contents: string,
public readonly version = 1,
) {
this._lines = this._contents.split(/\n/g);
}
@@ -18,7 +19,6 @@ export class InMemoryDocument implements vscode.TextDocument {
isUntitled: boolean = false;
languageId: string = '';
version: number = 1;
isDirty: boolean = false;
isClosed: boolean = false;
eol: vscode.EndOfLine = vscode.EndOfLine.LF;

4
extensions/markdown-language-features/src/test/workspaceSymbolProvider.test.ts
View File

@@ -52,7 +52,7 @@ suite('markdown.WorkspaceSymbolProvider', () => {
const testFileName = vscode.Uri.file('test.md');
const workspaceFileProvider = new InMemoryWorkspaceMarkdownDocumentProvider([
new InMemoryDocument(testFileName, `# header1`)
new InMemoryDocument(testFileName, `# header1`, 1 /* version */)
]);
const provider = new MarkdownWorkspaceSymbolProvider(symbolProvider, workspaceFileProvider);
@@ -60,7 +60,7 @@ suite('markdown.WorkspaceSymbolProvider', () => {
assert.strictEqual((await provider.provideWorkspaceSymbols('')).length, 1);
// Update file
workspaceFileProvider.updateDocument(new InMemoryDocument(testFileName, `# new header\nabc\n## header2`));
workspaceFileProvider.updateDocument(new InMemoryDocument(testFileName, `# new header\nabc\n## header2`, 2 /* version */));
const newSymbols = await provider.provideWorkspaceSymbols('');
assert.strictEqual(newSymbols.length, 2);
assert.strictEqual(newSymbols[0].name, '# new header');