feat: getNodePath API command. Add relativeOffset to API request options as API commonly used with -1 offset

Author: zardoy

src/extension.ts

@@ -2,8 +2,9 @@
 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, getExtensionCommandId, registerActiveDevelopmentCommand } 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'
@@ -76,15 +77,22 @@ 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 ({ offset }: RequestOptions = {}) => {
-        const { activeTextEditor } = vscode.window
-        if (!activeTextEditor) return
-        const { document } = activeTextEditor
-        return sendCommand('nodeAtPosition', { document, position: offset ? document.positionAt(offset) : activeTextEditor.selection.active })
-    })
+    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 () => {

typescript/src/completions/isGoodPositionMethodCompletion.ts

@@ -3,7 +3,7 @@ import { GetConfig } from '../types'
 import { findChildContainingPosition, findChildContainingPositionMaxDepth } from '../utils'
 
 export const isGoodPositionBuiltinMethodCompletion = (ts: typeof tslib, sourceFile: ts.SourceFile, position: number, c: GetConfig) => {
-    const importClauseCandidate = findChildContainingPositionMaxDepth(ts, sourceFile, position, 3)
+    const importClauseCandidate = findChildContainingPositionMaxDepth(sourceFile, position, 3)
     if (importClauseCandidate && ts.isImportClause(importClauseCandidate)) return false
     const textBeforePos = sourceFile.getFullText().slice(position - 1, position)
     let currentNode = findChildContainingPosition(ts, sourceFile, textBeforePos === ':' ? position - 1 : position)

typescript/src/ipcTypes.ts

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

typescript/src/specialCommands/handle.ts

@@ -1,6 +1,6 @@
 import postfixesAtPosition from '../completions/postfixesAtPosition'
 import { NodeAtPositionResponse, TriggerCharacterCommand, triggerCharacterCommands } from '../ipcTypes'
-import { findChildContainingPosition } from '../utils'
+import { findChildContainingPosition, getNodePath } from '../utils'
 import getEmmetCompletions from './emmet'
 
 export default (
@@ -29,13 +29,14 @@ export default (
         const node = findChildContainingPosition(ts, sourceFile, position)
         return {
             entries: [],
-            typescriptEssentialsResponse: !node
-                ? undefined
-                : ({
-                      kindName: ts.SyntaxKind[node.kind],
-                      start: node.getStart(),
-                      end: node.getEnd(),
-                  } as NodeAtPositionResponse),
+            typescriptEssentialsResponse: !node ? undefined : nodeToApiResponse(node),
+        }
+    }
+    if (specialCommand === 'nodePath') {
+        const nodes = getNodePath(sourceFile, position)
+        return {
+            entries: [],
+            typescriptEssentialsResponse: nodes.map(node => nodeToApiResponse(node)),
         }
     }
     if (specialCommand === 'getPostfixes') {
@@ -47,3 +48,11 @@ export default (
         } as any
     }
 }
+
+function nodeToApiResponse(node: ts.Node): NodeAtPositionResponse {
+    return {
+        kindName: ts.SyntaxKind[node.kind]!,
+        start: node.getStart(),
+        end: node.getEnd(),
+    }
+}

typescript/src/utils.ts

@@ -1,11 +1,7 @@
 import type tslib from 'typescript/lib/tsserverlibrary'
 import { SetOptional } from 'type-fest'
 
-export function findChildContainingPosition(
-    typescript: typeof import('typescript/lib/tsserverlibrary'),
-    sourceFile: ts.SourceFile,
-    position: number,
-): ts.Node | undefined {
+export function findChildContainingPosition(typescript: typeof tslib, sourceFile: ts.SourceFile, position: number): ts.Node | undefined {
     function find(node: ts.Node): ts.Node | undefined {
         if (position >= node.getStart() && position < node.getEnd()) {
             return typescript.forEachChild(node, find) || node
@@ -16,25 +12,41 @@ export function findChildContainingPosition(
     return find(sourceFile)
 }
 
-export function findChildContainingPositionMaxDepth(
-    typescript: typeof import('typescript/lib/tsserverlibrary'),
-    sourceFile: ts.SourceFile,
-    position: number,
-    maxDepth?: number,
-): ts.Node | undefined {
+export function findChildContainingPositionMaxDepth(sourceFile: ts.SourceFile, position: number, maxDepth?: number): ts.Node | undefined {
     let currentDepth = 0
     function find(node: ts.Node): ts.Node | undefined {
         if (position >= node.getStart() && position < node.getEnd()) {
             if (++currentDepth === maxDepth) return node
-            return typescript.forEachChild(node, find) || node
+            return ts.forEachChild(node, find) || node
         }
 
         return
     }
     return find(sourceFile)
 }
 
-export const getIndentFromPos = (typescript: typeof import('typescript/lib/tsserverlibrary'), sourceFile: ts.SourceFile, position: number) => {
+export function getNodePath(sourceFile: ts.SourceFile, position: number): ts.Node[] {
+    const nodes: ts.Node[] = []
+    function find(node: ts.Node): ts.Node | undefined {
+        if (position >= node.getStart() && position < node.getEnd()) {
+            if (node !== sourceFile) nodes.push(node)
+            return ts.forEachChild(node, find) || node
+        }
+
+        return
+    }
+    find(sourceFile)
+    return nodes
+}
+
+// todo not impl
+type MatchStringValue = keyof typeof ts.SyntaxKind | '*'
+
+export const matchNodePath = (sourceFile: ts.SourceFile, position: number, candidates: MatchStringValue[][]) => {
+    const nodesPath = getNodePath(sourceFile, position)
+}
+
+export const getIndentFromPos = (typescript: typeof tslib, sourceFile: ts.SourceFile, position: number) => {
     const { character } = typescript.getLineAndCharacterOfPosition(sourceFile, position)
     return (
         sourceFile