扩展功能概述

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

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

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

常用功能

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

其中一些功能包括

• 注册命令、配置、快捷键或上下文菜单项。
• 存储工作区或全局数据。
• 显示通知消息。
• 使用快速选择来收集用户输入。
• 打开系统文件选择器，让用户选择文件或文件夹。
• 使用进度 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 的 TreeView API 构建自定义资源管理器。如果您的扩展需要完全自定义的用户界面，请使用 Webview API，使用标准的 HTML、CSS 和 JavaScript 构建您自己的文档预览或 UI。

扩展创意

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

调试

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

扩展创意

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

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

扩展创意

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

用户体验指南

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

限制

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

无 DOM 访问

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

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

无自定义样式表

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

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