必须将.prettierrc、.editorconfig、.vscode/settings.json提交至Git,禁用ESLint格式规则,启用prettier.requireConfig:true,统一工具链版本并锁死路径,否则代码风格必然漂移。

直接说结论:靠个人设置或口头约定没用,必须把 .prettierrc、.editorconfig、.vscode/settings.json 三个文件一起提交进 Git,并且禁用 ESLint 的格式类规则。
为什么 .vscode/settings.json 单独提交不管用
这个文件常被项目默认的 .gitignore 忽略,或者开发者手动删掉。结果新成员 clone 后,VS Code 会退回到内置格式器(比如 TypeScript 自带的),editor.tabSize 看似生效,但对 JS/TS 文件实际不参与 Prettier 格式化流程。
- 必须在
.gitignore里显式排除.vscode/settings.json和.vscode/extensions.json -
editor.defaultFormatter值必须精确匹配扩展 ID,比如"esbenp.prettier-vscode"少个i就静默失效 - 别在
settings.json里写editor.tabSize或files.insertFinalNewline—— 这些该由.editorconfig控制,否则 WebStorm 或 CLI 命令不认
prettier.requireConfig: true 不是可选项
不设这个,Prettier 就会在项目没有 .prettierrc 时 fallback 到 VS Code 内置格式器。现象是:同一份代码,A 电脑保存后引号变双,B 电脑变单;Vue 文件里 <script></script> 和 风格割裂;npm run format 和 Ctrl+S 输出不一致。
- 必须在
.vscode/settings.json中写"prettier.requireConfig": true - 项目根目录必须存在
.prettierrc或prettier.config.js,哪怕内容是空对象{}也行 - 别依赖全局安装的 Prettier:用
npm install --save-dev prettier@latest --save-exact,并在设置中指定"prettier.prettierPath": "./node_modules/prettier"
ESLint 和 Prettier 冲突的本质是职责没切干净
不是“谁让步”,而是必须让 ESLint 放弃所有格式类规则,只管逻辑问题(比如 no-unused-vars)。常见错误是只装了 eslint-plugin-prettier,却没关掉 ESLint 自带的 quotes、semi、comma-dangle 等规则,导致保存时反复横跳。
- 在
.eslintrc.json的extends数组里,除了"eslint:recommended"和"plugin:prettier/recommended",必须额外加"eslint-config-prettier" -
eslint-config-prettier的作用是关闭 ESLint 所有和格式相关的规则,它不提供任何新规则,只做“清道夫” - 验证是否成功:打开一个 JS 文件,删掉分号,保存——如果只修复了 ESLint 报错(如
no-console),但没自动加分号,说明格式类规则已正确剥离
最易被忽略的点是:团队配置落地 ≠ 装插件 + 写配置,而等于「配置文件进 Git + 工具链版本锁死 + 每次格式化都走同一路径」。只要有一个环节脱节,比如有人本地全局装了旧版 Prettier,或者 CI 流水线没读 .prettierrc,风格就会悄悄漂移。











