首页 > 解决方案 > VS Code API - 远程调用

问题描述

我目前正在结合代码生成项目研究 VS 代码扩展。虽然我知道 VS 代码 API 相当成熟,允许在扩展内操作文档,但我不知道如何在扩展之外执行此操作。

有没有办法在 vscode 之外远程执行 vs code JavaScript API,这反过来又会驱动 GUI。

我想弄清楚我是否可以执行以下任何操作:

基本上,vs code的遥控驱动有哪些选项?

标签: visual-studio-codevscode-extensionsvscode-remote

解决方案


我正在使用的编辑器扩展也遇到了类似的问题。

我强烈建议在 VSCode API 之外监听文件更改。这样,您的大部分代码都不会绑定到特定的编辑器。我在使用调用的 VSCode API 时也遇到了更多困难,createFileSystemWatcher因为它没有捕获所有更改。

激活后,使用文件观察程序库运行子进程。我建议使用chokidar——它与 VSCode 内部使用的库相同,但可以更广泛地访问 API。

// get your workspace uri & root uri 
const workspaceRoots = vscode.workspace.workspaceFolders
if (!workspaceRoots || !workspaceRoots.length) {
  throw new Error('No workspace root path')
}
const workspaceRoot: vscode.WorkspaceFolder = workspaceRoots[0]
const rootUri = vscode.workspace.getWorkspaceFolder(workspaceUri);

// the action you want to trigger
const command = vscode.commands.registerCommand('YOUR_CUSTOM_COMMAND', yourCustomFunction)

// file watcher
const fsWatcher = chokidar.watch('watcher_name', {
  cwd: rootUri.uri.path,
  interval: 1000,
})

// listen to any add/update/delete fs events
fsWatcher.on('change', (path, event) => {
  vscode.commands.executeCommand('YOUR_CUSTOM_COMMAND')
})

在任何文件更改时,它都可以触发您选择的操作。


推荐阅读