虚拟文档
文本文档内容提供程序 API 允许你在 Visual Studio Code 中从任意源创建只读文档。你可以在以下位置找到包含源代码的示例扩展:https://github.com/microsoft/vscode-extension-samples/blob/main/virtual-document-sample/README.md。
TextDocumentContentProvider
该 API 的工作原理是声明一个 uri 方案,你的提供程序随后为该方案返回文本内容。方案必须在注册提供程序时提供,之后不能更改。同一个提供程序可以用于多个方案,并且可以为单个方案注册多个提供程序。
vscode.workspace.registerTextDocumentContentProvider(myScheme, myProvider);
调用 registerTextDocumentContentProvider
返回一个 disposable,可以使用它来撤消注册。提供程序必须仅实现 provideTextDocumentContent
函数,该函数使用 uri 和取消令牌调用。
const myProvider = new (class implements vscode.TextDocumentContentProvider {
provideTextDocumentContent(uri: vscode.Uri): string {
// invoke cowsay, use uri-path as text
return cowsay.say({ text: uri.path });
}
})();
请注意,提供程序不为虚拟文档创建 uri - 它的作用是提供给定 uri 的内容。作为回报,内容提供程序被连接到打开文档逻辑中,以便始终考虑提供程序。
此示例使用 'cowsay' 命令,该命令创建编辑器应随后显示的 uri
vscode.commands.registerCommand('cowsay.say', async () => {
let what = await vscode.window.showInputBox({ placeHolder: 'cow say?' });
if (what) {
let uri = vscode.Uri.parse('cowsay:' + what);
let doc = await vscode.workspace.openTextDocument(uri); // calls back into the provider
await vscode.window.showTextDocument(doc, { preview: false });
}
});
该命令提示输入,创建 cowsay
方案的 uri,为该 uri 打开文档,最后为该文档打开编辑器。在步骤 3 中,打开文档时,系统会要求提供程序为该 uri 提供内容。
有了这个,我们就有了一个功能齐全的文本文档内容提供程序。接下来的部分介绍如何更新虚拟文档以及如何为虚拟文档注册 UI 命令。
更新虚拟文档
根据场景,虚拟文档可能会更改。为了支持这一点,提供程序可以实现 onDidChange
事件。
vscode.Event
类型定义了 VS Code 中事件的约定。实现事件的最简单方法是 vscode.EventEmitter
,如下所示
const myProvider = new (class implements vscode.TextDocumentContentProvider {
// emitter and its event
onDidChangeEmitter = new vscode.EventEmitter<vscode.Uri>();
onDidChange = this.onDidChangeEmitter.event;
//...
})();
事件发射器有一个 fire
方法,可用于在文档中发生更改时通知 VS Code。已更改的文档由其 uri 标识,uri 作为参数提供给 fire
方法。然后将再次调用提供程序以提供更新的内容,假设文档仍然打开。
这就是使 VS Code 监听虚拟文档更改所需的一切。要查看更复杂的示例,了解如何使用此功能,请查看:https://github.com/microsoft/vscode-extension-samples/blob/main/contentprovider-sample/README.md。
添加编辑器命令
可以添加编辑器操作,这些操作仅与关联的内容提供程序提供的文档交互。这是一个示例命令,可以反转奶牛刚才说的话
// register a command that updates the current cowsay
subscriptions.push(
vscode.commands.registerCommand('cowsay.backwards', async () => {
if (!vscode.window.activeTextEditor) {
return; // no editor
}
let { document } = vscode.window.activeTextEditor;
if (document.uri.scheme !== myScheme) {
return; // not my scheme
}
// get path-components, reverse it, and create a new uri
let say = document.uri.path;
let newSay = say
.split('')
.reverse()
.join('');
let newUri = document.uri.with({ path: newSay });
await vscode.window.showTextDocument(newUri, { preview: false });
})
);
上面的代码片段检查我们是否有一个活动编辑器,以及它的文档是否是我们的方案之一。需要这些检查,因为命令对每个人都可用(和可执行)。然后反转 uri 的路径组件,并从中创建一个新的 uri,最后打开一个编辑器。
为了使用编辑器命令来完成任务,需要在 package.json
中添加声明性部分。在 contributes
部分中添加此配置
"menus": {
"editor/title": [
{
"command": "cowsay.backwards",
"group": "navigation",
"when": "resourceScheme == cowsay"
}
]
}
这引用了在 contributes/commands
部分中定义的 cowsay.backwards
命令,并说明它应该出现在编辑器标题菜单(右上角的工具栏)中。现在,仅仅这样就意味着该命令始终显示,对于每个编辑器都是如此。这就是 when
子句的用途 - 它描述了显示操作必须为真的条件。在此示例中,它声明编辑器中文档的方案必须是 cowsay
方案。然后在 commandPalette
菜单中重复配置 - 默认情况下显示所有命令。
事件和可见性
文档提供程序是 VS Code 中的一等公民,它们的内容出现在常规文本文档中,它们使用与文件等相同的基础结构。但是,这也意味着“你的”文档无法隐藏,它们将出现在 onDidOpenTextDocument
和 onDidCloseTextDocument
事件中,它们是 vscode.workspace.textDocuments
的一部分等等。对每个人的规则是检查文档的 scheme
,然后决定是否要对文档执行某些操作。
文件系统 API
如果你需要更高的灵活性和强大功能,请查看 FileSystemProvider
API。它允许实现完整的文件系统,具有文件、文件夹、二进制数据、文件删除、创建等功能。
你可以在以下位置找到包含源代码的示例扩展:https://github.com/microsoft/vscode-extension-samples/tree/main/fsprovider-sample/README.md。
当 VS Code 在此类文件系统的文件夹或工作区中打开时,我们称之为虚拟工作区。当虚拟工作区在 VS Code 窗口中打开时,这会在左下角的远程指示器中显示标签,类似于远程窗口。请参阅虚拟工作区指南,了解扩展如何支持该设置。