虚拟文档

文本文档内容提供程序 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 会返回一个可 disposal 对象，用于撤销注册。提供程序只需要实现 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，然后编辑器会显示该 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。发生更改的文档通过作为参数传递给 fire 方法的 URI 来标识。然后会再次调用提供程序来提供更新后的内容，前提是文档仍然打开。

这些就是让 VS Code 监听虚拟文档更改所需的所有内容。要查看一个利用此功能的更复杂的示例，请参阅：https://github.com/microsoft/vscode-extension-samples/blob/main/contentprovider-sample/README.md。

添加编辑器命令

可以添加仅与关联内容提供程序提供的文档交互的编辑器操作。这是一个反转了“cow”刚才说的话的示例命令：

// 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 窗口中打开时，这会通过左下角远程指示器中的标签来显示，类似于远程窗口。有关扩展如何支持此设置，请参阅虚拟工作区指南。