扩展功能概述
Visual Studio Code 提供了多种方式让扩展程序扩展其功能。有时可能很难找到正确的贡献点和VS Code API来使用。本主题将扩展功能分为几个类别。每个类别描述了:
- 您的扩展程序可以使用的一些功能
- 指向更详细主题的链接,用于使用这些功能
- 一些扩展想法
但是,我们也会对扩展程序施加限制,以确保 VS Code 的稳定性和性能。例如,扩展程序无法访问 VS Code UI 的 DOM。
常用功能
常用功能是您可以在任何扩展程序中使用的核心功能。
其中一些功能包括:
- 注册命令、配置、快捷键或上下文菜单项。
- 存储工作区或全局数据。
- 显示通知消息。
- 使用 Quick Pick 收集用户输入。
- 打开系统文件选择器,让用户选择文件或文件夹。
- 使用 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 的TreeView API 构建自定义资源管理器。如果您的扩展需要完全自定义的用户界面,请使用Webview API来使用标准 HTML、CSS 和 JavaScript 构建您自己的文档预览或 UI。
扩展想法
- 为文件资源管理器添加自定义上下文菜单操作。
- 在侧边栏中创建一个新的交互式 TreeView。
- 定义新的活动栏视图。
- 在状态栏中显示新信息。
- 使用
WebView
API 渲染自定义内容。 - 贡献源代码管理提供程序。
调试
您可以通过编写调试器扩展来利用 VS Code 的调试功能,这些扩展将 VS Code 的调试 UI 连接到特定的调试器或运行时。
扩展想法
- 通过贡献调试适配器实现,将 VS Code 的调试 UI 连接到调试器或运行时。
- 指定调试器扩展支持的语言。
- 为调试器使用的调试配置属性提供丰富的 IntelliSense 和悬停信息。
- 提供调试配置片段。
另一方面,VS Code 还提供了一套调试扩展 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 旨在提供一个精心设计的扩展 API,支持 UI 自定义。该 API 已被文档化,附带工具和示例,并在 VS Code 的所有即将发布的版本中保持稳定。