@hootool/prettier-config
v0.1.0
Published
统一 Prettier 格式化配置
Readme
@hootool/prettier-config
统一 Prettier 格式化配置,适用于 Prettier 3.x。
安装
pnpm add -D @hootool/prettier-config prettier使用
在项目根目录创建 .prettierrc.json:
"@hootool/prettier-config"或在 package.json 中:
{
"prettier": "@hootool/prettier-config"
}配置项
| 选项 | 值 | 说明 |
|------|-----|------|
| semi | true | 语句末尾加分号 |
| singleQuote | true | JS/TS 使用单引号 |
| jsxSingleQuote | false | JSX 使用双引号 |
| trailingComma | all | 尾随逗号 |
| printWidth | 80 | 每行最大宽度 |
| tabWidth | 2 | 缩进 2 空格 |
| arrowParens | always | 箭头函数参数始终加括号 |
| endOfLine | lf | 统一 LF 换行 |
| bracketSpacing | true | 对象字面量花括号内加空格 |
| bracketSameLine | false | JSX 闭合括号不换行 |
| quoteProps | as-needed | 对象属性按需加引号 |
| proseWrap | preserve | Markdown 保持原样 |
| htmlWhitespaceSensitivity | ignore | HTML 忽略空白敏感性 |
| embeddedLanguageFormatting | auto | 自动格式化嵌入代码 |
与 ESLint 配合
本配置已通过 eslint-config-prettier(包含在 @hootool/eslint-config 中)自动关闭所有与 Prettier 冲突的 ESLint 规则,无需额外配置。
建议配合 lint-staged + husky 在提交前自动格式化:
pnpm add -D husky lint-staged// package.json
{
"lint-staged": {
"*.{js,jsx,ts,tsx}": ["eslint --fix", "prettier --write"],
"*.{css,scss,less}": ["stylelint --fix", "prettier --write"],
"*.{json,md}": ["prettier --write"]
}
}