扩展功能概述

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 和代码透视。这些语言特性通过 vscode.languages.* API 暴露。扩展可以直接使用这些 API，或者编写语言服务器并使用 VS Code 语言服务器库将其适配到 VS Code。

虽然我们提供了 语言特性 及其预期用途的列表，但没有任何限制阻止您创造性地使用这些 API。例如，代码透视和悬停提示是呈现附加内联信息的绝佳方式，而诊断错误可用于突出显示拼写或代码风格错误。

扩展创意

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

工作台扩展

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

扩展创意

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

调试

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

扩展创意

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

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

扩展创意

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

用户体验指南

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

限制

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

禁止访问 DOM

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

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

禁止自定义样式表

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

相反，VS Code 旨在提供支持 UI 定制的一个设计良好的扩展 API。该 API 已记录，带有工具和示例，并且在 VS Code 的所有未来版本中都保持稳定。