扩展市场
Visual Studio Code 的内置功能仅仅是开始。VS Code 扩展允许您向安装添加语言、调试器和工具,以支持您的开发工作流程。VS Code 丰富的可扩展性模型使扩展作者可以直接集成到 VS Code UI 中,并通过 VS Code 使用的相同 API 贡献功能。本文介绍了如何从Visual Studio Code Marketplace 查找、安装和管理 VS Code 扩展。
浏览扩展
您可以在 VS Code 中浏览和安装扩展。通过点击 VS Code 侧边活动栏中的扩展图标,或者使用查看: 扩展命令 (⇧⌘X (Windows, Linux Ctrl+Shift+X)),调出“扩展”视图。
这将显示VS Code Marketplace 上最受欢迎的 VS Code 扩展列表。
列表中的每个扩展都包含简要描述、发布者、下载量和五星评级。您可以选择扩展项以显示扩展的详细信息页面,在那里您可以了解更多信息。
如果您的计算机通过代理服务器访问互联网,您需要配置代理服务器。详情请参阅代理服务器支持。
安装扩展
要安装扩展,请选择安装按钮。安装完成后,安装按钮将变为管理齿轮按钮。
扩展拥有与 VS Code 本身相同的权限。从 VS Code 1.97 版本开始,当您首次安装第三方发布者的扩展时,VS Code 会显示一个对话框,提示您确认您信任该扩展发布者。了解更多关于扩展运行时安全以及如何保护自己免受恶意扩展侵害的信息。
如果要安装特定版本的扩展,右键单击该扩展并选择安装其他版本。然后您可以从可用列表中选择一个版本。
当启用设置同步时,您可以在您的机器之间共享您的 VS Code 配置,例如扩展。要安装扩展但不将其同步到您的机器上,请右键单击该扩展并选择安装(不同步)。
查找并安装扩展
例如,让我们安装流行的TODO Highlight 扩展。此扩展会高亮显示源代码中的“TODO:”和“FIXME:”等文本,以便您快速找到未完成的部分。
在“扩展”视图 (⇧⌘X (Windows, Linux Ctrl+Shift+X)) 中,在搜索框中输入“todo”,以过滤 Marketplace 中标题或元数据包含“todo”的扩展。您应该会在列表中看到 TODO Highlight 扩展。
扩展由其发布者和扩展 ID 唯一标识。如果您选择 TODO Highlight 扩展,您将看到扩展详情页面,在那里您可以找到扩展 ID,在本例中是 wayou.vscode-todo-highlight
。如果存在多个名称相似的扩展,了解扩展 ID 会很有帮助。
选择安装按钮,VS Code 将从 Marketplace 下载并安装该扩展。安装完成后,安装按钮将替换为管理齿轮按钮。
要查看 TODO Highlight 扩展的实际效果,打开任何源代码文件并添加文本“TODO:”,您将看到文本被高亮显示。
TODO Highlight 扩展贡献了命令TODO-Highlight: List highlighted annotations 和 TODO-Highlight: Toggle highlight,您可以在命令面板 (⇧⌘P (Windows, Linux Ctrl+Shift+P)) 中找到这些命令。TODO-Highlight: Toggle highlight 命令允许您快速禁用或启用高亮显示。
该扩展还提供了调整其行为的设置,您可以在设置编辑器 (⌘, (Windows, Linux Ctrl+,)) 中找到这些设置。例如,您可能希望文本搜索不区分大小写,您可以取消选中 Todohighlight: Is Case Sensitive 设置。
如果某个扩展没有提供您想要的功能,您始终可以从管理按钮的上下文菜单中卸载该扩展。
这只是如何安装和使用扩展的一个示例。VS Code Marketplace 上有成千上万个扩展,支持数百种编程语言和任务。从为 Java、Python、Go 和 C++ 提供功能齐全的语言支持,到用于创建 GUID、更改颜色主题或向编辑器添加虚拟宠物的简单扩展,应有尽有。
扩展详情
在扩展详情页面,您可以阅读扩展的 README 并查看扩展的
- 功能贡献 - 扩展对 VS Code 的添加,例如设置、命令和键盘快捷方式、语言语法、调试器等。
- 更新日志 - 如果可用,扩展存储库的 CHANGELOG。
- 依赖项 - 列出扩展是否依赖于其他任何扩展。
如果某个扩展是扩展包,则扩展包部分将显示安装该包时将安装哪些扩展。扩展包将单独的扩展捆绑在一起,以便一次轻松安装。
扩展视图过滤器和命令
您可以使用过滤扩展上下文菜单过滤“扩展”视图。
有以下过滤器用于显示
- 可以更新的过时扩展列表
- 当前已启用/已禁用扩展列表
- 基于您的工作区的推荐扩展列表
- 全球热门扩展列表
您可以按安装量、评分、名称、发布日期或更新日期按升序或降序对扩展列表进行排序。您可以在下方了解有关扩展搜索过滤器的更多信息。
您可以通过 ...
视图和更多操作按钮运行其他扩展视图命令。
通过此上下文菜单,您可以控制扩展更新、启用或禁用所有扩展,以及使用扩展二分查找工具来隔离有问题的扩展行为。
搜索扩展
您可以清空“扩展”视图顶部的搜索框,然后输入您正在寻找的扩展、工具或编程语言的名称。
例如,输入“python”将显示 Python 语言扩展列表
如果您知道正在查找的扩展的精确标识符,可以使用 @id:
前缀,例如 @id:vue.volar
。此外,要过滤或排序结果,您可以使用过滤器和排序命令,详见下文。
安装预览版扩展
扩展发布者可能会提供扩展的预览版本。要安装预览版本,请选择安装按钮上的下拉菜单,然后选择安装预览版本。
管理扩展
VS Code 使管理扩展变得容易。您可以通过“扩展”视图、命令面板(命令前缀为 Extensions:)或命令行开关来安装、禁用、更新和卸载扩展。
列出已安装的扩展
默认情况下,“扩展”视图将显示您当前安装的扩展以及所有推荐给您的扩展。您可以使用扩展: 聚焦到已安装视图命令,该命令在命令面板 (⇧⌘P (Windows, Linux Ctrl+Shift+P)) 或更多操作 (...
) 下拉菜单 > 视图 > 已安装 中可用,用于清除搜索框中的任何文本并显示所有已安装扩展的列表,包括已禁用的扩展。
卸载扩展
要卸载扩展,请选择扩展条目右侧的管理齿轮按钮,然后从下拉菜单中选择卸载。这将卸载扩展,并提示您重新启动扩展宿主 (重新启动扩展)。
禁用扩展
如果您不想永久删除某个扩展,可以点击扩展条目右侧的齿轮按钮来暂时禁用该扩展。您可以全局禁用扩展,也可以仅针对当前工作区禁用。禁用扩展后,系统会提示您重新启动扩展宿主 (重新启动扩展)。
如果您想快速禁用所有已安装的扩展,可以在命令面板和更多操作 (...
) 下拉菜单中找到禁用所有已安装扩展命令。
扩展在所有 VS Code 会话中保持禁用状态,直到您重新启用它们。
启用扩展
类似地,如果您禁用了某个扩展(它将出现在列表的已禁用部分并标记为已禁用),您可以使用下拉菜单中的启用或启用(工作区)命令重新启用它。
在更多操作 (...
) 下拉菜单中还有一个启用所有扩展命令。
扩展自动更新
VS Code 会检查扩展更新并自动安装。更新后,系统会提示您重新启动扩展宿主 (重新启动扩展)。
如果您更喜欢手动更新扩展,可以使用禁用所有扩展自动更新命令或“扩展”视图中的相应操作来禁用自动更新。您还可以配置 extensions.autoUpdate 设置。使用启用所有扩展自动更新命令可以重新启用自动更新。
您还可以通过右键单击某个扩展并切换自动更新项来配置单个扩展的自动更新。
如果您甚至不希望 VS Code 检查更新,可以将 extensions.autoCheckUpdates 设置为 false。
手动更新扩展
如果您已禁用扩展自动更新,可以使用使用 @updates
过滤器的显示过时扩展命令快速查找扩展更新。这将显示当前已安装扩展的任何可用更新。
选择过时扩展的更新按钮。更新将被安装,并且会提示您重新启动扩展宿主 (重新启动扩展)。您还可以使用更新所有扩展命令一次更新所有过时扩展。
如果您还禁用了自动检查更新,可以使用检查扩展更新命令来检查您的哪些扩展可以更新。
推荐扩展
您可以使用显示推荐扩展来查看推荐扩展列表,这会设置 @recommended
过滤器。扩展推荐可以是以下类型:
- 工作区推荐 - 由您当前工作区的其他用户推荐。
- 其他推荐 - 基于最近打开的文件推荐。
请参阅下文了解如何为项目中的其他用户贡献推荐。
忽略推荐
要忽略某个推荐,请选择该扩展项以打开详情页面,然后选择管理齿轮按钮以显示上下文菜单。选择忽略推荐菜单项。被忽略的推荐将不再向您推荐。
配置扩展
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。
扩展视图过滤器
“扩展”视图搜索框支持过滤器,可帮助您查找和管理扩展。如果您使用过显示已安装扩展和显示推荐扩展命令,您可能已经看到过 @installed
和 @recommended
等过滤器。此外,还有一些过滤器可让您按受欢迎程度或评分进行排序,并按类别(例如“Linters”)和标签(例如“node”)进行搜索。您可以在扩展搜索框中输入 @
并浏览建议列表,查看所有过滤器和排序命令的完整列表
以下是一些“扩展”视图过滤器
@builtin
- 显示 VS Code 自带的扩展。按类型分组(编程语言、主题等)。@deprecated
- 显示已弃用的扩展。@disabled
- 显示已禁用的已安装扩展。@enabled
- 显示已启用的已安装扩展。扩展可以单独启用/禁用。@featured
- 显示精选扩展。@installed
- 显示已安装的扩展。@popular
- 显示热门扩展。@recentlyPublished
- 显示最近在 Marketplace 中发布的扩展。@recommended
- 显示推荐的扩展。按工作区特定或通用类型分组。@updates
- 显示已安装的过时扩展。Marketplace 上有新版本可用。@workspaceUnsupported
- 显示此工作区不支持的扩展。@category
- 显示属于指定类别的扩展。下面列出了一些支持的类别。要获取完整列表,请键入@category
并按照建议列表中的选项进行操作@category:themes
@category:formatters
@category:linters
@category:snippets
这些过滤器也可以组合使用。例如:使用 @installed @category:themes
查看所有已安装的主题。
如果未提供过滤器,“扩展”视图将显示当前已安装和推荐的扩展。
排序
您可以使用 @sort
过滤器对扩展进行排序,该过滤器可以接受以下值
installs
- 按 Marketplace 安装数量排序,降序。name
- 按扩展名称字母顺序排序。publishedDate
- 按扩展发布日期排序。rating
- 按 Marketplace 评分(1-5 星)排序,降序。updateDate
- 按扩展最后更新日期排序。
类别和标签
扩展可以设置描述其功能的类别和标签。
您可以使用 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 访问它们
请注意,如果类别名称包含多个单词,则必须用引号括起来(例如,category:"SCM Providers"
)。
标签可以包含任何字符串,并且 IntelliSense 不提供标签提示,因此请查看 Marketplace 以查找有用的标签。
从 VSIX 安装
您可以手动安装打包在 .vsix
文件中的 VS Code 扩展。使用“扩展”视图命令下拉菜单中的从 VSIX 安装命令,或命令面板中的扩展: 从 VSIX 安装命令,指向 .vsix
文件。
您还可以使用 VS Code 的 --install-extension
命令行开关,提供 .vsix
文件的路径来安装。
code --install-extension myextension.vsix
您可以在命令行中多次提供 --install-extension
来一次安装多个扩展。
当您通过 VSIX 安装扩展时,该扩展的自动更新默认是禁用的。
如果您想了解有关打包和发布扩展的更多信息,请参阅扩展 API 中的发布扩展文章。
工作区推荐扩展
一组好的扩展可以使处理特定工作区或编程语言更加高效,而且您通常希望与您的团队或同事分享此列表。您可以使用扩展: 配置推荐扩展(工作区文件夹)命令为工作区创建推荐扩展列表。
在单文件夹工作区中,该命令将在工作区 .vscode
文件夹中创建一个 extensions.json
文件,您可以在其中添加扩展标识符列表 ({publisherName}.{extensionName})。
在多根工作区中,该命令将打开您的 .code-workspace
文件,您可以在 extensions.recommendations
下列出扩展。您仍然可以使用扩展: 配置推荐扩展(工作区文件夹)命令向多根工作区中的单个文件夹添加扩展推荐。
extensions.json
示例可能如下所示
{
"recommendations": ["dbaeumer.vscode-eslint", "esbenp.prettier-vscode"]
}
它推荐了一个代码检查扩展和一个代码格式化扩展。
扩展使用其发布者标识符和扩展标识符 publisher.extension
进行标识。您可以在扩展的详细信息页面上看到其名称。VS Code 将在这些文件中为您已安装的扩展提供自动完成功能。
.
首次打开工作区时,VS Code 会提示用户安装推荐的扩展。用户还可以使用扩展: 显示推荐扩展命令查看列表。
后续步骤
以下是一些您可能会感兴趣的主题...
- 扩展 API - 开始学习 VS Code 扩展 API。
- 您的第一个扩展 - 尝试创建一个简单的 Hello World 扩展。
- 发布到 Marketplace - 将您自己的扩展发布到 VS Code Marketplace。
常见问题
扩展安装在哪里?
扩展安装在每个用户的扩展文件夹中。根据您的平台,位置在以下文件夹中
- Windows
%USERPROFILE%\.vscode\extensions
- macOS
~/.vscode/extensions
- Linux
~/.vscode/extensions
您可以通过使用带有 --extensions-dir <dir>
命令行的 选项 来更改位置。
此外,您可以将 VSCODE_EXTENSIONS
环境变量设置为您希望安装扩展的位置。这在企业环境中非常有用,您可以集中管理用户机器上扩展的安装位置。
每当我尝试安装任何扩展时,都会出现 connect ETIMEDOUT 错误
如果您的机器通过代理服务器访问互联网,您可能会看到此错误。详情请参阅安装主题中的代理服务器支持部分。
我可以直接从 Marketplace 下载扩展吗?
有些用户喜欢先从 Marketplace 下载一次扩展,然后从本地共享安装到多个 VS Code 实例。这在存在连接问题或您的开发团队希望使用固定一组扩展时非常有用。
要下载扩展,请在“扩展”视图中搜索它,右键单击结果中的一个扩展,然后选择下载 VSIX。
下载选项从 VS Code 1.96 版本开始提供,并且仅适用于尚未安装的扩展。
我可以阻止 VS Code 提供扩展推荐吗?
是的,如果您不希望 VS Code 在“扩展”视图或通过通知显示扩展推荐,您可以修改以下设置
- extensions.showRecommendationsOnlyOnDemand - 设置为 true 以删除推荐部分。
- extensions.ignoreRecommendations - 设置为 true 以关闭扩展推荐通知。
如果您想查看推荐,显示推荐扩展命令始终可用。
我可以信任 Marketplace 中的扩展吗?
Visual Studio Marketplace 采取了多种措施来保护您免受恶意扩展的侵害,您还可以执行各种步骤来确定扩展是否可靠,然后再安装。
从 VS Code 1.97 版本开始,当您首次安装第三方发布者的扩展时,VS Code 会显示一个对话框,提示您确认信任该扩展发布者。
了解更多关于扩展运行时安全的信息。
VS Code 无法验证扩展签名
Visual Studio Marketplace 在发布所有扩展时都会对其进行签名。VS Code 在安装扩展时会验证此签名,以检查扩展包的完整性和来源。
安装扩展时,您可能会看到以下错误消息:VS 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) > 打开视图... > 共享。
连接到远程窗口时,我的扩展不会同步
设置同步让您可以在多台机器之间共享 Visual Studio Code 配置,如设置、键盘快捷方式和已安装的扩展,以便您始终使用最喜欢的设置工作。
VS Code 不会将您的扩展同步到或从远程窗口,例如当您连接到 SSH、开发容器 (devcontainer) 或 WSL 时。
我可以在组织中允许或阻止特定扩展吗?
您可以通过配置 extensions.allowed
应用程序设置来控制哪些扩展可以在您的组织中安装。如果未配置此设置,则允许所有扩展。如果配置了此设置,则未列出的所有扩展都将被阻止安装。
了解更多关于配置允许的扩展的详细信息。