尝试在 VS Code 中使用

扩展市场

Visual Studio Code 内置的功能只是个开始。VS Code 扩展允许您向安装中添加语言、调试器和工具,以支持您的开发工作流程。VS Code 丰富的扩展模型允许扩展作者直接插入 VS Code UI,并通过 VS Code 使用的相同 API 贡献功能。本文介绍了如何从Visual Studio Code Marketplace 中查找、安装和管理 VS Code 扩展。

浏览扩展

您可以在 VS Code 中浏览和安装扩展。通过单击 VS Code 侧边 Activity Bar (活动栏) 中的扩展图标或使用 View: Extensions (视图:扩展) 命令 (⇧⌘X (Windows, Linux Ctrl+Shift+X)) 打开扩展视图。

Extensions view icon

这将显示 VS Code Marketplace 上最受欢迎的 VS Code 扩展列表。

popular extensions

列表中的每个扩展都包含简短描述、发布者、下载次数和五星评级。您可以选择扩展项以显示扩展的详细信息页面,在该页面可以了解更多信息。

注意

如果您的计算机通过代理服务器访问 Internet,则需要配置代理服务器。有关详细信息,请参阅代理服务器支持

安装扩展

要安装扩展,请选择 Install (安装) 按钮。安装完成后,Install (安装) 按钮将变为 Manage (管理) 齿轮按钮。

重要事项

扩展具有与 VS Code 本身相同的权限。从 VS Code 1.97 版本开始,当您首次安装第三方发布者的扩展时,VS Code 会弹出一个对话框,提示您确认您信任该扩展发布者。获取有关扩展运行时安全以及如何保护自己免受恶意扩展侵害的更多信息。

如果您想安装特定版本的扩展,右键单击该扩展并选择 Install Another Version (安装另一个版本)。然后,您可以从可用列表中选择一个版本。

启用设置同步后,您可以在您的计算机之间共享 VS Code 配置,例如扩展。要安装某个扩展但不将其同步到您的所有计算机,右键单击该扩展并选择 Install (Do not Sync) (安装 (不同步))。

查找和安装扩展

例如,让我们安装流行的 TODO Highlight 扩展。此扩展会突出显示源代码中“TODO:”和“FIXME:”等文本,以便您可以快速找到未完成的部分。

TODO Highlight extension highlighting in the editor

在扩展视图中 (⇧⌘X (Windows, Linux Ctrl+Shift+X)),在搜索框中键入“todo”以筛选 Marketplace 中标题或元数据中包含“todo”的扩展。您应该会在列表中看到 TODO Highlight 扩展。

Search for todo in the Extensions view

扩展由其发布者 ID 和扩展 ID 唯一标识。如果您选择 TODO Highlight 扩展,您将看到扩展详细信息页面,在该页面可以找到扩展 ID,在本例中为 wayou.vscode-todo-highlight。如果存在多个名称相似的扩展,了解扩展 ID 会有所帮助。

TODO Highlight extension details with extension ID highlighted

选择 Install (安装) 按钮,VS Code 将从 Marketplace 下载并安装该扩展。安装完成后,Install (安装) 按钮将替换为 Manage (管理) 齿轮按钮。

Manage gear button

要查看 TODO Highlight 扩展的实际效果,打开任何源代码文件并添加文本“TODO:”,您将看到文本被突出显示。

TODO Highlight 扩展贡献了命令 TODO-Highlight: List highlighted annotations (TODO-Highlight: 列出突出显示的注释) 和 TODO-Highlight: Toggle highlight (TODO-Highlight: 切换突出显示),您可以在命令面板 (⇧⌘P (Windows, Linux Ctrl+Shift+P)) 中找到它们。TODO-Highlight: Toggle highlight (TODO-Highlight: 切换突出显示) 命令可让您快速禁用或启用突出显示。

TODO Highlight commands in the Command Palette

该扩展还提供了调整其行为的设置,您可以在设置编辑器 (⌘, (Windows, Linux Ctrl+,)) 中找到这些设置。例如,您可能希望文本搜索不区分大小写,可以取消选中 Todohighlight: Is Case Sensitive (Todohighlight: 区分大小写) 设置。

TODO Highlight settings in the Settings editor

如果某个扩展没有提供您想要的功能,您始终可以从 Manage (管理) 按钮的上下文菜单中 Uninstall (卸载) 该扩展。

Uninstall the TODO Highlight extension

这只是如何安装和使用扩展的一个示例。VS Code Marketplace 拥有数千个扩展,支持数百种编程语言和任务。从对 JavaPythonGoC++ 的功能齐全的语言支持,到创建 GUID、更改颜色主题或向编辑器添加虚拟宠物的简单扩展,应有尽有。

扩展详细信息

在扩展详细信息页面,您可以阅读扩展的 README 并查看扩展的:

  • 功能贡献 (Feature Contributions) - 扩展对 VS Code 的添加,例如设置、命令和键盘快捷方式、语言语法、调试器等。
  • 变更日志 (Changelog) - 扩展仓库的 CHANGELOG(如果可用)。
  • 依赖项 (Dependencies) - 列出该扩展是否依赖于其他扩展。

extension contributions

如果某个扩展是扩展包 (Extension Pack),则 Extension Pack (扩展包) 部分会显示安装该包时将安装哪些扩展。扩展包将多个独立的扩展捆绑在一起,以便可以一次性轻松安装。

Azure Tools extension pack

扩展视图筛选器和命令

您可以使用 Filter Extensions (筛选扩展) 上下文菜单筛选扩展视图。

Extensions view filter context menu

有些筛选器可以显示:

  • 可以更新的过期扩展列表
  • 当前启用/禁用扩展列表
  • 根据您的工作区推荐的扩展列表
  • 全局热门扩展列表

您可以按安装次数 (Install Count)评级 (Rating)名称 (Name)发布日期 (Published Date)更新日期 (Updated Date) 按升序或降序对扩展列表进行排序。您可以在下方了解有关扩展搜索筛选器的更多信息。

您可以通过 ... View and More Actions (查看和更多操作) 按钮运行其他扩展视图命令。

more button

通过此上下文菜单,您可以控制扩展更新、启用或禁用所有扩展,以及使用扩展二分法工具来隔离有问题的扩展行为。

搜索扩展

您可以清除扩展视图顶部的搜索框,然后键入您要查找的扩展、工具或编程语言的名称。

例如,键入“python”将显示 Python 语言扩展列表

python extensions

如果您知道要查找的扩展的确切标识符,可以使用 @id: 前缀,例如 @id:vue.volar。此外,要筛选或排序结果,可以使用下面详细介绍的筛选排序命令。

安装预发布扩展版本

扩展发布者可能会提供扩展的预发布版本。要安装预发布版本,请选择 Install (安装) 按钮上的下拉菜单,然后选择 Install Pre-Release Version (安装预发布版本)。

Install pre-release version

管理扩展

VS Code 使管理您的扩展变得容易。您可以通过扩展视图、命令面板 (Command Palette) (命令带有 Extensions: 前缀) 或命令行开关来安装、禁用、更新和卸载扩展。

列出已安装的扩展

默认情况下,扩展视图将显示您当前已安装的扩展以及所有推荐给您的扩展。您可以使用 Command Palette (命令面板) 中提供的 Extensions: Focus on Installed View (扩展:聚焦到已安装视图) 命令 (⇧⌘P (Windows, Linux Ctrl+Shift+P)),或在 More Actions (更多操作) (...) 下拉菜单 > Views (视图) > Installed (已安装) 中使用该命令,以清除搜索框中的任何文本并显示所有已安装扩展的列表,包括那些已被禁用的扩展。

卸载扩展

要卸载某个扩展,请选择扩展条目右侧的 Manage (管理) 齿轮按钮,然后从下拉菜单中选择 Uninstall (卸载)。这将卸载该扩展,并提示您重新启动扩展宿主 (Restart Extensions)。

uninstall an extension

禁用扩展

如果您不想永久删除某个扩展,您可以通过单击扩展条目右侧的齿轮按钮暂时禁用该扩展。您可以全局禁用某个扩展,或仅在当前工作区禁用。禁用扩展后,系统会提示您重新启动扩展宿主 (Restart Extensions)。

如果您想快速禁用所有已安装的扩展,Command Palette (命令面板) 和 More Actions (更多操作) (...) 下拉菜单中有一个 Disable All Installed Extensions (禁用所有已安装扩展) 命令。

扩展在所有 VS Code 会话中保持禁用状态,直到您重新启用它们。

启用扩展

同样,如果您已禁用某个扩展 (它将显示在列表的 Disabled (已禁用) 部分,并标记为 Disabled (已禁用)),您可以使用下拉菜单中的 Enable (启用) 或 Enable (Workspace) (启用 (工作区)) 命令重新启用它。

enable extension

More Actions (更多操作) (...) 下拉菜单中还有一个 Enable All Extensions (启用所有扩展) 命令。

扩展自动更新

VS Code 会检查扩展更新并自动安装它们。更新后,系统会提示您重新启动扩展宿主 (Restart Extensions)。

如果您更喜欢手动更新扩展,可以使用 Disable Auto Update for All Extensions (禁用所有扩展的自动更新) 命令或扩展视图中的相应操作来禁用自动更新。您还可以配置 extensions.autoUpdate 设置。使用 Enable Auto Update for All Extensions (启用所有扩展的自动更新) 命令重新启用自动更新。

Disable auto update for all extensions action

您还可以通过右键单击某个扩展并切换 Auto Update (自动更新) 项来配置单个扩展的自动更新。

如果您甚至不想让 VS Code 检查更新,可以将 extensions.autoCheckUpdates 设置为 false。

手动更新扩展

如果您已禁用扩展自动更新,您可以使用 Show Outdated Extensions (显示过期扩展) 命令快速查找扩展更新,该命令使用 @updates 筛选器。这将显示您当前已安装扩展的任何可用更新。

选择过期扩展的 Update (更新) 按钮。更新将安装,并且系统会提示您重新启动扩展宿主 (Restart Extensions)。您还可以使用 Update All Extensions (更新所有扩展) 命令一次性更新所有过期扩展。

如果您也禁用了自动检查更新,可以使用 Check for Extension Updates (检查扩展更新) 命令来检查哪些扩展可以更新。

您可以使用 Show Recommended Extensions (显示推荐扩展) 查看推荐扩展列表,该命令设置 @recommended 筛选器。扩展推荐可以是:

  • 工作区推荐 (Workspace Recommendations) - 由您当前工作区的其他用户推荐。
  • 其他推荐 (Other Recommendations) - 根据最近打开的文件推荐。

请参阅下文以了解如何为项目中的其他用户贡献推荐。

忽略推荐

要忽略某个推荐,选择该扩展项打开详细信息页面,然后选择 Manage (管理) 齿轮按钮以显示上下文菜单。选择 Ignore Recommendation (忽略推荐) 菜单项。忽略的推荐将不再推荐给您。

Ignore extension recommendation

配置扩展

VS Code 扩展可能有截然不同的配置和要求。有些扩展会向 VS Code 贡献设置,可以在设置编辑器中修改这些设置。其他扩展可能有自己的配置文件。扩展还可能需要安装和设置其他组件,例如编译器、调试器和命令行工具。请参阅扩展的 README(在扩展视图详细信息页面中可见)或访问 VS Code Marketplace 上的扩展页面(在详细信息页面上单击扩展名称)。许多扩展是开源的,其 Marketplace 页面上都有指向其仓库的链接。

命令行扩展管理

为了更轻松地自动化和配置 VS Code,可以通过命令行列出、安装和卸载扩展。识别扩展时,请提供完整名称,格式为 publisher.extension,例如 ms-python.python

示例

code --extensions-dir <dir>
    Set the root path for extensions.
code --list-extensions
    List the installed extensions.
code --show-versions
    Show versions of installed extensions, when using --list-extension.
code --install-extension (<extension-id> | <extension-vsix-path>)
    Installs an extension.
code --uninstall-extension (<extension-id>)
    Uninstalls an extension.
code --enable-proposed-api (<extension-id>)
    Enables proposed API features for extensions. Can receive one or more extension IDs to enable individually.

您可以在扩展详细信息页面中的 Marketplace 信息下方看到扩展 ID。

extension identifier

扩展视图筛选器

扩展视图搜索框支持筛选器,可帮助您查找和管理扩展。如果您使用了 Show Installed Extensions (显示已安装扩展) 和 Show Recommended Extensions (显示推荐扩展) 命令,您可能已经看到过 @installed@recommended 等筛选器。此外,还有一些筛选器可让您按受欢迎程度或评级进行排序,以及按类别(例如“Linters”)和标签(例如“node”)进行搜索。您可以通过在扩展搜索框中键入 @ 并浏览建议来查看所有筛选器和排序命令的完整列表

intellisense on extension search filters

以下是扩展视图的一些筛选器:

  • @builtin - 显示 VS Code 自带的扩展。按类型分组(编程语言、主题等)。
  • @deprecated - 显示已弃用的扩展。
  • @disabled - 显示已安装的已禁用扩展。
  • @enabled - 显示已安装的已启用扩展。扩展可以单独启用/禁用。
  • @featured - 显示精选扩展。
  • @installed - 显示已安装的扩展。
  • @popular - 显示热门扩展。
  • @recentlyPublished - 显示近期在 Marketplace 中发布的扩展。
  • @recommended - 显示推荐的扩展。按工作区特定或通用用途分组。
  • @updates - 显示已安装的过期扩展。Marketplace 上有新版本可用。
  • @workspaceUnsupported - 显示此工作区不支持的扩展。
  • @category - 显示属于指定类别的扩展。以下是一些受支持的类别。有关完整列表,请键入 @category 并按照建议列表中的选项进行操作:
    • @category:主题
    • @category:格式化程序
    • @category:代码检查器
    • @category:代码片段

这些筛选器也可以组合使用。例如:使用 @installed @category:themes 查看所有已安装的主题。

如果未提供筛选器,扩展视图将显示当前已安装和推荐的扩展。

排序

您可以使用 @sort 筛选器对扩展进行排序,该筛选器可以采用以下值:

  • installs - 按 Marketplace 安装次数排序,降序。
  • name - 按扩展名称字母顺序排序。
  • publishedDate - 按扩展发布日期排序。
  • rating - 按 Marketplace 评级(1-5 星)排序,降序。
  • updateDate - 按扩展最后更新日期排序。

sort by install count

类别和标签

扩展可以设置描述其功能的类别 (Categories)标签 (Tags)

extension categories and tags

您可以使用 category:tag: 按类别和标签进行筛选。

支持的类别有:[Azure, Data Science, Debuggers, Education, Extension Packs, Formatters, Keymaps, Language Packs, Linters, Machine Learning, Notebooks, Others, Programming Languages, SCM Providers, Snippets, Testing, Themes, Visualization]。您可以在扩展搜索框中通过 IntelliSense 访问它们。

categories debuggers

请注意,如果类别名称包含多个词,必须用引号括起来(例如,category:"SCM Providers")。

标签可以包含任何字符串,并且不提供 IntelliSense 支持,因此请查看 Marketplace 以查找有用的标签。

从 VSIX 安装

您可以手动安装打包在 .vsix 文件中的 VS Code 扩展。使用扩展视图命令下拉菜单中的 Install from VSIX (从 VSIX 安装) 命令,或 Command Palette (命令面板) 中的 Extensions: Install from VSIX (扩展:从 VSIX 安装) 命令,指向 .vsix 文件。

您还可以使用 VS Code --install-extension 命令行开关进行安装,提供 .vsix 文件的路径。

code --install-extension myextension.vsix

您可以在命令行上多次提供 --install-extension 以一次性安装多个扩展。

注意

通过 VSIX 安装扩展时,该扩展的自动更新默认处于禁用状态。

如果您想了解有关打包和发布扩展的更多信息,请参阅扩展 API 中的发布扩展文章。

一套好的扩展可以使处理特定工作区或编程语言更有效率,您通常希望与您的团队或同事共享此列表。您可以使用 Extensions: Configure Recommended Extensions (Workspace Folder) (扩展:配置推荐扩展(工作区文件夹)) 命令为工作区创建推荐扩展列表。

在单文件夹工作区中,该命令会在工作区 .vscode 文件夹中创建一个 extensions.json 文件,您可以在其中添加扩展标识符列表 ({publisherName}.{extensionName})。

多根工作区中,该命令将打开您的 .code-workspace 文件,您可以在其中将扩展列在 extensions.recommendations 下方。您仍然可以使用 Extensions: Configure Recommended Extensions (Workspace Folder) (扩展:配置推荐扩展(工作区文件夹)) 命令将扩展推荐添加到多根工作区中的单个文件夹。

extensions.json 示例可能如下所示:

{
  "recommendations": ["dbaeumer.vscode-eslint", "esbenp.prettier-vscode"]
}

它推荐了一个代码检查器扩展和一个代码格式化程序扩展。

扩展使用其发布者标识符和扩展标识符 publisher.extension 进行标识。您可以在扩展的详细信息页面上看到名称。VS Code 会在这些文件中为您提供已安装扩展的自动完成功能。

Extension identifier.

VS Code 会在首次打开工作区时提示用户安装推荐的扩展。用户还可以使用 Extensions: Show Recommended Extensions (扩展:显示推荐扩展) 命令查看列表。

Show Recommendations

下一步

以下是一些您可能会感兴趣的主题...

常见问题

扩展安装在哪里?

扩展安装在每个用户的扩展文件夹中。根据您的平台,位置在以下文件夹中:

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

您可以通过使用 --extensions-dir <dir> 命令行选项启动 VS Code 来更改位置。

或者,您可以将 VSCODE_EXTENSIONS 环境变量设置为您要安装扩展的位置。这在企业环境中非常有用,在该环境中,您希望集中管理用户计算机上扩展的安装位置。

每当我尝试安装任何扩展时,都会收到 connect ETIMEDOUT 错误

如果您的计算机通过代理服务器访问 Internet,您可能会看到此错误。有关详细信息,请参阅安装主题中的代理服务器支持部分。

我可以直接从 Marketplace 下载扩展吗?

有些用户倾向于从 Marketplace 下载一次扩展,然后从本地共享将其安装到多个 VS Code 实例。这在存在连接问题或开发团队想要使用一组固定的扩展时非常有用。

要下载某个扩展,在扩展视图中搜索它,右键单击结果中的某个扩展,然后选择 Download VSIX (下载 VSIX)。

注意

下载选项从 VS Code 1.96 版本开始提供,并且仅适用于尚未安装的扩展。

我能否阻止 VS Code 提供扩展推荐?

是的,如果您不想让 VS Code 在扩展视图中或通过通知显示扩展推荐,可以修改以下设置:

如果您想查看推荐,Show Recommended Extensions (显示推荐扩展) 命令始终可用。

我可以信任来自 Marketplace 的扩展吗?

Visual Studio Marketplace 采取了多项措施来保护您免受恶意扩展侵害,您也可以在安装前执行各种步骤来确定某个扩展是否可靠。

从 VS Code 1.97 版本开始,当您首次安装第三方发布者的扩展时,VS Code 会弹出一个对话框,提示您确认您信任该扩展发布者。

获取有关扩展运行时安全的更多信息。

VS Code 无法验证扩展签名

Visual Studio Marketplace 在发布所有扩展时都会对其进行签名。VS Code 在安装扩展时会验证此签名,以检查扩展包的完整性和来源。

重要事项

安装扩展时,您可能会看到以下错误消息:无法安装扩展,因为 Visual Studio Code 无法验证扩展签名。此错误可能由多种原因引起,如果您遇到此错误,请谨慎决定是否仍然安装。使用 extensions.verifySignature 设置禁用扩展签名验证。

包完整性问题

对于包完整性问题,建议您联系Visual Studio Marketplace 团队报告问题。请务必包含扩展 ID。以下列表提供了与包完整性问题相关的错误代码:

PackageIntegrityCheckFailed
SignatureIsInvalid
SignatureManifestIsInvalid
SignatureIntegrityCheckFailed
EntryIsMissing
EntryIsTampered
Untrusted
CertificateRevoked
SignatureIsNotValid
SignatureArchiveHasTooManyEntries
NotSigned

其他问题

对于其他问题,例如不支持的环境或未知原因,建议您报告 VS Code 问题,提供所有必要信息并包括共享日志:⇧⌘P (Windows, Linux Ctrl+Shift+P) > Open View... (打开视图...) > Shared (共享)。

连接到远程窗口时,我的扩展没有同步

设置同步 (Settings Sync) 允许您在您的计算机之间共享您的 Visual Studio Code 配置,例如设置、键盘快捷方式和已安装的扩展,以便您始终使用您喜欢的设置。

VS Code 不会与远程窗口同步您的扩展,例如当您连接到 SSH、开发容器 (devcontainer) 或 WSL 时。

我可以在我的组织中允许或阻止特定扩展吗?

您可以通过配置 extensions.allowed 应用程序设置来控制您的组织中可以安装哪些扩展。如果未配置该设置,则允许所有扩展。如果配置了该设置,则会阻止安装所有未列出的扩展。

获取有关配置允许的扩展的更多详细信息。