在vscode项目中添加.vscode/extensions.json文件可统一开发环境,它通过recommendations字段列出插件ID,打开项目时提示安装;需精选真正影响质量或效率的插件,并在README中说明。

在 VSCode 项目中添加 .vscode/extensions.json 文件,能帮团队成员或新协作者一键安装推荐插件,统一开发环境。这个文件不自动安装插件,但会在打开项目时弹出“推荐扩展”提示,点击“Install All”即可批量安装。
extensions.json 基本结构
它是一个标准 JSON 文件,放在项目根目录下的 .vscode/ 文件夹中(若无则新建)。核心字段是 recommendations,值为插件 ID 数组:
{ "recommendations": [ "esbenp.prettier-vscode", "ms-python.python", "redhat.vscode-yaml", "editorconfig.editorconfig" ] }
如何选对推荐插件
只推荐**项目真正依赖、影响代码质量或开发效率**的插件,避免堆砌。常见类型包括:
- 语言支持类:如 Python 项目加
ms-python.python,typescript 项目加ms-vscode.vscode-typescript-next - 格式化/校验类:Prettier、ESLint、Stylelint 对应的插件,确保和项目
.prettierrc或.eslintrc匹配 - 配置文件专用类:YAML、JSON Schema、TOML、dockerfile 等,提升可读性和编辑体验
- 调试辅助类:如
msjsdiag.debugger-for-chrome(已集成)、ms-python.pylint(需配合项目 linter 配置)
怎么查插件 ID
打开 VSCode 扩展市场(Ctrl+Shift+X),搜索插件 → 点进详情页 → 地址栏末尾就是 ID,格式为 publisher.name。例如:https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode → ID 是 esbenp.prettier-vscode
也可在已安装插件列表中右键 → “copy Extension ID”。
小提醒:别忘了同步说明
在项目 README 中加一句提示,比如:
? 打开本项目时,VSCode 会提示安装推荐扩展,建议点击 “Install All” 以获得最佳编辑体验。
基本上就这些 —— 简单几行 JSON,却能让协作少踩一半环境坑。