Microsoft/vscode
1
0
Fork 0
mirror of https://github.com/microsoft/vscode.git synced 2026-04-19 16:18:58 +01:00
Code Issues Packages Projects Releases Wiki Activity

Add support for rendering @linkcode jsdoc tags as code

Browse Source
This commit is contained in:
Matt Bierner
2021-08-03 16:37:07 -07:00
parent 5bc143160c
commit e4eaed4bf5
4 changed files with 200 additions and 150 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
extensions/typescript-language-features/src/test/unit/previewer.test.ts
View File

@@ -5,8 +5,9 @@
import * as assert from 'assert';
import 'mocha';
import { SymbolDisplayPart } from 'typescript/lib/protocol';
import { Uri } from 'vscode';
import { IFilePathToResourceConverter, markdownDocumentation, tagsMarkdownPreview } from '../../utils/previewer';
import { IFilePathToResourceConverter, markdownDocumentation, plainWithLinks, tagsMarkdownPreview } from '../../utils/previewer';
const noopToResource: IFilePathToResourceConverter = {
toResource: (path) => Uri.file(path)
@@ -85,5 +86,46 @@ suite('typescript.previewer', () => {
], noopToResource),
'*@param* `parámetroConDiacríticos` — this will not');
});
test('Should render @linkcode symbol name as code', async () => {
assert.strictEqual(
plainWithLinks([
{ "text": "a ", "kind": "text" },
{ "text": "{@linkcode ", "kind": "link" },
{
"text": "dog",
"kind": "linkName",
"target": {
"file": "/path/file.ts",
"start": { "line": 7, "offset": 5 },
"end": { "line": 7, "offset": 13 }
}
} as SymbolDisplayPart,
{ "text": "}", "kind": "link" },
{ "text": " b", "kind": "text" }
], noopToResource),
'a [`dog`](file:///path/file.ts#L7%2C5) b');
});
test('Should render @linkcode text as code', async () => {
assert.strictEqual(
plainWithLinks([
{ "text": "a ", "kind": "text" },
{ "text": "{@linkcode ", "kind": "link" },
{
"text": "dog",
"kind": "linkName",
"target": {
"file": "/path/file.ts",
"start": { "line": 7, "offset": 5 },
"end": { "line": 7, "offset": 13 }
}
} as SymbolDisplayPart,
{ "text": "husky", "kind": "linkText" },
{ "text": "}", "kind": "link" },
{ "text": " b", "kind": "text" }
], noopToResource),
'a [`husky`](file:///path/file.ts#L7%2C5) b');
});
});

20
extensions/typescript-language-features/src/utils/previewer.ts
View File

@@ -127,36 +127,40 @@ function convertLinkTags(
const out: string[] = [];
let currentLink: { name?: string, target?: Proto.FileSpan, text?: string } | undefined;
let currentLink: { name?: string, target?: Proto.FileSpan, text?: string, readonly linkcode: boolean } | undefined;
for (const part of parts) {
switch (part.kind) {
case 'link':
if (currentLink) {
const text = currentLink.text ?? currentLink.name;
if (currentLink.target) {
const link = filePathConverter.toResource(currentLink.target.file)
.with({
fragment: `L${currentLink.target.start.line},${currentLink.target.start.offset}`
});
out.push(`[${text}](${link.toString()})`);
const linkText = currentLink.text ? currentLink.text : escapeMarkdownSyntaxTokensForCode(currentLink.name ?? '');
out.push(`[${currentLink.linkcode ? '`' + linkText + '`' : linkText}](${link.toString()})`);
} else {
const text = currentLink.text ?? currentLink.name;
if (text) {
if (/^https?:/.test(text)) {
const parts = text.split(' ');
if (parts.length === 1) {
out.push(parts[0]);
} else if (parts.length > 1) {
out.push(`[${parts.slice(1).join(' ')}](${parts[0]})`);
const linkText = escapeMarkdownSyntaxTokensForCode(parts.slice(1).join(' '));
out.push(`[${currentLink.linkcode ? '`' + linkText + '`' : linkText}](${parts[0]})`);
}
} else {
out.push(text);
out.push(escapeMarkdownSyntaxTokensForCode(text));
}
}
}
currentLink = undefined;
} else {
currentLink = {};
currentLink = {
linkcode: part.text === '{@linkcode '
};
}
break;
@@ -217,3 +221,7 @@ export function addMarkdownDocumentation(
}
return out;
}
function escapeMarkdownSyntaxTokensForCode(text: string): string {
return text.replace(/`/g, '\\$&');
}