通过在项目根目录的 .vscode/extensions.json 中声明 recommendations,可实现团队 VSCode 扩展的统一、精准、免手动安装配置;它随代码提交、开箱即用、按角色分组推荐,并避免强推个人偏好类插件。
为团队创建统一的 vscode 推荐扩展列表,核心是通过 workspace 推荐(extensions.json)实现精准、可复用、免手动安装的配置。它不依赖个人设置,只对打开该工作区的成员生效,且能随项目代码一起提交,真正实现“开箱即用”。
在项目根目录添加 extensions.json
这是最直接有效的方式。在你的 git 仓库根目录(或 `.vscode/` 子目录)下新建文件:.vscode/extensions.json
内容格式如下(只需填 extension ID,无需版本号):
{"recommendations": [ "esbenp.prettier-vscode", "ms-python.python", "ms-toolsai.jupyter", "editorconfig.editorconfig", "coenraads.bracket-pair-colorizer" ] }
✅ 成员克隆项目后,VSCode 会自动弹出“推荐扩展”提示栏;
✅ 点击“Install All”即可一键安装;
✅ 即使已有部分扩展,也不会重复或冲突。
按角色或语言 栈做分组推荐(进阶)
若团队有 前端 、 后端、数据等不同角色,可在同一份 extensions.json 中按需组织,例如:
- 基础通用项(所有成员都装):EditorConfig、Prettier、GitLens
- Python 后端 追加:
ms-python.python、ms-python.pylint - 前端 追加:
esbenp.prettier-vscode、bradlc.vscode-tailwindcss
注意:VSCode 不原生支持“条件推荐”,但可通过文档注释 + 团队约定来引导。比如在 extensions.json 顶部加说明:
// 推荐扩展分为【必装】和【按需选装】两部分 //【必装】适用于所有成员 //【Python 开发者】请额外安装第 5–6 项 //【前端开发 者】请额外安装第 7–8 项
避免常见坑
- 别把用户级扩展设为推荐:如主题、图标包、终端增强类插件,它们属于个人偏好,不应强推到工作区
- 扩展 ID 要写准:去 marketplace.visualstudio.com 查找插件页 URL,取最后一段(如
https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode→ ID 是esbenp.prettier-vscode) - 不要提交
settings.json强制启用扩展:那会覆盖用户原有设置,引发抵触;推荐机制更柔和、更尊重个体选择
配合 README 做轻量引导
在项目 README.md 里加一句简短说明即可:
? 提示:本项目已配置 VSCode 推荐扩展,打开项目文件夹后,VSCode 会提示安装(或按 Ctrl+Shift+P →“Extensions: Show Recommended Extensions”)
不需要写安装教程,VSCode 自带 ui 引导已足够友好。
基本上就这些。不复杂但容易忽略——关键在于把 extensions.json 当作项目基础设施的一部分,像 package.json 或 pyproject.toml 一样纳入日常维护。