【保姆级VSCode 插件开发之插件打包发布和安装】

保姆级VSCode 插件开发

第一章 VSCode 插件开发入门之插件打包，发布和安装

---

---

前言

本篇文章主要介绍VSCode插件打包发布和安装。

---

一、HelloWorld 插件项目打包发布和安装

1.插件打包和安装

1.1 打包

• vsce 工具：Visual Studio Code Extension Manager 的命令行工具，用于打包、发布和管理 VSCode 插件。简化了 VSCode 插件的打包和发布过程，可以实现一键打包。可通过 npm install -g vsce 全局安装

• 打包：当插件开发完成并经过测试后，使用 vsce 工具打包插件为.vsix 文件。
  在cmd命令行中进入项目目录，然后输入命令：

  vsce package
  

  忽略WARNING提示，如下图所示。打包完成。可以在文件夹中找到对应插件的.vsix文件。
  

• 但是这一步一般会有一个错误提示： ERROR Make sure to edit the README.md file before you package or publish your extension.
  

  • 原因分析：README.md文件中需要编辑，这个检查条件是README.md文件中不能检查到含有README字符串
  • 解决方案：只需要将README替换成空即可（如果只是测试，也可以简单输入命令 echo this is not useful > READMD.md，用 this is not useful替换掉全部内容）。
  • 说明：当然如果要正式发布到MarketPlace就需要完整填写 README.md 文件，方便使用者通过此文件了解插件的基本信息。

1.2 安装

如下图所示，第三步 install from VSIX 中选择对应的.vsix文件，即可安装插件。

2. 插件发布

一般如果插件开发出来自己用或者分享给同事用，就不用发布到VSCode Marketplace。

• 发布：需要拥有 VSCode Marketplace 账户，可以使用 vsce publish 命令将打包好的插件发布到市场供其他用户安装。如果没有账户，需要先注册并创建一个publisher。

---

总结

今天的主要内容是VSCode插件开发中的插件打包安装和发布。后面会继续介绍插件中不同功能的实现。