feat: New completions experience! Display default string completion at object literal (@default jsdoc support)

Author: zardoy

typescript/src/completions/defaultHelpers.ts

@@ -0,0 +1,24 @@
+import { approveCast } from '../utils'
+
+export default (entries: ts.CompletionEntry[], node: ts.Node, languageService: ts.LanguageService): ts.CompletionEntry[] | void => {
+    if (entries.length && node) {
+        if (ts.isStringLiteralLike(node) && approveCast(node.parent, ts.isPropertyAssignment) && ts.isObjectLiteralExpression(node.parent.parent)) {
+            const typeChecker = languageService.getProgram()!.getTypeChecker()!
+            const type = typeChecker.getContextualType(node.parent.parent)
+            if (type) {
+                const properties = type.getProperties()
+                const propName = node.parent.name.getText()
+                const completingPropName = properties.find(({ name }) => name === propName)
+                const defaultValue = completingPropName?.getJsDocTags().find(({ name, text }) => name === 'default' && text?.length)?.text?.[0]?.text
+                if (defaultValue) {
+                    const entryIndex = entries.findIndex(({ name, kind }) => name === defaultValue && kind === ts.ScriptElementKind.string)
+                    if (entryIndex === -1) return
+                    const entry = entries[entryIndex]!
+                    const newEntries = [...entries]
+                    newEntries.splice(entryIndex, 1, { ...entry, sortText: `z${entry.sortText}`, sourceDisplay: [{ kind: 'text', text: 'Default' }] })
+                    return newEntries
+                }
+            }
+        }
+    }
+}

typescript/src/completionsAtPosition.ts

@@ -10,13 +10,13 @@ import { isGoodPositionBuiltinMethodCompletion } from './completions/isGoodPosit
 import improveJsxCompletions from './completions/jsxAttributes'
 import arrayMethods from './completions/arrayMethods'
 import prepareTextForEmmet from './specialCommands/prepareTextForEmmet'
-import objectLiteralHelpers from './completions/objectLiteralHelpers'
 import switchCaseExcludeCovered from './completions/switchCaseExcludeCovered'
 import additionalTypesSuggestions from './completions/additionalTypesSuggestions'
 import boostKeywordSuggestions from './completions/boostKeywordSuggestions'
 import boostTextSuggestions from './completions/boostNameSuggestions'
 import keywordsSpace from './completions/keywordsSpace'
 import jsdocDefault from './completions/jsdocDefault'
+import defaultHelpers from './completions/defaultHelpers'
 
 export type PrevCompletionMap = Record<string, { originalName?: string; documentationOverride?: string | ts.SymbolDisplayPart[] }>
 
@@ -142,14 +142,15 @@ export const getCompletionsAtPosition = (
         //         ({ name }) => name === 'toExponential',
         //         ({ name }) => name === 'toString',
         //     )
-        const indexToPatch = prior.entries.findIndex(({ name }) => name === 'toString')
+        const indexToPatch = prior.entries.findIndex(({ name, kind }) => name === 'toString' && kind !== ts.ScriptElementKind.warning)
         if (indexToPatch !== -1) {
             prior.entries[indexToPatch]!.insertText = `${prior.entries[indexToPatch]!.insertText ?? prior.entries[indexToPatch]!.name}()`
             prior.entries[indexToPatch]!.kind = ts.ScriptElementKind.constElement
             // prior.entries[indexToPatch]!.isSnippet = true
         }
     }
 
+    if (node) prior.entries = defaultHelpers(prior.entries, node, languageService) ?? prior.entries
     const banAutoImportPackages = c('suggestions.banAutoImportPackages')
     if (banAutoImportPackages?.length)
         prior.entries = prior.entries.filter(entry => {

typescript/src/utils.ts

@@ -169,3 +169,9 @@ const wordRangeAtPos = (text: string, position: number) => {
     }
     return text.slice(startPos + 1, endPos)
 }
+
+export function approveCast<TOut extends TIn, TIn = any>(value: TIn | undefined, test: (value: TIn) => value is TOut): value is TOut
+export function approveCast<T>(value: T, test: (value: T) => boolean): T | undefined
+export function approveCast<T>(value: T, test: (value: T) => boolean): T | undefined {
+    return value !== undefined && test(value) ? value : undefined
+}