maxmustermann/vscode
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Use MarkedString for js completion and sig help

Browse source
This commit is contained in:
Matt Bierner 2017-09-11 11:03:28 -07:00
parent 48bfb73ae2
commit 1d992b11f7
3 changed files with 14 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
extensions/typescript/src/features/completionItemProvider.ts
View file

@ -251,7 +251,7 @@ export default class TypeScriptCompletionItemProvider implements CompletionItemP
const detail = details[0];
item.detail = Previewer.plain(detail.displayParts);
item.documentation = Previewer.plainDocumentation(detail.documentation, detail.tags);
item.documentation = Previewer.markdownDocumentation(detail.documentation, detail.tags);
if (detail && this.config.useCodeSnippetsOnMethodSuggest && (item.kind === CompletionItemKind.Function || item.kind === CompletionItemKind.Method)) {
return this.isValidFunctionCompletionContext(filepath, item.position).then(shouldCompleteFunction => {

28
extensions/typescript/src/features/previewer.ts
View file

@ -4,6 +4,7 @@
*--------------------------------------------------------------------------------------------*/
import * as Proto from '../protocol';
import { MarkdownString } from 'vscode';
export function plain(parts: Proto.SymbolDisplayPart[]): string {
if (!parts) {
@ -24,20 +25,15 @@ export function tagsMarkdownPreview(tags: Proto.JSDocTagInfo[]): string {
.join(' \n\n');
}
function tagsPlainPreview(tags: Proto.JSDocTagInfo[]): string {
return (tags || [])
.map(tag => {
const label = `@${tag.name}`;
if (!tag.text) {
return label;
}
return label + (tag.text.match(/\r\n|\n/g) ? '\n' + tag.text : ` — ${tag.text}`);
})
.join('\n\ngit');
}
export function plainDocumentation(documentation: Proto.SymbolDisplayPart[], tags: Proto.JSDocTagInfo[]): string {
const processedDocumentation = plain(documentation).replace(/\n([ \t]*\n)?/gm, (x) => x.length >= 2 ? '\n\n' : ' ');
const parts = [processedDocumentation, tagsPlainPreview(tags)];
return parts.filter(x => x).join('\n\n');
export function markdownDocumentation(
documentation: Proto.SymbolDisplayPart[],
tags: Proto.JSDocTagInfo[]
): MarkdownString {
const out = new MarkdownString();
out.appendMarkdown(plain(documentation));
const tagsPreview = tagsMarkdownPreview(tags);
if (tagsPreview) {
out.appendMarkdown('\n\n' + tagsPreview);
}
return out;
}

2
extensions/typescript/src/features/signatureHelpProvider.ts
View file

@ -59,7 +59,7 @@ export default class TypeScriptSignatureHelpProvider implements SignatureHelpPro
}
});
signature.label += Previewer.plain(item.suffixDisplayParts);
signature.documentation = Previewer.plainDocumentation(item.documentation, item.tags);
signature.documentation = Previewer.markdownDocumentation(item.documentation, item.tags);
result.signatures.push(signature);
});