feat: update locality bonus!

Now variables defined before have more priority, added a setting so you can return old behavior, which was also improved.

Author: zardoy

src/configurationType.ts

@@ -127,6 +127,11 @@ export type Configuration = {
      * @default false
      */
     'suggestions.localityBonus': boolean
+    /**
+     * position = cursor position
+     * @default prefer-before-position
+     */
+    'suggestions.localityBonusMode': 'prefer-before-position' | 'nearest-to-position'
     // TODO! corrent watching!
     /**
      * Wether to enable snippets for array methods like `items.map(item => )`

typescript/src/completions/localityBonus.ts

@@ -1,24 +1,27 @@
 import { sharedCompletionContext } from './sharedContext'
 
 export default (entries: ts.CompletionEntry[]) => {
-    const { node, sourceFile, c } = sharedCompletionContext
+    const { node, sourceFile, c, position } = sharedCompletionContext
     if (!c('suggestions.localityBonus')) return
 
-    const getScore = entry => {
-        // TODO once TS is updated resolve
-        // eslint-disable-next-line prefer-destructuring
-        const symbol: ts.Symbol | undefined = entry['symbol']
+    if (!node) return
+    const LOWEST_SCORE = node.getSourceFile().getFullText().length
+    const getScore = (entry: ts.CompletionEntry) => {
+        const { symbol } = entry
         if (!symbol) return
         const { valueDeclaration = symbol.declarations?.[0] } = symbol
         if (!valueDeclaration) return
-        if (valueDeclaration.getSourceFile().fileName !== sourceFile.fileName) return -1
-        return valueDeclaration.pos
+        if (valueDeclaration.getSourceFile().fileName !== sourceFile.fileName) return LOWEST_SCORE
+        const completionPos = valueDeclaration.pos + valueDeclaration.getLeadingTriviaWidth()
+        if (c('suggestions.localityBonusMode') === 'nearest-to-position') {
+            return Math.abs(completionPos - position)
+        }
+        return completionPos < position ? -position - completionPos : completionPos - position
     }
-    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
+        return aScore - bScore
     })
 }