Visual Studio Code

文档选择器

扩展可以根据文档选择器基于语言、文件类型和位置来过滤其功能。本主题讨论了文档选择器、文档方案以及扩展作者应注意的事项。

不在磁盘上的文本文档

并非所有文本文档都存储在磁盘上，例如新创建的文档。除非另有说明，文档选择器适用于所有文档类型。使用DocumentFilter的scheme属性来缩小到特定的方案，例如{ scheme: 'file', language: 'typescript' }用于存储在磁盘上的TypeScript文件。

文档选择器

Visual Studio Code 扩展 API 通过 DocumentSelector 类型将特定语言的功能（如 IntelliSense）与文档选择器结合起来。它们是一种简单的机制，可以将功能限制在特定语言上。

下面的代码片段为TypeScript文件注册了一个HoverProvider，文档选择器是typescript语言标识符字符串。

vscode.languages.registerHoverProvider('typescript', {
  provideHover(doc: vscode.TextDocument) {
    return new vscode.Hover('For *all* TypeScript documents.');
  }
});

文档选择器不仅仅是一个语言标识符，更复杂的选择器可以使用DocumentFilter来基于scheme和通过pattern路径通配符的文件位置进行过滤：

vscode.languages.registerHoverProvider(
  { pattern: '**/test/**' },
  {
    provideHover(doc: vscode.TextDocument) {
      return new vscode.Hover('For documents inside `test`-folders only');
    }
  }
);

下一个片段使用了scheme过滤器，并将其与语言标识符结合。未命名的untitled方案适用于尚未保存到磁盘的新文件。

vscode.languages.registerHoverProvider(
  { scheme: 'untitled', language: 'typescript' },
  {
    provideHover(doc: vscode.TextDocument) {
      return new vscode.Hover('For new, unsaved TypeScript documents only');
    }
  }
);

文档方案

文档的scheme经常被忽视，但它是一个重要的信息。大多数文档保存在磁盘上，扩展作者通常假设他们正在处理磁盘上的文件。例如，使用一个简单的typescript选择器时，假设是磁盘上的TypeScript文件。然而，在某些情况下，这种假设过于宽松，应该使用更明确的选择器，如{ scheme: 'file', language: 'typescript' }。

当功能依赖于从磁盘读取/写入文件时，这一点的重要性就显现出来了。查看下面的代码片段：

// 👎 too lax
vscode.languages.registerHoverProvider('typescript', {
  provideHover(doc: vscode.TextDocument) {
    const { size } = fs.statSync(doc.uri.fsPath); // ⚠️ what about 'untitled:/Untitled1.ts' or others?
    return new vscode.Hover(`Size in bytes is ${size}`);
  }
});

上面的悬停提供程序想要显示文档在磁盘上的大小，但它未能检查文档是否实际存储在磁盘上。例如，它可能是新创建的且尚未保存。正确的方法是告诉VS Code，该提供程序只能处理磁盘上的文件。

// 👍 only works with files on disk
vscode.languages.registerHoverProvider(
  { scheme: 'file', language: 'typescript' },
  {
    provideHover(doc: vscode.TextDocument) {
      const { size } = fs.statSync(doc.uri.fsPath);
      return new vscode.Hover(`Size in bytes is ${size}`);
    }
  }
);

摘要

文档通常存储在文件系统中，但并非总是如此：存在无标题文档、Git使用的缓存文档、来自远程源（如FTP）的文档等。如果您的功能依赖于磁盘访问，请确保使用带有file方案的文档选择器。

下一步

要了解更多关于VS Code扩展模型的信息，请尝试以下主题：

12/11/2024