虚拟文档

文本文档内容提供程序 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 返回一个一次性对象，通过它可撤销注册。提供程序只需实现 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。

添加编辑器命令

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

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