@bwt-st/prettier
v0.2.1
Published
Shared Prettier configuration for BWT-ST projects.
Readme
@bwt-st/prettier
BWT-ST 项目的共享 Prettier 配置和 .prettierignore 模板,统一代码格式,减少业务项目重复配置。
安装
pnpm add -D @bwt-st/prettier prettier配置
在业务项目根目录创建 prettier.config.js:
export { default } from '@bwt-st/prettier'当前配置为:
| 配置项 | 值 |
| --------------- | ------- |
| semi | false |
| singleQuote | true |
| trailingComma | 'all' |
复制忽略文件到业务项目根目录:
cp node_modules/@bwt-st/prettier/ignore .prettierignore忽略模板包含 node_modules、dist、coverage、.pnpm-store 和 *.tgz。
使用
检查格式:
pnpm exec prettier --check .自动格式化:
pnpm exec prettier --write .也可以在 package.json 中加入脚本:
{
"scripts": {
"format": "prettier --write .",
"format:check": "prettier --check ."
}
}说明
本包只提供 Prettier 配置和忽略文件,不包含 ESLint 规则。需要代码质量检查时,请单独安装并配置 @bwt-st/eslint。
配置文件使用 ESM 语法,业务项目应启用 ESM,或按自身模块系统改写配置加载方式。
兼容性
- Node.js
>=20.19.0 - Prettier
>=3.0.0
