1. 核心配置 (必需)
创建 .prettierrc
文件:
{
"semi": false,
"singleQuote": true,
"trailingComma": "all",
"printWidth": 100,
"tabWidth": 2,
"useTabs": false,
"endOfLine": "lf"
}
2. 版本锁定 (必需)
在 package.json
中添加:
{
"devDependencies": {
"prettier": "3.2.5" // 固定具体版本
},
"scripts": {
"format": "prettier --write .",
"format:check": "prettier --check ."
}
}
安装依赖:
npm install --save-dev prettier@3.2.5
使用流程
1.新成员接入:
git clone your-project
npm install
2.开发时:
保存文件时自动格式化 (VSCode)
或手动运行:npm run format
3.提交前检查(可选):
npm run format:check # CI 可集成此命令
优势说明
-
零学习成本:仅依赖 Prettier 单工具
-
强制生效:通过 VSCode 配置实现保存即格式化
-
版本锁定:确保所有成员使用完全相同的格式化规则
-
跨平台一致:LF 换行符 + 空格缩进配置解决 OS 差异