feat: Add API vscode command tsEssentialPlugins.getNodeAtPosition that some extension can use to reliably get node at position!

Author: zardoy

src/extension.ts

@@ -2,7 +2,7 @@
 import * as vscode from 'vscode'
 import { defaultJsSupersetLangs } from '@zardoy/vscode-utils/build/langs'
 import { getActiveRegularEditor } from '@zardoy/vscode-utils'
-import { getExtensionSetting, registerActiveDevelopmentCommand, extensionCtx, getExtensionSettingId } from 'vscode-framework'
+import { getExtensionSetting, extensionCtx, getExtensionSettingId, getExtensionCommandId } from 'vscode-framework'
 import { pickObj } from '@zardoy/utils'
 import throttle from 'lodash.throttle'
 import { PostfixCompletion, TriggerCharacterCommand } from '../typescript/src/ipcTypes'
@@ -149,6 +149,18 @@ export const activate = async () => {
         '.',
     )
 
+    type RequestOptions = Partial<{
+        offset: number
+    }>
+    vscode.commands.registerCommand(getExtensionCommandId('getNodeAtPosition' as never), async (_, { offset }: RequestOptions = {}) => {
+        const { activeTextEditor } = vscode.window
+        if (!activeTextEditor) return
+        const { document } = activeTextEditor
+        const { typescriptEssentialsResponse: data } =
+            (await sendCommand('nodeAtPosition', { document, position: offset ? document.positionAt(offset) : activeTextEditor.selection.active })) ?? {}
+        return data
+    })
+
     // not removing as we can enable it back in near future
     const enableExperimentalPluginRestoration = false
 

typescript/src/ipcTypes.ts

@@ -1,6 +1,12 @@
-export const triggerCharacterCommands = ['find-in-import', 'getPostfixes', 'check-configuration'] as const
+export const triggerCharacterCommands = ['find-in-import', 'getPostfixes', 'nodeAtPosition', 'check-configuration'] as const
 export type TriggerCharacterCommand = typeof triggerCharacterCommands[number]
 
+export type NodeAtPositionResponse = {
+    kindName: string
+    start: number
+    end: number
+}
+
 export type PostfixCompletion = {
     label: string
     // replacement: [startOffset: number, endOffset?: number]

typescript/src/specialCommands/handle.ts

@@ -1,8 +1,18 @@
 import type tslib from 'typescript/lib/tsserverlibrary'
 import postfixesAtPosition from '../completions/postfixesAtPosition'
-import { TriggerCharacterCommand, triggerCharacterCommands } from '../ipcTypes'
+import { NodeAtPositionResponse, TriggerCharacterCommand, triggerCharacterCommands } from '../ipcTypes'
+import { findChildContainingPosition } from '../utils'
 
-export default (info: tslib.server.PluginCreateInfo, fileName: string, position: number, specialCommand: TriggerCharacterCommand, configuration: any) => {
+export default (
+    info: tslib.server.PluginCreateInfo,
+    fileName: string,
+    position: number,
+    specialCommand: TriggerCharacterCommand,
+    configuration: any,
+): void | {
+    entries: []
+    typescriptEssentialsResponse: any
+} => {
     if (specialCommand === 'check-configuration') {
         return {
             entries: [],
@@ -12,6 +22,19 @@ export default (info: tslib.server.PluginCreateInfo, fileName: string, position:
     if (triggerCharacterCommands.includes(specialCommand) && !configuration) {
         throw new Error('no-ts-essential-plugin-configuration')
     }
+    if (specialCommand === 'nodeAtPosition') {
+        const node = findChildContainingPosition(ts, info.languageService.getProgram()!.getSourceFile(fileName)!, position)
+        return {
+            entries: [],
+            typescriptEssentialsResponse: !node
+                ? undefined
+                : ({
+                      kindName: ts.SyntaxKind[node.kind],
+                      start: node.getStart(),
+                      end: node.getEnd(),
+                  } as NodeAtPositionResponse),
+        }
+    }
     if (specialCommand === 'getPostfixes') {
         const scriptSnapshot = info.project.getScriptSnapshot(fileName)
         if (!scriptSnapshot) return