扩展能力概述

Visual Studio Code 为扩展提供了多种扩展其能力的方式。有时可能很难找到要使用的正确贡献点和VS Code API。本主题将扩展能力分为几个类别。每个类别描述了

• 您的扩展可以使用的某些功能
• 关于使用这些功能的更详细主题的链接
• 一些扩展创意

但是，我们也对扩展施加了限制，以确保 VS Code 的稳定性和性能。例如，扩展无法访问 VS Code UI 的 DOM。

常用能力

常用能力是您可以在任何扩展中使用的核心功能。

其中一些能力包括

• 注册命令、配置、键绑定或上下文菜单项。
• 存储工作区或全局数据。
• 显示通知消息。
• 使用快速选择收集用户输入。
• 打开系统文件选择器，让用户选择文件或文件夹。
• 使用 Progress API 指示长时间运行的操作。

主题

主题控制着 VS Code 的外观，包括编辑器中源代码的颜色和 VS Code UI 的颜色。如果您曾经想通过将 VS Code 变成不同深度的绿色来使其看起来像在编写《黑客帝国》，或者只是想创建一个极致、简约的灰度工作区，那么主题就是为您准备的。

扩展创意

• 更改源代码的颜色。
• 更改 VS Code UI 的颜色。
• 将现有的 TextMate 主题移植到 VS Code。
• 添加自定义文件图标。

声明式语言特性

声明式语言特性为编程语言添加了基本的文本编辑支持，例如括号匹配、自动缩进和语法高亮。这是通过声明方式完成的，无需编写任何代码。对于更高级的语言特性，如 IntelliSense 或调试，请参阅编程语言特性。

扩展创意

• 将常用的 JavaScript 代码片段打包到扩展中。
• 告诉 VS Code 关于一种新的编程语言。
• 添加或替换编程语言的语法。
• 使用语法注入扩展现有语法。
• 将现有的 TextMate 语法移植到 VS Code。

编程语言特性

编程语言特性添加了丰富的编程语言支持，例如悬停信息、转到定义、诊断错误、IntelliSense 和 CodeLens。这些语言特性通过 vscode.languages.* API 暴露。扩展可以直接使用这些 API，或者编写一个语言服务器并使用 VS Code 语言服务器库将其适配到 VS Code。

虽然我们提供了语言特性及其预期用法的列表，但没有什么能阻止您创造性地使用这些 API。例如，CodeLens 和悬停信息是以内联方式呈现附加信息的好方法，而诊断错误可用于高亮显示拼写或代码风格错误。

扩展创意

• 添加显示 API 示例用法的悬停信息。
• 使用诊断报告源代码中的拼写或 linter 错误。
• 为 HTML 注册新的代码格式化程序。
• 提供丰富、上下文感知的 IntelliSense。
• 为语言添加折叠、面包屑和概要支持。

工作台扩展

工作台扩展扩展了 VS Code 工作台 UI。可以向文件资源管理器添加新的右键单击操作，甚至可以使用 VS Code 的树状视图 API 构建自定义资源管理器。如果您的扩展需要完全定制的用户界面，可以使用Webview API 使用标准 HTML、CSS 和 JavaScript 构建自己的文档预览或 UI。

扩展创意

• 向文件资源管理器添加自定义上下文菜单操作。
• 在侧边栏中创建一个新的交互式树状视图。
• 定义新的活动栏视图。
• 在状态栏中显示新信息。
• 使用 WebView API 渲染自定义内容。
• 贡献源代码管理提供程序。

调试

您可以通过编写将 VS Code 的调试 UI 连接到特定调试器或运行时的调试器扩展来利用 VS Code 的调试功能。

扩展创意

• 通过贡献调试适配器实现来将 VS Code 的调试 UI 连接到调试器或运行时。
• 指定调试器扩展支持的语言。
• 为调试器使用的调试配置属性提供丰富的 IntelliSense 和悬停信息。
• 提供调试配置代码片段。

另一方面，VS Code 还提供了一组调试扩展 API，您可以使用它们在任何 VS Code 调试器之上实现与调试相关的功能，以自动化用户的调试体验。

扩展创意

• 基于动态创建的调试配置启动调试会话。
• 跟踪调试会话的生命周期。
• 以编程方式创建和管理断点。

用户体验指南

为了让您的扩展无缝融入 VS Code 用户界面，请参考用户体验指南，您将在其中了解创建扩展 UI 的最佳实践以及遵循首选 VS Code 工作流程的约定。

限制

我们对扩展施加了一些限制。以下是这些限制及其目的。

无 DOM 访问

扩展无法访问 VS Code UI 的 DOM。您不能编写一个对 VS Code 应用自定义 CSS 或向 VS Code UI 添加 HTML 元素的扩展。

在 VS Code 中，我们不断努力优化底层 Web 技术的使用，以提供始终可用、高度响应的编辑器，并且随着这些技术和产品的演进，我们将继续调整对 DOM 的使用。为了确保扩展不会干扰 VS Code 的稳定性和性能，并且我们可以在不破坏现有扩展的情况下继续改进 VS Code 的 DOM，我们在扩展宿主进程中运行扩展，并阻止直接访问 DOM。

无自定义样式表

用户或扩展提供的自定义样式表会与 DOM 结构和类名发生冲突。这些内容未被文档化，因为我们将其视为内部内容。为了演进、重构或改进 VS Code，我们需要自由地更改用户界面。对 DOM 的任何更改都可能破坏现有的自定义样式表，从而导致样式表提供者沮丧，并由于损坏的样式表导致 UI 故障，带来糟糕的用户体验。

相反，VS Code 旨在提供一个精心设计的扩展 API，支持 UI 定制。该 API 已被文档化，附带工具和示例，并且在 VS Code 所有即将发布的版本中保持稳定。