发布扩展

Name: Visual Studio Code
Author: Microsoft

制作出高质量的扩展后，您可以将其发布到 VS Code 扩展市场，以便他人查找、下载和使用您的扩展。此外，您还可以将扩展打包成可安装的 VSIX 格式，并与其他用户共享。

本主题涵盖

使用 vsce，用于管理 VS Code 扩展的命令行工具
打包、发布和取消发布扩展
注册发布者，发布扩展的必要步骤

vsce

vsce（Visual Studio Code Extensions 的缩写）是一个用于打包、发布和管理 VS Code 扩展的命令行工具。

安装

确保您已安装 Node.js。然后运行

npm install -g @vscode/vsce

用法

您可以使用 vsce 轻松打包和发布您的扩展。

$ cd myExtension
$ vsce package
# myExtension.vsix generated
$ vsce publish
# <publisher id>.myExtension published to VS Code Marketplace

vsce 还可以搜索、检索元数据和取消发布扩展。有关所有可用 vsce 命令的参考，请运行 vsce --help。

发布扩展

注意

出于安全考虑，vsce 不会发布包含用户提供的 SVG 图像的扩展。

发布工具会检查以下约束条件：

package.json 中提供的图标不得为 SVG。
package.json 中提供的徽章不得为 SVG，除非它们来自受信任的徽章提供者。
README.md 和 CHANGELOG.md 中的图像 URL 需要解析为 https URL。
README.md 和 CHANGELOG.md 中的图像不得为 SVG，除非它们来自受信任的徽章提供者。

Visual Studio Code 使用 Azure DevOps 作为其市场服务。这意味着通过 Azure DevOps 提供身份验证、托管和扩展管理。

vsce 只能使用个人访问令牌发布扩展。您至少需要创建一个才能发布扩展。

获取个人访问令牌

您可以通过 Azure DevOps 门户创建个人访问令牌。要创建个人访问令牌，请按照以下步骤操作：

如果您还没有 Azure DevOps 组织，请遵循创建组织文章中的步骤。
转到 Azure DevOps 门户，并选择您的组织。
在个人资料图片旁打开“用户设置”下拉菜单，然后选择“个人访问令牌”。
在“个人访问令牌”页面上，选择“新建令牌”。
在“创建新的个人访问令牌”模态框中，为令牌选择以下详细信息：
- 名称：您为令牌选择的任何名称。
- 组织：所有可访问的组织。
- 过期（可选）：设置令牌所需的过期日期。
- 范围：自定义定义。
  - 点击“范围”部分下方的“显示所有范围”链接。
  - 在“范围”列表中，滚动到“市场”并选择“管理”范围。
点击“创建”。

您将看到新创建的个人访问令牌。请将其“复制”到一个安全的位置，您在创建发布者时将需要它。

创建发布者

发布者是能够将扩展发布到 Visual Studio Code 市场中的一个身份。每个扩展都必须在其 package.json 文件中包含一个 publisher 标识符。

要创建发布者，请按照以下步骤操作：

转到 Visual Studio 市场发布者管理页面。
使用您用于在上一步中创建个人访问令牌的相同 Microsoft 帐户登录。
在左侧窗格中，点击“创建发布者”。
在新页面中，指定新发布者的必填参数：标识符和名称（分别对应“ID”和“名称”字段）。
- ID：您发布者在市场中的唯一标识符，将用于您的扩展 URL。ID 创建后无法更改。
- 名称：您发布者的唯一名称，将在市场中与您的扩展一起显示。可以是您的公司或品牌名称。
以下是 Python 扩展的发布者标识符和名称示例：
（可选）填写其余字段。
点击“创建”。

使用 vsce 验证新创建的发布者。在终端中，运行以下命令，并在提示时输入上一步创建的个人访问令牌：

vsce login <publisher id>

https://marketplace.visualstudio.com/manage/publishers/
Personal Access Token for publisher '<publisher id>': ****************************************************

The Personal Access Token verification succeeded for the publisher '<publisher id>'.

验证成功后，您就可以发布扩展了。

发布扩展

您可以通过两种方式发布扩展：

自动发布，使用 vsce publish 命令。
```
vsce publish
```
如果您尚未通过上面的 vsce login 命令提供个人访问令牌，vsce 将会要求提供。
手动发布，使用 vsce package 将扩展打包成可安装的 VSIX 格式，然后将其上传到 Visual Studio 市场发布者管理页面。

查看扩展安装和评分

Visual Studio 市场发布者管理页面可让您查看每个扩展随时间的“获取趋势”以及“总获取量”和“评分与评论”。要查看报告，请点击扩展，或选择“更多操作 > 报告”。

Marketplace extension report

自动递增扩展版本

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

vsce publish minor

或

vsce publish 1.1.0

这两个命令都会先修改扩展 package.json 中的 version 属性，然后以更新后的版本发布它。

注意

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

取消发布扩展

您可以通过在 Visual Studio 市场发布者管理页面上点击“更多操作 > 取消发布”来取消发布扩展。

Unpublish the extension via the Marketplace management page

取消发布后，扩展的可用性状态将更改为“已取消发布”，它将不再可从市场和 Visual Studio Code 下载。

Unpublished extension

注意

取消发布扩展时，市场会保留扩展的统计信息。扩展仍然可公开发现，并通过现有 API 提供。

移除扩展

您可以通过两种方式移除扩展：

自动移除，使用 vsce 和 unpublish 命令。

vsce unpublish <publisher id>.<extension name>

手动移除，从 Visual Studio 市场发布者管理页面上点击“更多操作 > 移除”。

在这两种情况下，您都将被提示通过输入扩展名来确认移除。请注意，移除操作是不可逆的。

注意

移除扩展时，市场也会移除所有扩展统计信息。您可能希望取消发布扩展而不是移除它。

弃用扩展

您可以仅弃用一个扩展，或弃用一个扩展并推荐另一个扩展或设置。被弃用的扩展将在 UI 中以变灰的删除线文本显示。

Rust extension shown as deprecated in extension search

每个被弃用的扩展在其磁贴的右下角都有一个黄色警告图标（参见上图）。将鼠标悬停在扩展磁贴上时，您可以在此图标旁边看到弃用详情，例如：

该扩展在没有任何替代项的情况下被弃用。
该扩展被弃用并推荐了另一个扩展。
该扩展被弃用并推荐了一个设置。

VS Code 不会自动迁移或卸载已安装的被弃用扩展。如果被弃用的扩展有替代扩展或设置，VS Code 将显示一个“迁移”按钮，以帮助您快速切换到指定的替代项。

要将您的扩展标记为已弃用，请在弃用扩展讨论帖中留言。

注意

目前，扩展在市场中不会显示为已弃用。此功能将在稍后提供。

打包扩展

如果您想...

在您的 VS Code 实例上进行测试。
在不发布到市场的情况下进行分发。
私下与他人共享。

打包意味着创建一个包含您的扩展的 .vsix 文件。然后该文件可以在 VS Code 中安装。一些扩展会将 .vsix 文件作为其 GitHub 发布的一部分。

要打包扩展，请在扩展的根文件夹中运行以下命令：

vsce package

此命令会在您的扩展根文件夹中创建一个 .vsix 文件。例如，my-extension-0.0.1.vsix。

用户安装 .vsix 文件到 VS Code 的方法：

从 VS Code 的扩展视图
1. 转到“扩展”视图。
2. 选择“视图和更多操作...”。
3. 选择“从 VSIX 安装...”。

从命令行

# if you use VS Code
code --install-extension my-extension-0.0.1.vsix

# if you use VS Code Insiders
code-insiders --install-extension my-extension-0.0.1.vsix

您的扩展文件夹

要加载扩展，您需要将文件复制到 VS Code 的扩展文件夹 .vscode/extensions。根据您的操作系统，此文件夹的位置不同：

Windows： %USERPROFILE%\.vscode\extensions
macOS： ~/.vscode/extensions
Linux： ~/.vscode/extensions

Visual Studio Code 兼容性

编写扩展时，您必须指定扩展兼容的 VS Code 版本。为此，请在 package.json 中使用 engines.vscode 属性。

{
  "engines": {
    "vscode": "^1.8.0"
  }
}

值为 1.8.0（不带插入符号）表示您的扩展仅兼容 VS Code 1.8.0。
值为 ^1.8.0 表示您的扩展兼容 VS Code 1.8.0 及更高版本，包括 1.8.1、1.9.0 等。

您可以使用 engines.vscode 属性来确保扩展仅安装在包含您所依赖 API 的客户端上。此机制对 Stable 和 Insiders 版本都适用。

例如，假设 VS Code 的最新稳定版本是 1.8.0。在开发版本 1.9.0 时，引入了一个新 API，并通过版本 1.9.0-insider 在 Insider 版本中可用。如果您想发布一个利用此 API 的扩展版本，您应该将版本依赖指定为 ^1.9.0。这样，您的新扩展版本将仅在 VS Code >=1.9.0（换句话说，具有当前 Insiders 版本的用户）上可用。VS Code 稳定版用户只有在稳定版达到 1.9.0 版本时才能获得更新。

高级用法

市场集成

您可以自定义扩展在 Visual Studio 市场中的外观。例如，请参阅 Go 扩展。

以下是一些让您的扩展在市场中脱颖而出的技巧：

在扩展的根目录中添加一个 README.md 文件，其中包含您想在扩展的市场页面上显示的内容。

注意
如果您的 package.json 中有一个指向公共 GitHub 存储库的 repository 属性，vsce 将自动检测它并相应地调整相对链接，默认使用 main 分支。您可以使用 --githubBranch 标志在运行 vsce package 或 vsce publish 时覆盖它。您还可以使用 --baseContentUrl 和 --baseImagesUrl 标志设置链接和图像的基础 URL。
在扩展的根目录中添加一个 LICENSE 文件，其中包含有关扩展许可的信息。
在扩展的根目录中添加一个 CHANGELOG.md 文件，其中包含有关扩展更改历史的信息。
在扩展的根目录中添加一个 SUPPORT.md 文件，其中包含有关如何获取扩展支持的信息。
通过在 package.json 中通过 galleryBanner.color 属性指定相应的十六进制值，来设置市场页面的横幅背景色。
通过在 package.json 中通过 icon 属性指定一个指向您扩展中包含的最小为 128x128px 的 PNG 文件的相对路径，来设置图标。

有关更多信息，请参阅市场展示技巧。

验证发布者

您可以通过验证与您的品牌或身份相关联的合格域名的所有权来成为已验证发布者。一旦您的发布者获得验证，市场将在您的扩展详情中添加一个已验证徽章。

先决条件

要获得验证，发布者必须在 VS 市场中拥有至少一个扩展至少 6 个月，并且域名的注册也必须至少有 6 个月。请在申请验证之前等待这些条件满足。

Verified publisher indicators in VS Code

要验证发布者，请按照以下步骤操作：

转到 Visual Studio 市场发布者管理页面。
在左侧窗格中，选择或创建您要验证的发布者。
在主窗格中，选择“详情”选项卡。
在“详情”选项卡中，“已验证域名”部分，输入一个合格域名。

注意：在开始输入后，请注意“详情”选项卡标题旁会出现一个星号（*）。与 VS Code 一样，这表示您有未保存的更改。出于同样的原因，“验证”按钮目前是禁用的。
选择“保存”，然后选择“验证”。

将出现一个对话框，提供有关将 TXT 记录添加到您的域 DNS 配置的说明。
按照说明将 TXT 记录添加到您的域 DNS 配置中。
在对话框中选择“验证”，以确认 TXT 记录已成功添加。

一旦您的 TXT 记录得到验证，市场团队将审查您的请求，并在 5 个工作日内告知您结果。验证包括但不限于：域名、网站和扩展获得可信记录的先决条件、内容资格、合法性、信任度和积极声誉。

如果验证通过，您将在 Visual Studio 市场发布者管理页面的发布者名称旁边看到相应的徽章。

Verified publisher manage

备注:

对发布者显示名称的任何更改都将撤销已验证徽章。

发布者未来的任何使用条款或上述验证违规行为都将撤销已验证徽章。

合格域名

合格域名满足以下标准：

您必须能够管理 DNS 配置设置并添加 TXT 记录。
它不能是子域名（例如 {subdomain}.github.io、{subdomain}.contoso.com 或类似）。
它必须使用 HTTPS 协议。
它必须能够通过 HEAD 请求以 HTTP 200 状态码响应。

扩展定价标签

您可以选择在扩展的市场页面上显示定价标签，以表明它是 免费 或 免费试用。

要显示定价标签，请在 package.json 中添加 pricing 属性。例如：

{
  "pricing": "Free"
}

允许的值为：Free 和 Trial（区分大小写）。当未指定 pricing 属性时，默认值为 Free。

注意

发布扩展时，请确保使用 vsce 版本 >= 2.10.0，以使定价标签生效。

您可以选择开启赞助，为用户提供支持您工作的方式。

要显示赞助链接，请在 package.json 中添加 sponsor 属性。例如：

"sponsor": {
  "url": "https://github.com/sponsors/nvaccess"
}

注意

发布扩展时，请确保使用 vsce 版本 >= 2.9.1，以使赞助功能生效。

赞助链接将显示在扩展的市场页面和 VS Code 扩展详情页面的标题中。

Sponsor link in extension details page

我们希望这将使我们的用户能够资助他们赖以改进扩展性能、可靠性和稳定性的扩展。

使用 .vscodeignore

您可以创建一个 .vscodeignore 文件，以防止某些文件被包含在扩展包中。此文件是 glob 模式的集合，每行一个。例如：

**/*.ts
**/tsconfig.json
!file.ts

您应该忽略所有运行时不需要的文件。例如，如果您的扩展是用 TypeScript 编写的，则应忽略所有 **/*.ts 文件，如上面的示例所示。

注意

devDependencies 中列出的开发依赖项将自动被忽略，因此您无需显式添加它们。

发布前步骤

您可以在清单文件中添加一个发布前步骤，该步骤将在每次打包扩展时被调用。例如，您可能希望在此阶段调用 TypeScript 编译器。

{
  "name": "uuid",
  "version": "0.0.1",
  "publisher": "someone",
  "engines": {
    "vscode": "0.10.x"
  },
  "scripts": {
    "vscode:prepublish": "tsc"
  }
}

预发布扩展

用户可以在 VS Code 或 VS Code Insiders 中安装扩展的预发布版本，以便在官方扩展发布前定期获取最新的扩展版本。

GitHub PR extension pre-release version in the extensions view

要发布预发布版本，请将 --pre-release 标志传递给 vsce package 或 vsce publish 命令。

vsce package --pre-release
vsce publish --pre-release

我们仅支持 major.minor.patch 作为扩展版本，不支持 semver 预发布标签。预发布和常规版本之间的版本必须不同。也就是说，如果 1.2.3 作为预发布版本上传，那么下一个常规版本必须使用不同的版本上传，例如 1.2.4。完整的 semver 支持将在未来提供。

VS Code 将自动更新扩展到可用的最高版本，因此即使用户选择了预发布版本，并且存在更高版本的扩展发布，用户也会更新到已发布的版本。因此，我们建议扩展使用 major.EVEN_NUMBER.patch 作为发布版本，使用 major.ODD_NUMBER.patch 作为预发布版本。例如：发布版本为 0.2.*，预发布版本为 0.3.*。

如果扩展作者不希望其预发布用户更新到发布版本，我们建议在发布发布版本之前始终递增并发布一个新的预发布版本，以确保预发布版本始终更高。请注意，虽然预发布用户将更新到更高的发布版本，但他们仍然有资格自动更新到比发布版本更高的未来预发布版本。

预发布扩展支持 VS Code 版本 1.63.0 之后，因此所有预发布扩展在其 package.json 中的 engines.vscode 值都应设置为 >= 1.63.0。

注意

已经拥有独立预发布扩展的扩展应联系 VS Code 团队，以启用对旧独立扩展的自动卸载，并安装主扩展的预发布版本。

特定平台扩展

您可以为 VS Code 运行的每个平台（Windows、Linux、macOS）发布扩展的 VSIX 包。我们称这些扩展为特定平台扩展。

从版本 1.61.0 开始，VS Code 会查找与当前平台匹配的扩展包。

如果您的扩展包含特定平台的库或依赖项，则特定平台扩展非常有用，这样您可以控制包含在平台包中的确切二进制文件。一个常见的用例是使用原生 node 模块。

特定平台扩展被发布为包含特定平台内容的独立包。您可以通过传递 --target 标志来指定目标平台。如果您不传递此标志，该包将用作没有特定平台包的所有平台的备用。

目前可用的平台有：win32-x64、win32-arm64、linux-x64、linux-arm64、linux-armhf、alpine-x64、alpine-arm64、darwin-x64、darwin-arm64 和 web。

如果您希望特定平台扩展也能在浏览器中作为 Web 扩展运行，那么在发布时必须将其目标平台设置为 web。web 平台遵循 package.json 中的 browser 入口点。为避免在 web 中不支持的扩展功能，我们建议使用 package.json 中的 when 子句，而不是为 web 平台分发单独的 package.json 或移除 VSIX 中在 web 中无法工作的部分。

发布

从版本 1.99.0 开始，vsce 支持 --target 参数，该参数允许您在打包和发布 VSIX 时指定目标平台。

以下是如何为 win32-x64 和 win32-arm64 平台发布 VSIX：

vsce publish --target win32-x64 win32-arm64

或者，您也可以在使用 --target 标志打包时创建特定平台 VSIX。例如，打包一个针对 win32-x64 平台的 VSIX，然后进行发布：

vsce package --target win32-x64
vsce publish --packagePath PATH_TO_WIN32X64_VSIX

持续集成

管理多个特定平台 VSIX 可能会变得繁琐，因此我们建议使用持续集成 (CI) 工具来自动化您的扩展构建过程。例如，您可以使用 GitHub Actions 来构建您的扩展。我们的特定平台扩展示例可用作学习的起点：其工作流启用了使用特定平台扩展支持的常见场景，以便在所有受支持的 VS Code 目标平台上分发原生 node 模块作为依赖项。

后续步骤

扩展市场 - 了解更多关于 VS Code 公共扩展市场的信息。
测试扩展 - 为您的扩展项目添加测试，以确保高质量。
捆绑扩展 - 使用 webpack 捆绑扩展文件以提高加载速度。

常见问题

当我尝试发布扩展时，收到“您已超出允许的 30 个标签数”的错误？

Visual Studio 市场不允许扩展包在 package.json 中包含超过 30 个 keywords。将关键字/标签数量限制为最多 30 个，以避免此错误。

当我尝试发布扩展时，收到 403 Forbidden (或 401 Unauthorized) 错误？

创建 PAT（个人访问令牌）时容易犯的一个错误是在“组织”字段下拉菜单中选择一个特定组织，而不是所有可访问的组织。另一个可能的错误是范围不正确 - 您应该将授权范围设置为 Marketplace (Manage) 才能使发布生效。

我无法通过 `vsce` 工具取消发布我的扩展？

您可能更改了扩展 ID 或发布者 ID。您也可以直接通过 Visual Studio 市场发布者管理页面管理您的扩展。例如，更新或取消发布。

为什么 vsce 不保留文件属性？

请注意，当在 Windows 上构建和发布扩展时，包含在扩展包中的所有文件都将缺少 POSIX 文件属性，即可执行位。某些 node_modules 依赖项依赖这些属性才能正常工作。从 Linux 和 macOS 发布工作正常。

我可以在持续集成 (CI) 构建中发布吗？

是的，请参阅持续集成主题的“自动发布”部分，了解如何配置 Azure DevOps、GitHub Actions 和 GitLab CI 以自动将您的扩展发布到市场。

当我尝试发布扩展时，收到“错误：市场中已存在名为 'name' 的扩展”的错误？

市场要求每个扩展的扩展名称都是唯一的。如果市场中已存在同名扩展，您将收到以下错误：

ERROR The extension 'name' already exists in the Marketplace.

相同的规则也适用于扩展的显示名称。

支持哪些包管理器？

您可以使用 npm 或 yarn v1 来管理扩展的依赖项。

我需要有关我的 VS 市场帐户的帮助或发布扩展的支持？

您可以登录管理发布者和扩展，然后点击右上角的“联系 Microsoft”链接，与 VS 市场支持团队联系。

02/04/2026

发布扩展

vsce

安装

用法

发布扩展

获取个人访问令牌

创建发布者

发布扩展

查看扩展安装和评分

自动递增扩展版本

取消发布扩展

移除扩展

弃用扩展

打包扩展

您的扩展文件夹

Visual Studio Code 兼容性

高级用法

市场集成

验证发布者

先决条件

合格域名

扩展定价标签

扩展赞助

使用 .vscodeignore

发布前步骤

预发布扩展

特定平台扩展

发布

持续集成

后续步骤

常见问题

当我尝试发布扩展时，收到“您已超出允许的 30 个标签数”的错误？

当我尝试发布扩展时，收到 403 Forbidden (或 401 Unauthorized) 错误？

我无法通过 vsce 工具取消发布我的扩展？

为什么 vsce 不保留文件属性？

我可以在持续集成 (CI) 构建中发布吗？

当我尝试发布扩展时，收到“错误：市场中已存在名为 'name' 的扩展”的错误？

支持哪些包管理器？

我需要有关我的 VS 市场帐户的帮助或发布扩展的支持？

我无法通过 `vsce` 工具取消发布我的扩展？