feat: introducing new completions for @default JSDoc !!!

also tried to implement go to type & auto-editing for default, but dk how :

Author: zardoy

src/onCompletionAccepted.ts

@@ -16,8 +16,9 @@ export default (tsApi: { onCompletionAccepted }) => {
         }
 
         const { insertText, documentation = '', kind } = item
-        if (kind === vscode.CompletionItemKind.Keyword && insertText === 'return ') {
-            justAcceptedReturnKeywordSuggestion = true
+        if (kind === vscode.CompletionItemKind.Keyword) {
+            if (insertText === 'return ') justAcceptedReturnKeywordSuggestion = true
+            else if (insertText === 'default ') void vscode.commands.executeCommand('editor.action.triggerSuggest')
         }
 
         const enableMethodSnippets = vscode.workspace.getConfiguration(process.env.IDS_PREFIX, item.document).get('enableMethodSnippets')

typescript/src/completions/jsdocDefault.ts

@@ -0,0 +1,54 @@
+import { findChildContainingPositionIncludingStartTrivia } from '../utils'
+
+export const getJsdocDefaultTypes = (position: number, sourceFile: ts.SourceFile, languageService: ts.LanguageService) => {
+    const fileText = sourceFile.getFullText().slice(0, position)
+    const textBeforeWord = fileText.slice(0, /[-\w\d]*$/i.exec(fileText)!.index)
+    if (!textBeforeWord.endsWith('@default ')) return
+    const comment = languageService.getSpanOfEnclosingComment(sourceFile.fileName, position, false)
+    if (!comment) return
+    let node = findChildContainingPositionIncludingStartTrivia(ts, sourceFile, position)
+    if (!node) return
+    if (ts.isVariableDeclarationList(node)) node = node.declarations[0]
+    if (!node) return
+    const typeChecker = languageService.getProgram()!.getTypeChecker()!
+    try {
+        const type = typeChecker.getTypeAtLocation(node)
+        if (!type.isUnion()) return
+        const suggestions: [name: string, type: ts.Type, isLiteral: boolean][] = []
+        for (const nextType of type.types) {
+            const addSuggestions = (isLiteral: boolean, ...addSuggestions: string[]) => {
+                suggestions.push(...addSuggestions.map(suggestion => [suggestion, nextType, isLiteral] as [string, ts.Type, boolean]))
+            }
+            if (nextType.isLiteral()) addSuggestions(true, nextType.value.toString())
+            else if (nextType.flags & ts.TypeFlags.BooleanLiteral) addSuggestions(true, nextType['intrinsicName'])
+            else if (nextType.flags & ts.TypeFlags.Boolean) addSuggestions(false, 'true', 'false')
+            else if (nextType.flags & ts.TypeFlags.Undefined) addSuggestions(false, 'undefined')
+            else if (nextType.flags & ts.TypeFlags.Null) addSuggestions(false, 'null')
+        }
+        return suggestions
+    } catch (err) {
+        return
+    }
+
+    return
+}
+
+export default (
+    entries: ts.CompletionEntry[],
+    position: number,
+    sourceFile: ts.SourceFile,
+    languageService: ts.LanguageService,
+): ts.CompletionEntry[] | undefined => {
+    const suggestions = getJsdocDefaultTypes(position, sourceFile, languageService)
+    if (!suggestions) return
+    return [
+        ...[...new Set(suggestions)].map(
+            ([s]): ts.CompletionEntry => ({
+                name: s,
+                sortText: '07',
+                kind: ts.ScriptElementKind.string,
+            }),
+        ),
+        ...entries,
+    ] as ts.CompletionEntry[]
+}

typescript/src/completionsAtPosition.ts

@@ -16,6 +16,7 @@ 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'
 
 export type PrevCompletionMap = Record<string, { originalName?: string; documentationOverride?: string | ts.SymbolDisplayPart[] }>
 
@@ -166,11 +167,12 @@ export const getCompletionsAtPosition = (
     if (leftNode && c('switchExcludeCoveredCases')) prior.entries = switchCaseExcludeCovered(prior.entries, position, sourceFile, leftNode) ?? prior.entries
 
     prior.entries = arrayMethods(prior.entries, position, sourceFile, c) ?? prior.entries
+    prior.entries = jsdocDefault(prior.entries, position, sourceFile, languageService) ?? prior.entries
 
     if (c('improveJsxCompletions') && leftNode) prior.entries = improveJsxCompletions(prior.entries, leftNode, position, sourceFile, c('jsxCompletionsMap'))
 
     for (const rule of c('replaceSuggestions')) {
-        let foundIndex: number
+        let foundIndex!: number
         const suggestion = prior.entries.find(({ name, kind }, index) => {
             if (rule.suggestion !== name) return false
             if (rule.filter?.kind && kind !== rule.filter.kind) return false
@@ -179,9 +181,9 @@ export const getCompletionsAtPosition = (
         })
         if (!suggestion) continue
 
-        if (rule.delete) prior.entries.splice(foundIndex!, 1)
+        if (rule.delete) prior.entries.splice(foundIndex, 1)
 
-        if (rule.duplicateOriginal) prior.entries.splice(rule.duplicateOriginal === 'above' ? foundIndex! : foundIndex! + 1, 0, { ...suggestion })
+        if (rule.duplicateOriginal) prior.entries.splice(rule.duplicateOriginal === 'above' ? foundIndex : foundIndex + 1, 0, { ...suggestion })
 
         Object.assign(suggestion, rule.patch ?? {})
         if (rule.patch?.insertText) suggestion.isSnippet = true

typescript/src/utils.ts

@@ -11,6 +11,17 @@ export function findChildContainingPosition(typescript: typeof ts, sourceFile: t
     return find(sourceFile)
 }
 
+export function findChildContainingPositionIncludingStartTrivia(typescript: typeof ts, sourceFile: ts.SourceFile, position: number): ts.Node | undefined {
+    function find(node: ts.Node): ts.Node | undefined {
+        if (position >= node.getStart() - (node.getLeadingTriviaWidth() ?? 0) && position < node.getEnd()) {
+            return typescript.forEachChild(node, find) || node
+        }
+
+        return
+    }
+    return find(sourceFile)
+}
+
 export function findChildContainingExactPosition(sourceFile: ts.SourceFile, position: number): ts.Node | undefined {
     function find(node: ts.Node): ts.Node | undefined {
         if (position >= node.getStart() && position <= node.getEnd()) {
@@ -143,3 +154,18 @@ export function addObjectMethodResultInterceptors<T extends Record<string, any>>
         }
     }
 }
+
+const wordRangeAtPos = (text: string, position: number) => {
+    const isGood = (pos: number) => {
+        return /[-\w\d]/i.test(text.at(pos) ?? '')
+    }
+    let startPos = position
+    while (isGood(startPos)) {
+        startPos--
+    }
+    let endPos = position
+    while (isGood(endPos)) {
+        endPos++
+    }
+    return text.slice(startPos + 1, endPos)
+}