Microsoft/vscode
1
0
Fork 0
mirror of https://github.com/microsoft/vscode.git synced 2026-04-23 10:08:49 +01:00
Code Issues Packages Projects Releases Wiki Activity

Improve markdown references

Browse Source 
For #146277

- Find all references on links
- Better support for links without a file extension
This commit is contained in:
Matt Bierner
2022-03-29 21:44:02 -07:00
parent 26020f8032
commit ebd490f28e
6 changed files with 308 additions and 66 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
extensions/markdown-language-features/src/test/inMemoryWorkspace.ts
View File

@@ -13,14 +13,18 @@ export class InMemoryWorkspaceMarkdownDocuments implements MdWorkspaceContents {
constructor(documents: SkinnyTextDocument[]) {
for (const doc of documents) {
this._documents.set(doc.uri.toString(), doc);
this._documents.set(this.getKey(doc.uri), doc);
}
}
async getAllMarkdownDocuments() {
public async getAllMarkdownDocuments() {
return Array.from(this._documents.values());
}
public async getMarkdownDocument(resource: vscode.Uri): Promise<SkinnyTextDocument | undefined> {
return this._documents.get(this.getKey(resource));
}
private readonly _onDidChangeMarkdownDocumentEmitter = new vscode.EventEmitter<SkinnyTextDocument>();
public onDidChangeMarkdownDocument = this._onDidChangeMarkdownDocumentEmitter.event;
@@ -31,19 +35,23 @@ export class InMemoryWorkspaceMarkdownDocuments implements MdWorkspaceContents {
public onDidDeleteMarkdownDocument = this._onDidDeleteMarkdownDocumentEmitter.event;
public updateDocument(document: SkinnyTextDocument) {
this._documents.set(document.uri.toString(), document);
this._documents.set(this.getKey(document.uri), document);
this._onDidChangeMarkdownDocumentEmitter.fire(document);
}
public createDocument(document: SkinnyTextDocument) {
assert.ok(!this._documents.has(document.uri.toString()));
assert.ok(!this._documents.has(this.getKey(document.uri)));
this._documents.set(document.uri.toString(), document);
this._documents.set(this.getKey(document.uri), document);
this._onDidCreateMarkdownDocumentEmitter.fire(document);
}
public deleteDocument(resource: vscode.Uri) {
this._documents.delete(resource.toString());
this._documents.delete(this.getKey(resource));
this._onDidDeleteMarkdownDocumentEmitter.fire(resource);
}
private getKey(resource: vscode.Uri): string {
return resource.fsPath;
}
}

146
extensions/markdown-language-features/src/test/references.test.ts
View File

@@ -22,7 +22,7 @@ function getReferences(doc: InMemoryDocument, pos: vscode.Position, workspaceCon
return provider.provideReferences(doc, pos, { includeDeclaration: true }, noopToken);
}
suite('markdown header references', () => {
suite('markdown references', () => {
test('Should not return references when not on header', async () => {
const doc = new InMemoryDocument(workspaceFile('doc.md'), joinLines(
`# abc`,
@@ -41,7 +41,7 @@ suite('markdown header references', () => {
}
});
test('Should find simple references within same file', async () => {
test('Should find references from header within same file', async () => {
const doc = new InMemoryDocument(workspaceFile('doc.md'), joinLines(
`# abc`,
``,
@@ -54,7 +54,7 @@ suite('markdown header references', () => {
assert.deepStrictEqual(refs!.length, 3);
{
const ref = refs![0]; // Header own ref
const ref = refs![0]; // Header definition
assert.deepStrictEqual(ref.range.start.line, 0);
}
{
@@ -67,7 +67,7 @@ suite('markdown header references', () => {
}
});
test('Should find simple references across files', async () => {
test('Should find references from header across files', async () => {
const docUri = workspaceFile('doc.md');
const other1Uri = workspaceFile('sub', 'other.md');
const other2Uri = workspaceFile('other2.md');
@@ -94,7 +94,7 @@ suite('markdown header references', () => {
assert.deepStrictEqual(refs!.length, 4);
{
const ref = refs![0]; // Header own ref
const ref = refs![0]; // Header definition
assert.deepStrictEqual(ref.uri.toString(), docUri.toString());
assert.deepStrictEqual(ref.range.start.line, 0);
}
@@ -114,4 +114,140 @@ suite('markdown header references', () => {
assert.deepStrictEqual(ref.range.start.line, 2);
}
});
test('Should find references from header to link definitions ', async () => {
const doc = new InMemoryDocument(workspaceFile('doc.md'), joinLines(
`# abc`,
``,
`[bla]: #abc`
));
const refs = await getReferences(doc, new vscode.Position(0, 3), new InMemoryWorkspaceMarkdownDocuments([doc]));
assert.deepStrictEqual(refs!.length, 2);
{
const ref = refs![0]; // Header definition
assert.deepStrictEqual(ref.range.start.line, 0);
}
{
const ref = refs![1];
assert.deepStrictEqual(ref.range.start.line, 2);
}
});
test('Should find references from link within same file', async () => {
const doc = new InMemoryDocument(workspaceFile('doc.md'), joinLines(
`# abc`,
``,
`[link 1](#abc)`,
`[not link](#noabc)`,
`[link 2](#abc)`,
));
const refs = await getReferences(doc, new vscode.Position(2, 10), new InMemoryWorkspaceMarkdownDocuments([doc]));
assert.deepStrictEqual(refs!.length, 3);
{
const ref = refs![0]; // Header definition
assert.deepStrictEqual(ref.range.start.line, 0);
}
{
const ref = refs![1];
assert.deepStrictEqual(ref.range.start.line, 2);
}
{
const ref = refs![2];
assert.deepStrictEqual(ref.range.start.line, 4);
}
});
test('Should find references from link across files', async () => {
const docUri = workspaceFile('doc.md');
const other1Uri = workspaceFile('sub', 'other.md');
const other2Uri = workspaceFile('other2.md');
const doc = new InMemoryDocument(docUri, joinLines(
`# abc`,
``,
`[link 1](#abc)`,
));
const refs = await getReferences(doc, new vscode.Position(2, 10), new InMemoryWorkspaceMarkdownDocuments([
doc,
new InMemoryDocument(other1Uri, joinLines(
`[not link](#abc)`,
`[not link](/doc.md#abz)`,
`[with ext](/doc.md#abc)`,
`[without ext](/doc#abc)`,
)),
new InMemoryDocument(other2Uri, joinLines(
`[not link](#abc)`,
`[not link](./doc.md#abz)`,
`[link](./doc.md#abc)`,
))
]));
assert.deepStrictEqual(refs!.length, 5);
{
const ref = refs![0]; // Header definition
assert.deepStrictEqual(ref.uri.toString(), docUri.toString());
assert.deepStrictEqual(ref.range.start.line, 0);
}
{
const ref = refs![1]; // Within file
assert.deepStrictEqual(ref.uri.toString(), docUri.toString());
assert.deepStrictEqual(ref.range.start.line, 2);
}
{
const ref = refs![2]; // Other with ext
assert.deepStrictEqual(ref.uri.toString(), other1Uri.toString());
assert.deepStrictEqual(ref.range.start.line, 2);
}
{
const ref = refs![3]; // Other without ext
assert.deepStrictEqual(ref.uri.toString(), other1Uri.toString());
assert.deepStrictEqual(ref.range.start.line, 3);
}
{
const ref = refs![4]; // Other2
assert.deepStrictEqual(ref.uri.toString(), other2Uri.toString());
assert.deepStrictEqual(ref.range.start.line, 2);
}
});
test('Should find references from link across files when triggered on link without file extension ', async () => {
const docUri = workspaceFile('doc.md');
const other1Uri = workspaceFile('sub', 'other.md');
const doc = new InMemoryDocument(docUri, joinLines(
`[with ext](./sub/other#header)`,
`[without ext](./sub/other.md#header)`,
));
const refs = await getReferences(doc, new vscode.Position(0, 15), new InMemoryWorkspaceMarkdownDocuments([
doc,
new InMemoryDocument(other1Uri, joinLines(
`pre`,
`# header`,
`post`,
)),
]));
assert.deepStrictEqual(refs!.length, 3);
{
const ref = refs![0]; // Header definition
assert.deepStrictEqual(ref.uri.toString(), other1Uri.toString());
assert.deepStrictEqual(ref.range.start.line, 1);
}
{
const ref = refs![1];
assert.deepStrictEqual(ref.uri.toString(), docUri.toString());
assert.deepStrictEqual(ref.range.start.line, 0);
}
{
const ref = refs![2];
assert.deepStrictEqual(ref.uri.toString(), docUri.toString());
assert.deepStrictEqual(ref.range.start.line, 1);
}
});
});