fix: correctly pass range of string completions from plugin (affects completions with space)

Author: zardoy

typescript/src/completions/additionalTypesSuggestions.ts

@@ -1,5 +1,8 @@
+import { buildStringCompletion } from '../utils'
+
 export default (entries: ts.CompletionEntry[], program: ts.Program, node: ts.Node) => {
     if (!ts.isStringLiteral(node)) return
+    const stringNode = node
     const typeChecker = program.getTypeChecker()
     if (ts.isLiteralTypeNode(node.parent)) {
         node = node.parent
@@ -17,11 +20,12 @@ export default (entries: ts.CompletionEntry[], program: ts.Program, node: ts.Nod
             const type = typeChecker.getTypeFromTypeNode(node.parent.typeArguments[0]!)
             type.getProperties().forEach(({ name }) => {
                 if (previousValues.includes(name)) return
-                entries.push({
-                    name,
-                    kind: ts.ScriptElementKind.string,
-                    sortText: '',
-                })
+                entries.push(
+                    buildStringCompletion(stringNode, {
+                        name,
+                        sortText: '',
+                    }),
+                )
             })
             return
         }
@@ -34,10 +38,10 @@ export default (entries: ts.CompletionEntry[], program: ts.Program, node: ts.Nod
     const { types } = (type as any) ?? {}
     const values: string[] = types.map(({ value }) => (typeof value === 'string' ? value : undefined)).filter(Boolean)
     return values.map(
-        (value): ts.CompletionEntry => ({
-            name: value,
-            kind: ts.ScriptElementKind.string,
-            sortText: '',
-        }),
+        (value): ts.CompletionEntry =>
+            buildStringCompletion(stringNode, {
+                name: value,
+                sortText: '',
+            }),
     )
 }

typescript/src/inKeywordCompletions.ts renamed to typescript/src/completions/inKeywordCompletions.ts

@@ -1,10 +1,13 @@
-export default (position: number, node: ts.Node | undefined, sourceFile: ts.SourceFile, program: ts.Program, languageService: ts.LanguageService) => {
+import { sharedCompletionContext } from './sharedContext'
+import { buildStringCompletion } from '../utils'
+
+export default () => {
+    const { node, program } = sharedCompletionContext
     if (!node) return
     function isBinaryExpression(node: ts.Node): node is ts.BinaryExpression {
         return node.kind === ts.SyntaxKind.BinaryExpression
     }
     const typeChecker = program.getTypeChecker()
-    // TODO info diagnostic if used that doesn't exist
     if (
         ts.isStringLiteralLike(node) &&
         isBinaryExpression(node.parent) &&
@@ -48,14 +51,15 @@ export default (position: number, node: ts.Node | undefined, sourceFile: ts.Sour
             .map(([originaName, { insertText, usingDisplayIndexes, documentations }], i) => {
                 const name = types.length > 1 && usingDisplayIndexes.length === 1 ? `☆${originaName}` : originaName
                 docPerCompletion[name] = documentations.join('\n\n')
-                return {
+                return buildStringCompletion(node, {
                     // ⚀ ⚁ ⚂ ⚃ ⚄ ⚅
                     name,
-                    kind: ts.ScriptElementKind.string,
+                    labelDetails: {
+                        description: usingDisplayIndexes.join(', '),
+                    },
                     insertText,
-                    sourceDisplay: [{ kind: 'text', text: usingDisplayIndexes.join(', ') }],
                     sortText: `${maxUsingDisplayIndex - usingDisplayIndexes.length}_${i}`,
-                }
+                })
             })
             .sort((a, b) => a.sortText.localeCompare(b.sortText))
         return {

typescript/src/completions/indexSignatureAccess.ts

@@ -1,10 +1,8 @@
-export default (
-    position: number,
-    node: ts.Node | undefined,
-    scriptSnapshot: ts.IScriptSnapshot,
-    sourceFile: ts.SourceFile,
-    program: ts.Program,
-): ts.CompletionEntry[] => {
+import { buildStringCompletion } from '../utils'
+import { sharedCompletionContext } from './sharedContext'
+
+export default (): ts.CompletionEntry[] => {
+    const { node, program } = sharedCompletionContext
     if (!node || !ts.isStringLiteralLike(node)) return []
     const isConditionalExpression = ts.isConditionalExpression(node.parent)
     // optimize?
@@ -24,11 +22,10 @@ export default (
         }
     }
     return (type.getProperties?.() ?? []).map((prop, i) => {
-        return {
-            kind: ts.ScriptElementKind.string,
+        return buildStringCompletion(node, {
             name: prop.name,
             // derang completions used on other side
             sortText: prop.name === usedProp ? '9999' : '',
-        }
+        })
     })
 }

typescript/src/completions/stringTemplateType.ts

@@ -1,10 +1,12 @@
 import { compact } from '@zardoy/utils'
 import { sharedCompletionContext } from './sharedContext'
+import { buildStringCompletion } from '../utils'
 
 export default (): ts.CompletionEntry[] | void => {
     const { program } = sharedCompletionContext
     let { node } = sharedCompletionContext
     if (!node || !ts.isStringLiteralLike(node)) return
+    const stringNode = node
     const checker = program.getTypeChecker()!
     let type: ts.Type
     let objType: ts.Type | undefined
@@ -31,13 +33,12 @@ export default (): ts.CompletionEntry[] | void => {
                 } = type as ts.TemplateLiteralType
                 const texts = [head!, ...spans.flatMap(span => (span === '' ? [''] : ['', span]))]
                 let tabStop = 1
-                return {
-                    kind: ts.ScriptElementKind.string,
+                return buildStringCompletion(stringNode, {
                     name: texts.map(text => (text === '' ? '|' : text)).join(''),
                     sortText: '07',
                     insertText: texts.map(text => (text === '' ? `$${tabStop++}` : text.replace(/\$/g, '\\$'))).join(''),
                     isSnippet: true,
-                }
+                })
             }),
         )
     }

typescript/src/completionsAtPosition.ts

@@ -1,5 +1,5 @@
 import _ from 'lodash'
-import inKeywordCompletions from './inKeywordCompletions'
+import inKeywordCompletions from './completions/inKeywordCompletions'
 // import * as emmet from '@vscode/emmet-helper'
 import isInBannedPosition from './completions/isInBannedPosition'
 import { GetConfig } from './types'
@@ -138,7 +138,7 @@ export const getCompletionsAtPosition = (
     if (node && !hasSuggestions && ensurePrior() && prior) {
         prior.entries = additionalTypesSuggestions(prior.entries, program, node) ?? prior.entries
     }
-    const addSignatureAccessCompletions = hasSuggestions ? [] : indexSignatureAccessCompletions(position, node, scriptSnapshot, sourceFile, program)
+    const addSignatureAccessCompletions = hasSuggestions ? [] : indexSignatureAccessCompletions()
     if (addSignatureAccessCompletions.length && ensurePrior() && prior) {
         prior.entries = [...prior.entries, ...addSignatureAccessCompletions]
     }
@@ -235,7 +235,7 @@ export const getCompletionsAtPosition = (
     // 90%
     prior.entries = adjustAutoImports(prior.entries)
 
-    const inKeywordCompletionsResult = inKeywordCompletions(position, node, sourceFile, program, languageService)
+    const inKeywordCompletionsResult = inKeywordCompletions()
     if (inKeywordCompletionsResult) {
         prior.entries.push(...inKeywordCompletionsResult.completions)
         Object.assign(

typescript/src/utils.ts

@@ -1,4 +1,4 @@
-import { SetOptional } from 'type-fest'
+import { Except, SetOptional } from 'type-fest'
 import * as semver from 'semver'
 
 export function findChildContainingPosition(typescript: typeof ts, sourceFile: ts.SourceFile, position: number): ts.Node | undefined {
@@ -117,6 +117,15 @@ export const boostExistingSuggestions = (entries: ts.CompletionEntry[], predicat
     })
 }
 
+export const buildStringCompletion = (node: ts.StringLiteralLike, completion: Except<ts.CompletionEntry, 'kind'>): ts.CompletionEntry => {
+    const start = node.pos + node.getLeadingTriviaWidth() + 1
+    return {
+        ...completion,
+        kind: ts.ScriptElementKind.string,
+        replacementSpan: ts.createTextSpanFromBounds(start, node.end - 1),
+    }
+}
+
 // semver: can't use compare as it incorrectly works with build postfix
 export const isTs5 = () => semver.major(ts.version) >= 5