本站点文档内容均翻译自code.visualstudio.com,仅供个人学习,如有差异请以官网为准。

扩展指南

一旦你掌握了Visual Studio Code扩展API的基础知识在Hello World示例中,是时候开始构建一些真实的扩展了。虽然扩展功能部分提供了扩展可以做什么的高级概述,但本部分包含详细的代码指南和示例,解释如何使用特定的VS Code API。

在每份指南或样本中,您可以期望找到:

  • 详细注释的源代码。
  • 一个显示如何使用示例扩展的GIF或图像。
  • 运行示例扩展的说明。
  • 正在使用的 VS Code API 列表。
  • 正在使用的贡献点列表。
  • 现实世界的扩展类似于示例。
  • API概念解释。

指南和样本

以下是 VS Code 网站上的指南,包括 VS Code API贡献点 的使用方法。别忘了参考 用户体验指南 以了解创建扩展的最佳用户界面实践。

VS Code 网站指南 API & 贡献
命令 命令
贡献命令
颜色主题 贡献主题。
文件图标主题 贡献者.图标主题
产品图标主题 贡献产品图标主题
树视图 Windows创建树视图
Windows注册树数据提供者
树视图
树数据提供者
贡献视图
贡献视图容器
网页视图 Windows创建网页视图面板
Windows注册网页视图面板序列化器
自定义编辑器 Windows注册自定义编辑器提供者
自定义文本编辑器提供者
贡献的自定义编辑器
虚拟文件 工作区注册文本文档内容提供者
命令注册命令
Windows显示输入框
虚拟工作区 工作区.fs
功能.虚拟工作区
工作区信任 工作区.是否受信任
工作区.授予工作区信任时
功能.不受信任的工作区
任务提供者 注册任务提供程序
任务
壳脚本执行
贡献任务定义
源代码管理 工作区.工作区文件夹
源控制
源控制资源组
scm.创建源控制
文本文档内容提供者
贡献.菜单
调试器扩展 contributes.breakpoints
contributes.debuggers
调试
Markdown 扩展 markdown.预览样式
markdown.markdownIt插件
markdown.预览脚本
测试扩展 测试控制器
测试项目
自定义数据扩展 contributes.html.customData
contributes.css.customData

以下是来自VS Code 扩展示例库的更多示例列表。

在 GitHub 仓库上查看示例 API & 贡献
网页视图示例 Windows创建网页视图面板
Windows注册网页视图面板序列化器
状态栏示例 Windows创建状态栏项
状态栏项
树视图示例 Windows创建树视图
Windows注册树数据提供者
树视图
树数据提供者
贡献视图
贡献视图容器
任务提供者样本 注册任务提供程序
任务
壳脚本执行
贡献任务定义
多根样本 工作区获取工作区文件夹
工作区工作区文件夹更改时
完成提供者示例 语言注册完成项提供程序
完成项
片段字符串
文件系统提供者示例 工作区注册文件系统提供者
编辑器装饰器示例 文本编辑器设置装饰
装饰选项
装饰实例渲染选项
可主题装饰实例渲染选项
Windows创建文本编辑器装饰类型
文本编辑器装饰类型
贡献颜色
L10N 样本
终端样本 Windows创建终端
Windows更改活动终端
Windows关闭终端
Windows打开终端
Windows.终端
Windows.终端列表
Vim 示例 命令
状态栏项
Windows创建状态栏项
文本编辑器光标样式
Windows活动文本编辑器
位置
范围
选择
文本编辑器
文本编辑器显示类型
文本文档
源代码控制示例 工作区.工作区文件夹
源控制
源控制资源组
scm.创建源控制
文本文档内容提供者
贡献.菜单
评论 API 示例
文档编辑示例 命令
贡献命令
入门示例 贡献。指导手册
测试扩展 测试控制器
测试项目

语言扩展示例

这些示例是语言扩展示例:

样本 VS Code 网站指南
片段样本 /api/语言扩展/片段指南
语言配置示例 /api/语言扩展/语言配置指南
LSP 样品 /api/语言扩展/语言服务器扩展指南
LSP日志流示例 不适用
LSP 多根服务器示例 https://github.com/microsoft/vscode/wiki/Adopting-Multi-Root-Workspace-APIs#language-client--language-server (GitHub 代码库 维基)
LSP 网络扩展示例 /api/语言扩展/语言服务器扩展指南