VS Code 扩展开发是使用 JavaScript 或 TypeScript 创建插件来增强编辑器功能的过程。扩展可以添加新语言支持、调试器、主题、代码片段等功能。
开发环境准备
- 安装 Node.js(推荐使用 LTS 版本)
- 安装 Yeoman 和 VS Code 扩展生成器:
bashnpm install -g yo generator-code
- 使用生成器创建扩展项目:
bashyo code
核心概念
package.json
扩展的配置文件,定义扩展的基本信息、激活事件、贡献点等。
activationEvents
定义何时激活扩展,例如:
onCommand:extension.sayHello- 当执行命令时onLanguage:javascript- 当打开特定语言文件时*- 启动时激活(不推荐)
contributes
定义扩展对 VS Code 的贡献,包括命令、视图、配置等。
常用 API
vscode.commands- 注册和执行命令vscode.window- 操作窗口和 UIvscode.workspace- 访问工作区vscode.languages- 语言功能支持
开发流程
- 使用生成器创建项目
- 在
extension.ts中实现功能 - 按 F5 启动调试
- 在扩展开发宿主中测试
- 打包发布到 VS Code 市场
注意事项
- 使用 TypeScript 可以获得更好的类型支持
- 遵循 VS Code 扩展开发最佳实践
- 测试不同场景下的扩展行为
- 优化扩展性能,避免阻塞主线程