项目全局格式化配置
要全局设置格式化: 首先,确保Prettier已经被安装为项目的开发依赖。可以通过npm或yarn来安装:
- 安装Prettier:
bash npm install --save-dev prettier
# 或者使用yarn
yarn add --dev prettier
1、配置Prettier:
Prettier可以使用项目内的配置文件来定制化格式化规则。常见的配置文件包括.prettierrc, .prettierrc.json, 或者在package.json内的prettier字段。例如创建一个.prettierrc文件,并设置一些基本规则:
{
"eslintIntegration": true,
"stylelintIntegration": true,
"tabWidth": 2,
"printWidth": 120,
"singleQuote": true,
"semi": true,
"arrowParens": "avoid",
"trailingComma": "none",
"bracketSpacing": true
}
2、添加脚本到package.json:
确保package.json文件中包含了之前提到的脚本定义。如果还没有,可以在scripts对象内添加:
json "scripts": {
"lint:prettier": "prettier --write \"src/**/*.{js,ts,json,tsx,css,scss,vue,html,md}\""
}
- 团队协作与版本控制
- 如果项目使用版本控制系统(如Git),考虑将
.prettierrc*配置文件或者package.json中的Prettier配置部分纳入版本控制,确保团队成员共享相同的格式化规则。 - 可以设置Git的预提交钩子(pre-commit hook),自动在提交前运行
lint:prettier,保证提交的代码都是格式化的。这通常通过husky和lint-staged等工具实现。
- 如果项目使用版本控制系统(如Git),考虑将
完成以上步骤后,就可以在项目中运行npm run lint:prettier或yarn lint:prettier命令来自动格式化相应文件夹下的代码了。
本文由博客一文多发平台 OpenWrite 发布!