feat(handy!): display import info in completion details for imported symbols. Disabled for now by default as requires symbol patch (setting: suggestions.displayImportedInfo).

Author: zardoy

src/configurationType.ts

@@ -114,6 +114,12 @@ export type Configuration = {
      * @default space
      */
     'suggestions.keywordsInsertText': 'none' | 'space'
+    /**
+     * Will be `format-short` by default in future as super useful!
+     * Requires symbol patch
+     * @default disable
+     */
+    'suggestions.displayImportedInfo': 'disable' | 'short-format' | 'long-format'
     // TODO! corrent watching!
     /**
      * Wether to enable snippets for array methods like `items.map(item => )`
@@ -446,10 +452,29 @@ export type Configuration = {
      * @default []
      */
     'autoImport.alwaysIgnoreInImportAll': string[]
+    /**
+     * @default {}
+     */
+    'autoImport.changeToNamespaceImport': {
+        [module: string]: {
+            /**
+             * @default module (key)
+             */
+            namespace?: string
+            /**
+             * @default false
+             */
+            useDefaultImport?: boolean
+            /**
+             * Set to `false` if module is acessible from global variable
+             * @default true */
+            addImport?: boolean
+        }
+    }
     /**
      * Enable to display additional information about source declaration in completion's documentation
      * For now only displays function's body
-     * Requires symbol patching
+     * Requires symbol patch
      * @default false
      */
     displayAdditionalInfoInCompletions: boolean

typescript/src/completions/displayImportedInfo.ts

@@ -0,0 +1,32 @@
+import { sharedCompletionContext } from './sharedContext'
+
+export default (entries: ts.CompletionEntry[]) => {
+    const { c, prevCompletionsMap } = sharedCompletionContext
+
+    const displayImportedInfo = c('suggestions.displayImportedInfo')
+    if (displayImportedInfo === 'disable') return
+
+    for (const entry of entries) {
+        const symbol = entry['symbol'] as ts.Symbol
+        if (!symbol) continue
+        const [node] = symbol.getDeclarations() ?? []
+        if (!node) continue
+        let importDeclaration: ts.ImportDeclaration | undefined
+        if (ts.isImportSpecifier(node) && ts.isNamedImports(node.parent) && ts.isImportDeclaration(node.parent.parent.parent)) {
+            importDeclaration = node.parent.parent.parent
+        } else if (ts.isImportClause(node) && ts.isImportDeclaration(node.parent)) {
+            importDeclaration = node.parent
+        } else if (ts.isNamespaceImport(node) && ts.isImportClause(node.parent) && ts.isImportDeclaration(node.parent.parent)) {
+            // todo-low(builtin) maybe reformat text
+            importDeclaration = node.parent.parent
+        }
+        if (importDeclaration) {
+            prevCompletionsMap[entry.name] ??= {}
+            let importPath = importDeclaration.moduleSpecifier.getText()
+            const symbolsLimit = 40
+            if (importPath.length > symbolsLimit) importPath = importPath.slice(0, symbolsLimit / 2) + '...' + importPath.slice(-symbolsLimit / 2)
+            const detailPrepend = displayImportedInfo === 'short-format' ? `(from ${importPath}) ` : `Imported from ${importPath}\n\n`
+            prevCompletionsMap[entry.name]!.detailPrepend = detailPrepend
+        }
+    }
+}

typescript/src/completionsAtPosition.ts

@@ -24,12 +24,31 @@ import { compact, oneOf } from '@zardoy/utils'
 import filterWIthIgnoreAutoImports from './completions/ignoreAutoImports'
 import escapeStringRegexp from 'escape-string-regexp'
 import addSourceDefinition from './completions/addSourceDefinition'
+import { sharedCompletionContext } from './completions/sharedContext'
+import displayImportedInfo from './completions/displayImportedInfo'
 
-export type PrevCompletionMap = Record<string, { originalName?: string; documentationOverride?: string | ts.SymbolDisplayPart[]; documentationAppend?: string }>
+export type PrevCompletionMap = Record<
+    string,
+    {
+        originalName?: string
+        /** use only if codeactions cant be returned (no source) */
+        documentationOverride?: string | ts.SymbolDisplayPart[]
+        detailPrepend?: string
+        documentationAppend?: string
+        // textChanges?: ts.TextChange[]
+    }
+>
 export type PrevCompletionsAdditionalData = {
     enableMethodCompletion: boolean
 }
 
+type GetCompletionAtPositionReturnType = {
+    completions: ts.CompletionInfo
+    /** Let default getCompletionEntryDetails to know original name or let add documentation from here */
+    prevCompletionsMap: PrevCompletionMap
+    prevCompletionsAdittionalData: PrevCompletionsAdditionalData
+}
+
 export const getCompletionsAtPosition = (
     fileName: string,
     position: number,
@@ -39,14 +58,7 @@ export const getCompletionsAtPosition = (
     scriptSnapshot: ts.IScriptSnapshot,
     formatOptions: ts.FormatCodeSettings | undefined,
     additionalData: { scriptKind: ts.ScriptKind; compilerOptions: ts.CompilerOptions },
-):
-    | {
-          completions: ts.CompletionInfo
-          /** Let default getCompletionEntryDetails to know original name or let add documentation from here */
-          prevCompletionsMap: PrevCompletionMap
-          prevCompletionsAdittionalData: PrevCompletionsAdditionalData
-      }
-    | undefined => {
+): GetCompletionAtPositionReturnType | undefined => {
     const prevCompletionsMap: PrevCompletionMap = {}
     const program = languageService.getProgram()
     const sourceFile = program?.getSourceFile(fileName)
@@ -55,6 +67,18 @@ export const getCompletionsAtPosition = (
     const exactNode = findChildContainingExactPosition(sourceFile, position)
     const isCheckedFile =
         !tsFull.isSourceFileJS(sourceFile as any) || !!tsFull.isCheckJsEnabledForFile(sourceFile as any, additionalData.compilerOptions as any)
+    Object.assign(sharedCompletionContext, {
+        position,
+        languageService,
+        sourceFile,
+        program,
+        isCheckedFile,
+        node: exactNode,
+        prevCompletionsMap,
+        c,
+        formatOptions: formatOptions || {},
+        preferences: options || {},
+    } satisfies typeof sharedCompletionContext)
     const unpatch = patchBuiltinMethods(c, languageService, isCheckedFile)
     const getPrior = () => {
         try {
@@ -233,6 +257,7 @@ export const getCompletionsAtPosition = (
     // #endregion
 
     prior.entries = addSourceDefinition(prior.entries, prevCompletionsMap, c) ?? prior.entries
+    displayImportedInfo(prior.entries)
 
     if (c('improveJsxCompletions') && leftNode) prior.entries = improveJsxCompletions(prior.entries, leftNode, position, sourceFile, c('jsxCompletionsMap'))