1. 准备开发环境

  • 安装 Node.js 和 npm
  • 安装 VSCode
  • 安装 Yeoman 和 VSCode Extension Generator

2. 创建插件项目

打开终端，运行以下命令：

1
2
npm install -g yo generator-code
yo code

按照提示设置你的插件项目。

3. 了解插件结构

主要文件包括：

  • package.json：插件的配置文件
  • extension.ts：插件的主要代码
  • README.md：插件的说明文档

4. 编写插件代码

在 extension.ts 中实现你的插件功能。

开发过程中可以安装推荐的几个vscode插件(.vscode\extensions.json)

5. 调试和测试

使用 VSCode 的调试功能来测试你的插件。

  • 按下F5后查看调试控制台可以看到日志输出
  • 直接在编辑器里打断点,调用栈里查看变量和其他信息
  • yo脚手架生成的代码已经实现了热重载,更新代码后只需要reload(快捷键:ctrl+shift+r)一下调试窗口即可

6. 发布插件

发布扩展 | Visual Studio 代码扩展 API — Publishing Extensions | Visual Studio Code Extension API

使用 vsce 工具打包并发布到 VSCode 市场。

  • 全局安装vsce

    1
    npm install -g @vscode/vsce

  • 打包插件生成name.vsix文件

    1
    vsce package

  • 发布插件

    1. 用微软账户登录dev.azure.com

    2. 创建token

    3. 创建发布者

      用和Azure DevOps登录的微软账户同一个微软账户登录在浏览器里直接访问链接创建https://marketplace.visualstudio.com/manage

    4. 登录一下发布者账号

      妈的报错了说要密码

      再试了一次就可以了

    5. 自动发布插件

      1
      vsce publish

      自动增加扩展版本

      发布扩展时，您可以通过指定要递增的SemVer兼容号或版本（ major 、 minor或patch ）来自动递增其版本号。例如，要将扩展的版本从 1.0.0 更新到 1.1.0，您可以指定：

      1
      vsce publish minor

      或者

      1
      vsce publish 1.1.0

      这两个命令都会首先修改扩展的package.json版本属性，然后使用更新后的版本进行发布。

      注意：如果您在 git 存储库中运行vsce publish ，它还将通过npm-version创建版本提交和标记。默认提交消息将是扩展的版本，但您可以使用-m标志提供自定义提交消息。 （可以使用%s从提交消息中引用当前版本）。

    6. 手动发布插件

      使用vsce package将扩展打包成可安装的 VSIX 格式，然后上传到Visual Studio Marketplace 发布者管理页面

      https://code.visualstudio.com/assets/api/working-with-extensions/publishing-extension/add-extension.png

7. 插件配置详解