feat: displayAdditionalInfoInCompletions, disabled by default

fix: Speed up completions details resolving by vscode API (evaluate isGoodPositionForMethodCompletions once)

Author: zardoy

src/configurationType.ts

@@ -434,4 +434,11 @@ export type Configuration = {
      * @default []
      */
     'autoImport.alwaysIgnoreInImportAll': string[]
+    /**
+     * Enable to display additional information about source declaration in completion's documentation
+     * For now only displays function's body
+     * Requires symbol patching
+     * @default false
+     */
+    displayAdditionalInfoInCompletions: boolean
 }

src/vueVolarSupport.ts

@@ -18,6 +18,7 @@ export default () => {
 
     handler()
     watchExtensionSettings(['enableVueSupport'], handler)
+    vscode.extensions.onDidChange(handler)
 }
 
 const isConfigValueChanged = (id: string) => {

typescript/src/completionEntryDetails.ts

@@ -1,6 +1,6 @@
 import { oneOf } from '@zardoy/utils'
-import { isGoodPositionMethodCompletion } from './completions/isGoodPositionMethodCompletion'
 import { getParameterListParts } from './completions/snippetForFunctionCall'
+import { PrevCompletionsAdditionalData } from './completionsAtPosition'
 import { GetConfig } from './types'
 
 export default (
@@ -10,6 +10,7 @@ export default (
     position: number,
     sourceFile: ts.SourceFile,
     prior: ts.CompletionEntryDetails,
+    { enableMethodCompletion }: PrevCompletionsAdditionalData,
 ) => {
     if (
         c('enableMethodSnippets') &&
@@ -23,15 +24,15 @@ export default (
         )
     ) {
         // - 1 to look for possibly previous completing item
-        let goodPosition = isGoodPositionMethodCompletion(ts, fileName, sourceFile, position - 1, languageService, c)
         let rawPartsOverride: ts.SymbolDisplayPart[] | undefined
-        if (goodPosition && prior.kind === ts.ScriptElementKind.alias) {
-            goodPosition = prior.displayParts[5]?.text === 'method' || (prior.displayParts[4]?.kind === 'keyword' && prior.displayParts[4].text === 'function')
+        if (enableMethodCompletion && prior.kind === ts.ScriptElementKind.alias) {
+            enableMethodCompletion =
+                prior.displayParts[5]?.text === 'method' || (prior.displayParts[4]?.kind === 'keyword' && prior.displayParts[4].text === 'function')
             const { parts, gotMethodHit, hasOptionalParameters } = getParameterListParts(prior.displayParts)
             if (gotMethodHit) rawPartsOverride = hasOptionalParameters ? [...parts, { kind: '', text: ' ' }] : parts
         }
         const punctuationIndex = prior.displayParts.findIndex(({ kind, text }) => kind === 'punctuation' && text === ':')
-        if (goodPosition && punctuationIndex !== 1) {
+        if (enableMethodCompletion && punctuationIndex !== 1) {
             const isParsableMethod = prior.displayParts
                 // next is space
                 .slice(punctuationIndex + 2)

typescript/src/completions/addSourceDefinition.ts

@@ -0,0 +1,36 @@
+import { PrevCompletionMap } from '../completionsAtPosition'
+import { GetConfig } from '../types'
+import stringDedent from 'string-dedent'
+
+export default (entries: ts.CompletionEntry[], prevCompletionsMap: PrevCompletionMap, c: GetConfig): ts.CompletionEntry[] | undefined => {
+    if (!c('displayAdditionalInfoInCompletions')) return entries
+    return entries.map(entry => {
+        const symbol = entry['symbol'] as ts.Symbol | undefined
+        if (!symbol) return entry
+        const addNodeText = (node: ts.Node) => {
+            let text = node.getText().trim()
+            if (ts.isBlock(node)) text = text.slice(1, -1)
+            try {
+                text = stringDedent(text)
+            } catch (e) {
+                // ignore
+            }
+            prevCompletionsMap[entry.name] = {
+                documentationAppend: `\nFunction source:\n\`\`\`ts\n${text}\n\`\`\`\n`,
+            }
+        }
+        let node: ts.Node = symbol.valueDeclaration!
+        if (!node) return entry
+        if (ts.isVariableDeclaration(node)) node = node.initializer!
+        if (!node) return entry
+        if ((ts.isMethodDeclaration(node) || ts.isArrowFunction(node)) && node.body) {
+            const { body } = node
+            if (ts.isBlock(body) && body.statements.length === 1 && ts.isReturnStatement(body.statements[0]!)) {
+                addNodeText(body.statements[0])
+            } else {
+                addNodeText(body)
+            }
+        }
+        return entry
+    })
+}

typescript/src/completionsAtPosition.ts

@@ -23,8 +23,12 @@ import markOrRemoveGlobalCompletions from './completions/markOrRemoveGlobalLibCo
 import { oneOf } from '@zardoy/utils'
 import filterWIthIgnoreAutoImports from './completions/ignoreAutoImports'
 import escapeStringRegexp from 'escape-string-regexp'
+import addSourceDefinition from './completions/addSourceDefinition'
 
-export type PrevCompletionMap = Record<string, { originalName?: string; documentationOverride?: string | ts.SymbolDisplayPart[] }>
+export type PrevCompletionMap = Record<string, { originalName?: string; documentationOverride?: string | ts.SymbolDisplayPart[]; documentationAppend?: string }>
+export type PrevCompletionsAdditionalData = {
+    enableMethodCompletion: boolean
+}
 
 export const getCompletionsAtPosition = (
     fileName: string,
@@ -40,6 +44,7 @@ export const getCompletionsAtPosition = (
           completions: ts.CompletionInfo
           /** Let default getCompletionEntryDetails to know original name or let add documentation from here */
           prevCompletionsMap: PrevCompletionMap
+          prevCompletionsAdittionalData: PrevCompletionsAdditionalData
       }
     | undefined => {
     const prevCompletionsMap: PrevCompletionMap = {}
@@ -214,6 +219,8 @@ export const getCompletionsAtPosition = (
         }
     }
 
+    prior.entries = addSourceDefinition(prior.entries, prevCompletionsMap, c) ?? prior.entries
+
     if (c('improveJsxCompletions') && leftNode) prior.entries = improveJsxCompletions(prior.entries, leftNode, position, sourceFile, c('jsxCompletionsMap'))
 
     const processedEntries = new Set<ts.CompletionEntry>()
@@ -282,7 +289,8 @@ export const getCompletionsAtPosition = (
     }
 
     // prevent vscode-builtin wrong insertText with methods snippets enabled
-    if (!isGoodPositionBuiltinMethodCompletion(ts, sourceFile, position - 1, c)) {
+    const goodPositionForMethodCompletions = isGoodPositionBuiltinMethodCompletion(ts, sourceFile, position - 1, c)
+    if (!goodPositionForMethodCompletions) {
         prior.entries = prior.entries.map(item => {
             if (item.isSnippet) return item
             return { ...item, insertText: (item.insertText ?? item.name).replace(/\$/g, '\\$'), isSnippet: true }
@@ -302,6 +310,9 @@ export const getCompletionsAtPosition = (
     return {
         completions: prior,
         prevCompletionsMap,
+        prevCompletionsAdittionalData: {
+            enableMethodCompletion: goodPositionForMethodCompletions,
+        },
     }
 }
 

typescript/src/decorateProxy.ts

@@ -1,4 +1,4 @@
-import { getCompletionsAtPosition, PrevCompletionMap } from './completionsAtPosition'
+import { getCompletionsAtPosition, PrevCompletionMap, PrevCompletionsAdditionalData } from './completionsAtPosition'
 import { TriggerCharacterCommand } from './ipcTypes'
 import { getNavTreeItems } from './getPatchedNavTree'
 import decorateCodeActions from './codeActions/decorateProxy'
@@ -37,6 +37,7 @@ export const decorateLanguageService = (
     const proxy = getInitialProxy(languageService, existingProxy)
 
     let prevCompletionsMap: PrevCompletionMap
+    let prevCompletionsAdittionalData: PrevCompletionsAdditionalData
     // eslint-disable-next-line complexity
     proxy.getCompletionsAtPosition = (fileName, position, options, formatOptions) => {
         const updateConfigCommand = 'updateConfig'
@@ -66,14 +67,15 @@ export const decorateLanguageService = (
         const result = getCompletionsAtPosition(fileName, position, options, c, languageService, scriptSnapshot, formatOptions, { scriptKind })
         if (!result) return
         prevCompletionsMap = result.prevCompletionsMap
+        prevCompletionsAdittionalData = result.prevCompletionsAdittionalData
         return result.completions
     }
 
     proxy.getCompletionEntryDetails = (fileName, position, entryName, formatOptions, source, preferences, data) => {
         const program = languageService.getProgram()
         const sourceFile = program?.getSourceFile(fileName)
         if (!program || !sourceFile) return
-        const { documentationOverride } = prevCompletionsMap[entryName] ?? {}
+        const { documentationOverride, documentationAppend } = prevCompletionsMap[entryName] ?? {}
         if (documentationOverride) {
             return {
                 name: entryName,
@@ -92,7 +94,10 @@ export const decorateLanguageService = (
             data,
         )
         if (!prior) return
-        return completionEntryDetails(languageService, c, fileName, position, sourceFile, prior)
+        if (documentationAppend) {
+            prior.documentation = [...(prior.documentation ?? []), { kind: 'text', text: documentationAppend }]
+        }
+        return completionEntryDetails(languageService, c, fileName, position, sourceFile, prior, prevCompletionsAdittionalData)
     }
 
     decorateCodeActions(proxy, languageService, c)