feat: add getSpanOfEnclosingComment command

refactor exposed ext API commands

Author: zardoy

src/apiCommands.ts

@@ -0,0 +1,21 @@
+import * as vscode from 'vscode'
+import { getExtensionCommandId } from 'vscode-framework'
+import { passthroughExposedApiCommands, TriggerCharacterCommand } from '../typescript/src/ipcTypes'
+import { sendCommand } from './sendCommand'
+
+export default () => {
+    const sharedRequest = (type: TriggerCharacterCommand, { offset, relativeOffset = 0 }: RequestOptions) => {
+        const { activeTextEditor } = vscode.window
+        if (!activeTextEditor) return
+        const { document, selection } = activeTextEditor
+        offset ??= document.offsetAt(selection.active) + relativeOffset
+        return sendCommand(type, { document, position: document.positionAt(offset) })
+    }
+
+    type RequestOptions = Partial<{
+        offset: number
+        relativeOffset: number
+    }>
+    for (const cmd of passthroughExposedApiCommands)
+        vscode.commands.registerCommand(getExtensionCommandId(cmd as never), async (options: RequestOptions = {}) => sharedRequest(cmd, options))
+}

src/extension.ts

@@ -2,16 +2,16 @@
 import * as vscode from 'vscode'
 import { defaultJsSupersetLangs } from '@zardoy/vscode-utils/build/langs'
 import { getActiveRegularEditor } from '@zardoy/vscode-utils'
-import { extensionCtx, getExtensionSettingId, getExtensionCommandId } from 'vscode-framework'
+import { extensionCtx, getExtensionSettingId } from 'vscode-framework'
 import { pickObj } from '@zardoy/utils'
-import { TriggerCharacterCommand } from '../typescript/src/ipcTypes'
 import { Configuration } from './configurationType'
 import webImports from './webImports'
 import { sendCommand } from './sendCommand'
 import { registerEmmet } from './emmet'
 import experimentalPostfixes from './experimentalPostfixes'
 import migrateSettings from './migrateSettings'
 import figIntegration from './figIntegration'
+import apiCommands from './apiCommands'
 
 export const activateTsPlugin = (tsApi: { configurePlugin; onCompletionAccepted }) => {
     let webWaitingForConfigSync = false
@@ -79,23 +79,6 @@ export const activateTsPlugin = (tsApi: { configurePlugin; onCompletionAccepted
         }
     })
 
-    const sharedRequest = (type: TriggerCharacterCommand, { offset, relativeOffset = 0 }: RequestOptions) => {
-        const { activeTextEditor } = vscode.window
-        if (!activeTextEditor) return
-        const { document, selection } = activeTextEditor
-        offset ??= document.offsetAt(selection.active) + relativeOffset
-        return sendCommand(type, { document, position: document.positionAt(offset) })
-    }
-
-    type RequestOptions = Partial<{
-        offset: number
-        relativeOffset: number
-    }>
-    vscode.commands.registerCommand(getExtensionCommandId('getNodeAtPosition' as never), async (options: RequestOptions = {}) =>
-        sharedRequest('nodeAtPosition', options),
-    )
-    vscode.commands.registerCommand(getExtensionCommandId('getNodePath' as never), async (options: RequestOptions = {}) => sharedRequest('nodePath', options))
-
     if (process.env.PLATFORM === 'web') {
         const possiblySyncConfig = async () => {
             const { activeTextEditor } = vscode.window
@@ -113,6 +96,7 @@ export const activateTsPlugin = (tsApi: { configurePlugin; onCompletionAccepted
     experimentalPostfixes()
     void registerEmmet()
     webImports()
+    apiCommands()
 
     figIntegration()
 }

typescript/src/index.ts

@@ -46,7 +46,7 @@ const decorateLanguageService = (info: ts.server.PluginCreateInfo, existingProxy
             return { entries: [] }
         }
         const specialCommandResult = options?.triggerCharacter
-            ? handleSpecialCommand(info, fileName, position, options.triggerCharacter as TriggerCharacterCommand, _configuration)
+            ? handleSpecialCommand(info, fileName, position, options.triggerCharacter as TriggerCharacterCommand, languageService, _configuration)
             : undefined
         // handled specialCommand request
         if (specialCommandResult !== undefined) return specialCommandResult as any

typescript/src/ipcTypes.ts

@@ -1,4 +1,7 @@
-export const triggerCharacterCommands = ['find-in-import', 'getPostfixes', 'nodeAtPosition', 'nodePath', 'emmet-completions'] as const
+export const passthroughExposedApiCommands = ['getNodePath', 'getSpanOfEnclosingComment', 'getNodeAtPosition'] as const
+
+export const triggerCharacterCommands = [...passthroughExposedApiCommands, 'emmet-completions', 'getPostfixes'] as const
+
 export type TriggerCharacterCommand = typeof triggerCharacterCommands[number]
 
 export type NodeAtPositionResponse = {

typescript/src/specialCommands/handle.ts

@@ -8,6 +8,7 @@ export default (
     fileName: string,
     position: number,
     specialCommand: TriggerCharacterCommand,
+    languageService: ts.LanguageService,
     configuration: any,
 ): void | {
     entries: []
@@ -25,14 +26,20 @@ export default (
             typescriptEssentialsResponse: getEmmetCompletions(fileName, leftNode, sourceFile, position, info.languageService),
         }
     }
-    if (specialCommand === 'nodeAtPosition') {
+    if (specialCommand === 'getNodeAtPosition') {
         const node = findChildContainingPosition(ts, sourceFile, position)
         return {
             entries: [],
             typescriptEssentialsResponse: !node ? undefined : nodeToApiResponse(node),
         }
     }
-    if (specialCommand === 'nodePath') {
+    if (specialCommand === 'getSpanOfEnclosingComment') {
+        return {
+            entries: [],
+            typescriptEssentialsResponse: languageService.getSpanOfEnclosingComment(fileName, position, false),
+        }
+    }
+    if (specialCommand === 'getNodePath') {
         const nodes = getNodePath(sourceFile, position)
         return {
             entries: [],