feat(suggestions): Locality bonus! (isabled by default*, SUPER recommended, enable with suggestions.localityBonus)

fixes #46

Author: zardoy

README.MD

@@ -67,6 +67,17 @@ const usersList = []
 usersList.map // -> usersList.map((user) => )
 ```
 
+### Locality Bonus
+
+(*disabled by default*, SUPER recommended, enable with `suggestions.localityBonus`)
+
+Suggestions closer to cursor will appear higher, useful for local variables (eg callback parameters), requires TS >=5.0
+
+Why not enable built-in *Locality Bonus* setting:
+
+- Sometimes it just doesn't work
+- In other cases it might lead to misleading suggestions (as it's text-based and not smart)
+
 ### Case-sensitive Completions
 
 (*disabled by default*)
@@ -256,6 +267,7 @@ There are value descriptions for two settings:
 
 ```ts
 const example = ({ a }, b?, c = 5, ...d) => { }
+
 // binding-name (default)
 example({ a }, b, c, ...d)
 // always-declaration (also popular)
@@ -268,11 +280,14 @@ example(__0, b, c, d)
 
 ```ts
 const example = ({ a }, b?, c = 5, ...d) => { }
+
 // only-rest
 example({ a }, b, c)
-// optional-and-rest
+// optional-and-rest (default)
 example({ a })
-// no-skip (default)
+// all
+example() // (cursor inside)
+// no-skip (popular)
 example({ a }, b, c, ...d)
 ```
 

src/configurationType.ts

@@ -121,6 +121,11 @@ export type Configuration = {
      * @default disable
      */
     'suggestions.displayImportedInfo': 'disable' | 'short-format' | 'long-format'
+    /**
+     * @recommended
+     * @default false
+     */
+    'suggestions.localityBonus': boolean
     // TODO! corrent watching!
     /**
      * Wether to enable snippets for array methods like `items.map(item => )`

typescript/src/completions/addSourceDefinition.ts

@@ -1,12 +1,12 @@
-import { PrevCompletionMap } from '../completionsAtPosition'
-import { GetConfig } from '../types'
 import stringDedent from 'string-dedent'
+import { sharedCompletionContext } from './sharedContext'
 
-export default (entries: ts.CompletionEntry[], prevCompletionsMap: PrevCompletionMap, c: GetConfig): ts.CompletionEntry[] | undefined => {
-    if (!c('displayAdditionalInfoInCompletions')) return entries
-    return entries.map(entry => {
+export default (entries: ts.CompletionEntry[]) => {
+    const { prevCompletionsMap, c } = sharedCompletionContext
+    if (!c('displayAdditionalInfoInCompletions')) return
+    for (const entry of entries) {
         const symbol = entry['symbol'] as ts.Symbol | undefined
-        if (!symbol) return entry
+        if (!symbol) continue
         const addNodeText = (node: ts.Node) => {
             let text = node.getText().trim()
             if (ts.isBlock(node)) text = text.slice(1, -1)
@@ -20,9 +20,9 @@ export default (entries: ts.CompletionEntry[], prevCompletionsMap: PrevCompletio
             }
         }
         let node: ts.Node = symbol.valueDeclaration!
-        if (!node) return entry
+        if (!node) continue
         if (ts.isVariableDeclaration(node)) node = node.initializer!
-        if (!node) return entry
+        if (!node) continue
         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]!)) {
@@ -31,6 +31,5 @@ export default (entries: ts.CompletionEntry[], prevCompletionsMap: PrevCompletio
                 addNodeText(body)
             }
         }
-        return entry
-    })
+    }
 }

typescript/src/completions/localityBonus.ts

@@ -0,0 +1,22 @@
+import { sharedCompletionContext } from './sharedContext'
+
+export default (entries: ts.CompletionEntry[]) => {
+    let { node, sourceFile, c } = sharedCompletionContext
+    if (!c('suggestions.localityBonus')) return
+
+    const getScore = entry => {
+        const symbol: ts.Symbol | undefined = entry['symbol']
+        if (!symbol) return
+        const { valueDeclaration } = symbol
+        if (!valueDeclaration) return
+        if (valueDeclaration.getSourceFile().fileName !== sourceFile.fileName) return -1
+        return valueDeclaration.pos
+    }
+    if (!node) return
+    return [...entries].sort((a, b) => {
+        const aScore = getScore(a)
+        const bScore = getScore(b)
+        if (aScore === undefined || bScore === undefined) return 0
+        return bScore - aScore
+    })
+}

typescript/src/completionsAtPosition.ts

@@ -3,7 +3,7 @@ import inKeywordCompletions from './completions/inKeywordCompletions'
 // import * as emmet from '@vscode/emmet-helper'
 import isInBannedPosition from './completions/isInBannedPosition'
 import { GetConfig } from './types'
-import { findChildContainingExactPosition, findChildContainingPosition, isTs5 } from './utils'
+import { findChildContainingExactPosition, findChildContainingPosition, isTs5, patchMethod } from './utils'
 import indexSignatureAccessCompletions from './completions/indexSignatureAccess'
 import fixPropertiesSorting from './completions/fixPropertiesSorting'
 import { isGoodPositionBuiltinMethodCompletion } from './completions/isGoodPositionMethodCompletion'
@@ -20,7 +20,7 @@ import defaultHelpers from './completions/defaultHelpers'
 import objectLiteralCompletions from './completions/objectLiteralCompletions'
 import filterJsxElements from './completions/filterJsxComponents'
 import markOrRemoveGlobalCompletions from './completions/markOrRemoveGlobalLibCompletions'
-import { compact, oneOf } from '@zardoy/utils'
+import { compact } from '@zardoy/utils'
 import adjustAutoImports from './completions/adjustAutoImports'
 import escapeStringRegexp from 'escape-string-regexp'
 import addSourceDefinition from './completions/addSourceDefinition'
@@ -30,6 +30,7 @@ import changeKindToFunction from './completions/changeKindToFunction'
 import functionPropsAndMethods from './completions/functionPropsAndMethods'
 import { getTupleSignature } from './tupleSignature'
 import stringTemplateTypeCompletions from './completions/stringTemplateType'
+import localityBonus from './completions/localityBonus'
 
 export type PrevCompletionMap = Record<
     string,
@@ -271,11 +272,13 @@ export const getCompletionsAtPosition = (
     }
     // #endregion
 
-    prior.entries = addSourceDefinition(prior.entries, prevCompletionsMap, c) ?? prior.entries
+    addSourceDefinition(prior.entries)
     displayImportedInfo(prior.entries)
 
     if (c('improveJsxCompletions') && leftNode) prior.entries = improveJsxCompletions(prior.entries, leftNode, position, sourceFile, c('jsxCompletionsMap'))
 
+    prior.entries = localityBonus(prior.entries) ?? prior.entries
+
     const processedEntries = new Set<ts.CompletionEntry>()
     for (const rule of c('replaceSuggestions')) {
         if (rule.filter?.fileNamePattern) {
@@ -376,17 +379,6 @@ export const getCompletionsAtPosition = (
     }
 }
 
-type ArrayPredicate<T> = (value: T, index: number) => boolean
-const arrayMoveItemToFrom = <T>(array: T[], originalItem: ArrayPredicate<T>, itemToMove: ArrayPredicate<T>) => {
-    const originalItemIndex = array.findIndex(originalItem)
-    if (originalItemIndex === -1) return undefined
-    const itemToMoveIndex = array.findIndex(itemToMove)
-    if (itemToMoveIndex === -1) return undefined
-    array.splice(originalItemIndex, 0, array[itemToMoveIndex]!)
-    array.splice(itemToMoveIndex + 1, 1)
-    return originalItemIndex
-}
-
 const patchBuiltinMethods = (c: GetConfig, languageService: ts.LanguageService, isCheckedFile: boolean) => {
     if (isTs5() && (isCheckedFile || !c('additionalIncludeExtensions').length)) return
 
@@ -408,24 +400,21 @@ const patchBuiltinMethods = (c: GetConfig, languageService: ts.LanguageService,
     // Its known that fuzzy completion don't work within import completions
     // TODO! when file name without with half-ending is typed it doesn't these completions! (seems ts bug, but probably can be fixed here)
     // e.g. /styles.css import './styles.c|' - no completions
-    const oldGetSupportedExtensions = tsFull.getSupportedExtensions
-    Object.defineProperty(tsFull, 'getSupportedExtensions', {
-        value: (options, extraFileExtensions) => {
-            addFileExtensions ??= getAddFileExtensions()
-            // though I extensions could be just inlined as is
-            return oldGetSupportedExtensions(
-                options,
-                extraFileExtensions?.length
-                    ? extraFileExtensions
-                    : addFileExtensions.map(ext => ({
-                          extension: ext,
-                          isMixedContent: true,
-                          scriptKind: ts.ScriptKind.Deferred,
-                      })),
-            )
-        },
+    const unpatch = patchMethod(tsFull, 'getSupportedExtensions', (oldGetSupportedExtensions): any => (options, extraFileExtensions) => {
+        addFileExtensions ??= getAddFileExtensions()
+        // though extensions could be just inlined as is
+        return oldGetSupportedExtensions(
+            options,
+            extraFileExtensions?.length
+                ? extraFileExtensions
+                : addFileExtensions.map(ext => ({
+                      extension: ext,
+                      isMixedContent: true,
+                      scriptKind: ts.ScriptKind.Deferred,
+                  })),
+        )
     })
     return () => {
-        Object.defineProperty(tsFull, 'getSupportedExtensions', { value: oldGetSupportedExtensions })
+        unpatch()
     }
 }