怎么发布自己的VS Code 插件
如果你已经开发好了一个 VS Code 插件,想让其他用户可以在 Visual Studio Code 插件市场中搜索、安装和使用,那么就需要将插件发布到 Visual Studio Code Marketplace。
整体流程并不复杂,主要分为两部分:
- 准备发布账号
- 打包并发布插件
下面我会按照实际操作流程,完整介绍如何把自己的插件发布到 VS Code Marketplace。
一、发布前需要准备什么?
在发布 VS Code 插件之前,需要准备以下内容:
- 一个 Microsoft 账号
- 一个 Azure DevOps 组织
- 一个用于发布插件的 Personal Access Token
- 一个 Marketplace Publisher 发布者账号
- 已开发完成的 VS Code 插件项目
- Node.js 环境
vsce命令行工具
VS Code 插件市场依赖 Microsoft 的 Azure DevOps 账号体系,所以发布插件前需要先完成账号和权限配置。
二、注册 Microsoft 账号
首先需要准备一个 Microsoft 账号。
如果你已经有 Outlook、Hotmail、Xbox、Azure 或 Microsoft 相关账号,可以直接使用。
如果没有,可以前往 Microsoft 官网注册一个新账号。
注册完成后,使用该账号登录后续的 Azure DevOps 和 Visual Studio Marketplace。
三、创建 Azure DevOps 组织
VS Code Marketplace 的插件发布权限需要依赖 Azure DevOps。
登录 Azure DevOps 后,创建一个新的组织。
组织名称可以根据个人或团队品牌来设置,例如:
wendingai
your-team-name
your-company-name
这里的组织主要用于生成发布插件所需的访问令牌,不一定要和插件发布者 ID 完全一致。
四、创建 Personal Access Token
创建 Azure DevOps 组织后,需要生成一个 Personal Access Token,简称 PAT。
这个 Token 用来授权 vsce 工具把插件发布到 Marketplace。
操作步骤如下:
- 登录 Azure DevOps
- 点击右上角头像
- 进入 User settings
- 选择 Personal access tokens
- 点击 New Token
- Scopes 选择 Custom defined
- 勾选:
Marketplace -> Manage
- 点击创建 Token
创建成功后,一定要马上复制并保存这个 Token。
需要注意:Personal Access Token 只会显示一次。关闭页面后无法再次查看,只能重新生成。
建议把 Token 保存到安全的位置,例如密码管理器,而不是直接写在代码仓库里。
五、注册 Marketplace Publisher
接下来需要创建一个插件发布者账号,也就是 Publisher。
进入 Visual Studio Marketplace Publisher Management 页面,使用 Microsoft 账号登录。
然后点击 Create publisher 创建发布者。
这里需要填写一个 Publisher ID,例如:
wendingai
futurestudio
my-vscode-tools
需要特别注意:
Publisher ID 创建后无法修改。
所以建议使用品牌名、公司名、产品名或长期可用的英文 ID,不要随便填写临时名称。
插件发布后,Marketplace 页面通常会显示类似这样的地址结构:
publisher-id.extension-name
例如:
wendingai.codex-switcher
因此 Publisher ID 对插件品牌展示也比较重要。
六、安装 vsce 发布工具
VS Code 官方推荐使用 vsce 工具来打包和发布插件。
vsce 的完整名称是:
Visual Studio Code Extensions
安装前需要先确保电脑已经安装 Node.js。
然后在终端中执行:
npm install -g @vscode/vsce
安装完成后,可以检查版本:
vsce --version
如果能正常输出版本号,说明安装成功。
七、检查插件项目配置
在发布之前,需要检查插件项目根目录下的 package.json。
重点关注以下字段:
{
"name":"your-extension-name",
"displayName":"Your Extension Display Name",
"description":"A short description of your extension",
"version":"0.0.1",
"publisher":"your-publisher-id",
"engines":{
"vscode":"^1.90.0"
},
"categories":[
"Other"
]
}
其中最重要的是:
| 字段 | 说明 |
|---|---|
name | 插件唯一名称,建议使用英文小写和短横线 |
displayName | 插件在市场中展示的名称 |
description | 插件简介 |
version | 插件版本号 |
publisher | 发布者 ID,需要和 Marketplace 中创建的 Publisher ID 一致 |
engines.vscode | 支持的 VS Code 最低版本 |
categories | 插件分类 |
如果 publisher 配置错误,发布时通常会失败。
八、登录 Publisher
进入插件项目根目录,在终端中执行:
vsce login <你的发布者ID>
例如:
vsce login wendingai
执行后,终端会提示输入 Personal Access Token。
把前面创建好的 PAT 粘贴进去即可。
如果登录成功,后续就可以直接打包和发布插件。
九、本地打包插件
正式发布前,建议先本地打包成 .vsix 文件进行测试。
执行:
vsce package
打包成功后,会在项目目录生成一个 .vsix 文件,例如:
your-extension-name-0.0.1.vsix
可以在 VS Code 中手动安装这个插件包进行测试。
安装方式:
- 打开 VS Code
- 进入 Extensions 插件面板
- 点击右上角
... - 选择 Install from VSIX
- 选择刚刚生成的
.vsix文件
这样可以在正式发布前确认插件能否正常安装和使用。
十、发布插件到 Marketplace
确认插件信息、功能和版本号都没有问题后,可以执行:
vsce publish
发布成功后,插件就会提交到 Visual Studio Code Marketplace。
通常等待一段时间后,就可以在 VS Code 插件市场中搜索到自己的插件。
如果是第一次发布,建议重点检查以下内容:
- 插件名称是否正确
- 图标是否正常显示
- README 是否美观
- 功能描述是否清晰
- 版本号是否正确
- 插件能否正常安装
- 插件运行是否报错
十一、更新插件版本
后续如果插件有新功能或修复了问题,需要再次发布新版本。
更新流程很简单:
- 修改代码
- 修改
package.json中的version - 重新发布
例如把版本号从:
"version":"0.0.1"
改成:
"version":"0.0.2"
然后执行:
vsce publish
也可以直接使用命令自动升级版本,例如:
vsce publish patch
常见版本升级方式:
vsce publish patch
vsce publish minor
vsce publish major
对应含义:
| 命令 | 示例 | 适合场景 |
|---|---|---|
patch | 0.0.1 → 0.0.2 | 修复 Bug、小改动 |
minor | 0.0.1 → 0.1.0 | 新增功能 |
major | 0.0.1 → 1.0.0 | 重大更新或不兼容变更 |
十二、发布前的优化建议
为了让插件在 Marketplace 中看起来更专业,建议发布前做好以下内容。
1. 写好 README
README 是用户了解插件的第一入口。
建议包含:
- 插件简介
- 核心功能
- 使用方法
- 配置说明
- 常见问题
- 更新日志
- 联系方式
- 截图或动图演示
一个好的 README 可以明显提高插件的安装转化率。
2. 准备清晰的插件图标
插件图标建议使用简洁、清晰、有品牌识别度的设计。
通常可以在 package.json 中配置:
"icon":"images/icon.png"
图标建议尺寸为:
128x128
3. 补充 keywords
可以在 package.json 中添加关键词,帮助用户搜索到插件。
例如:
"keywords":[
"codex",
"openai",
"api",
"ai",
"vscode",
"developer tools"
]
关键词建议和插件真实功能相关,不要堆砌无关词。
4. 注意不要提交敏感信息
发布前一定要检查项目中是否包含:
- API Key
- Token
- 私有接口密钥
.env文件- 测试账号密码
- 内部接口地址
- 无关日志文件
可以通过 .vscodeignore 排除不需要发布的文件。
示例:
.env
.env.local
node_modules
src
test
.vscode
.git
.github
*.log
十三、常见问题
1. PAT 忘记保存怎么办?
只能重新创建一个新的 Personal Access Token。
旧 Token 如果不再使用,建议删除,避免安全风险。
2. Publisher ID 可以修改吗?
不可以。
Publisher ID 创建后无法修改,所以创建时要慎重。
3. 插件发布后多久能搜索到?
通常不会太久,但 Marketplace 搜索索引可能存在延迟。
发布成功后可以先通过插件详情页链接访问,搜索结果稍后再检查。
4. 发布失败怎么办?
常见原因包括:
publisher字段不正确- PAT 权限不够
- 插件版本号没有变化
- README 或 package.json 配置不规范
- 插件名称已被占用
- 网络连接异常
建议根据终端报错信息逐项排查。
十四、总结
发布 VS Code 插件的核心流程可以概括为:
注册 Microsoft 账号
创建 Azure DevOps 组织
生成 Personal Access Token
创建 Marketplace Publisher
安装 vsce
配置 package.json
本地打包测试
发布到 Marketplace
VS Code 插件发布并不复杂。真正需要注意的是账号权限、Publisher ID、插件配置、README 展示和版本管理。
如果只是个人插件,按照上面的流程就可以完成发布。
如果是企业或团队插件,建议提前规划好 Publisher ID、品牌名称、图标、文档、更新节奏和安全规范,这样后续维护会更加稳定,也更有利于插件长期运营。
夜雨聆风