虚拟工作区
像 GitHub Repositories 这样的扩展会在一个或多个由文件系统提供程序支持的文件夹上打开 VS Code。当扩展实现文件系统提供程序时,工作区资源可能不在本地磁盘上,而是虚拟的,位于服务器或云端,并且编辑操作在那里进行。
此配置称为虚拟工作区。当 VS Code 窗口中打开虚拟工作区时,左下角的远程指示器中会显示一个标签,类似于其他远程开发窗口。
并非所有扩展都能与虚拟资源一起工作,有些可能需要资源位于磁盘上。有些扩展使用的工具依赖于磁盘访问,需要同步文件访问,或者没有必要的文件系统抽象。在这些情况下,当处于虚拟工作区时,VS Code 会向用户指示他们正在以受限模式运行,并且某些扩展被禁用或功能受限。
一般来说,用户希望尽可能多的扩展能在虚拟工作区中工作,并在浏览和编辑远程资源时获得良好的用户体验。本指南展示了扩展如何针对虚拟工作区进行测试,描述了使其能在虚拟工作区中工作的修改,并介绍了 virtualWorkspaces
能力属性。
修改扩展以使其与虚拟工作区一起工作,也是在Web 版 VS Code中良好工作的重要一步。Web 版 VS Code 完全在浏览器中运行,由于浏览器沙盒,工作区是虚拟的。有关更多详细信息,请参阅Web 扩展指南。
我的扩展受影响吗?
当扩展没有可执行代码而只是纯粹的声明性扩展,如主题、键绑定、代码片段或语法扩展时,它可以在虚拟工作区中运行,无需修改。
具有代码的扩展,即定义了 main
入口点的扩展,需要检查并可能需要修改。
针对虚拟工作区运行你的扩展
安装 GitHub Repositories 扩展,并从命令面板运行打开 GitHub 仓库...命令。该命令会显示一个快速选择下拉菜单,你可以粘贴任意 GitHub URL,或者选择搜索特定的仓库或拉取请求。
这会为虚拟工作区打开一个 VS Code 窗口,其中所有资源都是虚拟的。
检查扩展代码是否已为虚拟资源做好准备
VS Code API 对虚拟文件系统的支持已经存在相当长一段时间了。你可以查看文件系统提供程序 API。
文件系统提供程序是为新的 URI 方案(例如,vscode-vfs
)注册的,并且该文件系统上的资源将由使用该方案的 URI(vscode-vfs://github/microsoft/vscode/package.json
)表示。
检查你的扩展如何处理从 VS Code API 返回的 URI
- 永远不要假设 URI 方案是
file
。URI.fsPath
只能在 URI 方案为file
时使用。 - 注意用于文件系统操作的
fs
Node 模块的使用。如果可能,请使用vscode.workspace.fs
API,它会将操作委托给适当的文件系统提供程序。 - 检查依赖于
fs
访问的第三方组件(例如,语言服务器或 Node 模块)。 - 如果你从命令运行可执行文件和任务,请检查这些命令在虚拟工作区窗口中是否有意义,或者它们是否应该被禁用。
表明你的扩展是否能处理虚拟工作区
package.json
中 capabilities
下的 virtualWorkspaces
属性用于表明扩展是否与虚拟工作区一起工作。
不支持虚拟工作区
以下示例声明扩展不支持虚拟工作区,并且不应在此设置中由 VS Code 启用。
{
"capabilities": {
"virtualWorkspaces": {
"supported": false,
"description": "Debugging is not possible in virtual workspaces."
}
}
}
对虚拟工作区的部分和完全支持
当扩展与虚拟工作区一起工作或部分工作时,它应定义 "virtualWorkspaces": true
。
{
"capabilities": {
"virtualWorkspaces": true
}
}
如果扩展工作,但功能受限,它应该向用户解释此限制
{
"capabilities": {
"virtualWorkspaces": {
"supported": "limited",
"description": "In virtual workspaces, resolving and finding references across files is not supported."
}
}
}
描述显示在“扩展”视图中
然后,扩展应禁用虚拟工作区中不支持的功能,如下所述。
默认值
"virtualWorkspaces": true
是所有尚未填写 virtualWorkspaces
能力的扩展的默认值。
然而,在测试虚拟工作区时,我们列出了我们认为应该在虚拟工作区中禁用的扩展列表。该列表可在问题 #122836中找到。这些扩展的默认值为"virtualWorkspaces": false
。
当然,扩展作者更适合做出此决定。扩展的 package.json
中的 virtualWorkspaces
能力将覆盖我们的默认设置,我们最终会废弃我们的列表。
在打开虚拟工作区时禁用功能
禁用命令和视图贡献
命令和视图以及许多其他贡献的可用性可以通过when 子句中的上下文键进行控制。
当所有工作区文件夹都位于虚拟文件系统上时,virtualWorkspace
上下文键被设置。以下示例仅在不在虚拟工作区中时在命令面板中显示命令 npm.publish
{
"menus": {
"commandPalette": [
{
"command": "npm.publish",
"when": "!virtualWorkspace"
}
]
}
}
resourceScheme
上下文键被设置为文件资源管理器中当前选定元素或编辑器中打开元素的 URI 方案。
在下面的示例中,仅当底层资源位于本地磁盘时,npm.runSelectedScript
命令才会在编辑器上下文菜单中显示。
{
"menus": {
"editor/context": [
{
"command": "npm.runSelectedScript",
"when": "resourceFilename == 'package.json' && resourceScheme == file"
}
]
}
}
以编程方式检测虚拟工作区
要检查当前工作区是否包含非 file
方案且是虚拟的,可以使用以下源代码
const isVirtualWorkspace =
workspace.workspaceFolders &&
workspace.workspaceFolders.every(f => f.uri.scheme !== 'file');
语言扩展和虚拟工作区
对虚拟工作区的语言支持有什么期望?
所有扩展都能完全与虚拟资源一起工作是不现实的。许多扩展使用需要同步文件访问和磁盘上文件的外部工具。因此,只提供有限的功能,例如下面列出的基本和单文件支持,是可以接受的。
A. 基本语言支持
- TextMate 词法分析和着色
- 特定语言的编辑支持:括号对、注释、回车规则、折叠标记
- 代码片段
B. 单文件语言支持
- 文档符号(大纲)、折叠、选择范围
- 文档高亮、语义高亮、文档颜色
- 基于当前文件中的符号和静态语言库的补全、悬停、签名帮助、查找引用/声明
- 格式化、链接编辑
- 语法验证和同文件语义验证及代码操作
C. 跨文件、工作区感知语言支持
- 跨文件引用
- 工作区符号
- 验证工作区/项目中的所有文件
VS Code 自带的富语言扩展(TypeScript、JSON、CSS、HTML、Markdown)在处理虚拟资源时仅限于单文件语言支持。
禁用语言扩展
如果单文件工作不是一个选项,语言扩展也可以决定在虚拟工作区中禁用该扩展。
如果你的扩展同时提供需要被禁用的语法和富语言支持,那么语法也将被禁用。为了避免这种情况,你可以创建一个与富语言支持分离的基本语言扩展(语法、语言配置、代码片段),从而拥有两个扩展。
- 基本语言扩展的
"virtualWorkspaces": true
,并提供语言 ID、配置、语法和代码片段。 - 富语言扩展的
"virtualWorkspaces": false
,并包含main
文件。它贡献语言支持、命令,并对基本语言扩展具有扩展依赖 (extensionDependencies
)。富语言扩展应保留已建立扩展的扩展 ID,以便用户可以通过安装单个扩展继续获得完整功能。
你可以在内置语言扩展中看到这种方法,例如 JSON,它由一个 JSON 扩展和一个 JSON 语言特性扩展组成。
这种分离也有助于在受限模式下运行的不受信任的工作区。富语言扩展通常需要信任,而基本语言特性可以在任何设置中运行。
语言选择器
在为语言特性(例如,补全、悬停、代码操作等)注册提供程序时,请确保指定提供程序支持的方案。
return vscode.languages.registerCompletionItemProvider(
{ language: 'typescript', scheme: 'file' },
{
provideCompletionItems(document, position, token) {
// ...
}
}
);
语言服务器协议 (LSP) 对访问虚拟资源的支持如何?
正在进行将文件系统提供程序支持添加到 LSP 的工作。在语言服务器协议问题 #1264 中进行跟踪。