用途
VS Code Workspace Setup 是一套面向团队的 VS Code 工作区配置方案,核心目标是让团队成员在使用同一项目时获得一致、可复现的编辑器行为与开发体验。它把编辑器设置、推荐扩展、构建任务、调试配置、代码片段和开发容器集中到项目的 .vscode 及 .devcontainer 目录中,便于随代码库一同版本化管理。
主要能力
- 工作区设置:在 .vscode/settings.json 中统一保存时格式化、默认格式化器(Prettier)、ESLint 保存时修复、Tab 宽度、标尺、括号配色、文件排除与监听排除、搜索排除、TypeScript/JavaScript 导入与引号偏好、Tailwind CSS 类名正则与语言映射、Git 自动拉取、终端配置、资源管理器文件嵌套规则以及调试与测试相关选项。
- 推荐扩展:在 .vscode/extensions.json 中列出 ESLint、Prettier、Tailwind CSS、TypeScript、React 片段、GitLens、Git Graph、Vitest、Jest、拼写检查、路径与 npm 智能提示、dotenv、EditorConfig、GitHub Copilot、JavaScript 调试、Docker 与远程容器等扩展,并标记不推荐的扩展。
- 构建任务:在 .vscode/tasks.json 中定义 dev、build、test、test:watch、lint、lint:fix、typecheck、typecheck:watch 等 npm/shell 任务,并配置问题匹配器、后台运行与展示方式。
- 调试配置:在 .vscode/launch.json 中提供 Next.js 服务端与全栈调试、Chrome 客户端调试、Vite 调试、Jest/Vitest 当前文件调试、Node 附加与当前文件调试,以及 Full Stack Debug 复合配置。
- 自定义代码片段:在 .vscode/snippets/typescript.json 中提供 React 函数组件、useState、useEffect、console.log、异步函数、try/catch、Zod Schema 等片段。
- 开发容器:在 .devcontainer/devcontainer.json 中定义基于 TypeScript Node 20 镜像的开发容器,包含 GitHub CLI 与 Docker-in-Docker 特性、端口转发、环境变量、创建后安装命令、容器内 VS Code 设置与扩展、挂载与远程用户。
- EditorConfig:提供 .editorconfig,统一字符集、换行符、末尾换行、行尾空白、缩进风格与不同文件类型的缩进规则。
使用方式
资料给出的核心工作流为:创建 .vscode 文件夹并写入工作区设置;配置编辑器格式化与 lint;添加团队推荐扩展;设置构建、测试、lint 任务;配置调试启动项;创建 devcontainer 以获得一致环境。最佳实践建议将 .vscode 纳入版本控制、使用工作区设置而非用户设置、通过 extensions.json 推荐扩展、为常见操作配置任务、设置调试启动配置、添加符合团队约定的代码片段、使用 devcontainer 统一环境,并利用文件嵌套保持资源管理器整洁。输出清单要求每个工作区包含 settings.json、extensions.json、tasks.json、launch.json、自定义片段、EditorConfig,并启用保存时格式化、ESLint 集成、Prettier 默认格式化器,DevContainer 配置为可选项。
适用场景
适合需要统一团队开发环境的前端或 Node.js 项目,尤其是使用 TypeScript、React、Next.js、Vite、Tailwind CSS、ESLint、Prettier、Jest 或 Vitest 的代码库。也适合希望通过 devcontainer 获得可复现开发环境的团队。
限制
资料未提供该配置的安装命令、版本要求、收费信息、价格、平台兼容性细节或实际效果验证。示例中的任务脚本名(如 dev、build、test、lint、typecheck)需要项目自身 package.json 中存在对应脚本;调试配置中的端口(3000、5173)与路径需按项目实际情况调整。资料未说明该方案是否适用于非 JavaScript/TypeScript 项目。