Merge pull request #116 from zardoy/develop

Author: zardoy

.vscode/launch.json

@@ -15,8 +15,8 @@
             ],
             "sourceMaps": true,
             "env": {
-                "TSS_DEBUG": "9229",
-                "TSS_REMOTE_DEBUG": "9229"
+                "TSS_DEBUG": "9223",
+                "TSS_REMOTE_DEBUG": "9223"
             }
         },
         {

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)
 ```
 
@@ -300,6 +315,22 @@ function Foo() {
 }
 ```
 
+### Ambiguous Suggestions
+
+Some variables like `Object` or `lodash` are common to access properties as well as call directly:
+
+```ts
+Object.assign(...)
+Object()
+// or
+lodash.version
+lodash(...)
+```
+
+To not be annoying, we don't insert a method snippet on such suggestion accept.
+
+Instead, for these *ambiguous* suggestions we require you to accept the same suggestion twice to ensure you actually want a method snippet.
+
 ## Auto Imports
 
 With this plugin you have total (almost) control over auto imports that appear in completions, quick fixes and import all quick fix. Some examples of what you can do:

package.json

@@ -1,9 +1,8 @@
 {
     "name": "ts-essential-plugins",
     "displayName": "TypeScript Essential Plugins",
-    "version": "0.0.1",
+    "version": "0.0.0-dev",
     "license": "MIT",
-    "preview": true,
     "web": true,
     "contributes": {
         "commands": [
@@ -111,7 +110,7 @@
         "@types/fs-extra": "^9.0.13",
         "@types/node": "^16.11.21",
         "@types/semver": "^7.3.13",
-        "@types/vscode": "^1.63.1",
+        "@types/vscode": "1.72.0",
         "@zardoy/tsconfig": "^1.3.1",
         "esbuild": "^0.16.16",
         "fs-extra": "^10.1.0",

pnpm-lock.yaml

@@ -3,56 +3,58 @@ import { getExtensionCommandId } from 'vscode-framework'
 import { passthroughExposedApiCommands, TriggerCharacterCommand } from '../typescript/src/ipcTypes'
 import { sendCommand } from './sendCommand'
 
-export default () => {
-    /** @unique */
-    const cacheableCommands: Set<(typeof passthroughExposedApiCommands)[number]> = new Set(['getNodePath', 'getSpanOfEnclosingComment', 'getNodeAtPosition'])
-    const operationsCache = new Map<string, { key: string; data; time?: number }>()
-    const sharedRequest = async (type: TriggerCharacterCommand, { offset, relativeOffset = 0, document, position }: RequestOptions) => {
-        if (position && offset) throw new Error('Only position or offset parameter can be provided')
-        if (document && !offset && !position) throw new Error('When custom document is provided, offset or position must be provided')
+type RequestOptions = Partial<{
+    /**
+     * Should be rarely overrided, this document must be part of opened project
+     * If specificed, offset or position must be provided too
+     */
+    document: vscode.TextDocument
+    offset: number
+    relativeOffset: number
+    position: vscode.Position
+}>
 
-        const { activeTextEditor } = vscode.window
-        document ??= activeTextEditor?.document
-        if (!document) return
-        if (!position) offset ??= document.offsetAt(activeTextEditor!.selection.active) + relativeOffset
-        const requestOffset = offset ?? document.offsetAt(position!)
-        const requestPos = position ?? document.positionAt(offset!)
-        const getData = async () => sendCommand(type, { document: document!, position: requestPos })
-        const CACHE_UNDEFINED_TIMEOUT = 1000
-        if (cacheableCommands.has(type as any)) {
-            const cacheEntry = operationsCache.get(type)
-            const operationKey = `${document.uri.toString()}:${document.version}:${requestOffset}`
-            if (cacheEntry?.key === operationKey && cacheEntry?.time && Date.now() - cacheEntry.time < CACHE_UNDEFINED_TIMEOUT) {
-                return cacheEntry.data
-            }
+/** @unique */
+const cacheableCommands: Set<(typeof passthroughExposedApiCommands)[number]> = new Set(['getNodePath', 'getSpanOfEnclosingComment', 'getNodeAtPosition'])
+const operationsCache = new Map<string, { key: string; data; time?: number }>()
+export const sharedApiRequest = async (type: TriggerCharacterCommand, { offset, relativeOffset = 0, document, position }: RequestOptions) => {
+    if (position && offset) throw new Error('Only position or offset parameter can be provided')
+    if (document && !offset && !position) throw new Error('When custom document is provided, offset or position must be provided')
 
-            const data = getData()
-            // intentionally storing data only per one offset because it was created for this specific case:
-            // extension 1 completion provider requests API data
-            // at the same time:
-            // extension 2 completion provider requests API data at the same document and position
-            // and so on
-            operationsCache.set(type, { key: operationKey, data, time: data === undefined ? Date.now() : undefined })
-            if (type === 'getNodePath') {
-                operationsCache.set('getNodeAtPosition', { key: operationKey, data: data.then((path: any) => path?.[path.length - 1]) })
-            }
+    const { activeTextEditor } = vscode.window
+    document ??= activeTextEditor?.document
+    if (!document) return
+    if (!position) offset ??= document.offsetAt(activeTextEditor!.selection.active) + relativeOffset
+    const requestOffset = offset ?? document.offsetAt(position!)
+    const requestPos = position ?? document.positionAt(offset!)
+    const getData = async () => sendCommand(type, { document: document!, position: requestPos })
+    const CACHE_UNDEFINED_TIMEOUT = 1000
+    if (cacheableCommands.has(type as any)) {
+        const cacheEntry = operationsCache.get(type)
+        const operationKey = `${document.uri.toString()}:${document.version}:${requestOffset}`
+        if (cacheEntry?.key === operationKey && cacheEntry?.time && Date.now() - cacheEntry.time < CACHE_UNDEFINED_TIMEOUT) {
+            return cacheEntry.data
+        }
 
-            return data
+        const data = getData()
+        // intentionally storing data only per one offset because it was created for this specific case:
+        // extension 1 completion provider requests API data
+        // at the same time:
+        // extension 2 completion provider requests API data at the same document and position
+        // and so on
+        operationsCache.set(type, { key: operationKey, data, time: data === undefined ? Date.now() : undefined })
+        if (type === 'getNodePath') {
+            operationsCache.set('getNodeAtPosition', { key: operationKey, data: data.then((path: any) => path?.[path.length - 1]) })
         }
 
-        return getData()
+        return data
     }
 
-    type RequestOptions = Partial<{
-        /**
-         * Should be rarely overrided, this document must be part of opened project
-         * If specificed, offset or position must be provided too
-         */
-        document: vscode.TextDocument
-        offset: number
-        relativeOffset: number
-        position: vscode.Position
-    }>
-    for (const cmd of passthroughExposedApiCommands)
-        vscode.commands.registerCommand(getExtensionCommandId(cmd as never), async (options: RequestOptions = {}) => sharedRequest(cmd, options))
+    return getData()
+}
+
+export default () => {
+    for (const cmd of passthroughExposedApiCommands) {
+        vscode.commands.registerCommand(getExtensionCommandId(cmd as never), async (options: RequestOptions = {}) => sharedApiRequest(cmd, options))
+    }
 }