Create-React-App项目代码规范配置
1、安装Prettier
yarn add --dev --exact prettier
2、创建Prettier配置文件
- 在根目录创建Prettierrc.json文件,用来配置prettier
echo {}> .prettierrc.json
- 创建prettier的忽略文件
echo build coverage> .prettierignore
3、配置Git钩子
- 安装lint-staged
npx mrm@2 lint-staged
- 如果使用Typescript,需要增加文件扩展名
# 修改package.json中的lint-staged, 添加ts、tsx扩展名
"lint-staged": {
"*.{js,css,md,ts,tsx}": "prettier --write"
}
原因:为了团队代码的一致性,需要在Git提交代码时进行格式化
4、解决Prettier和Eslint冲突
- 利用Prettier插件覆盖Eslint冲突的部分
yarn add -D eslint-config-prettier
- 修改package.json中eslintConfig的配置
"eslintConfig": {
"extends": [
"react-app",
"react-app/jest",
"prettier"
]
},
5、解决提交代码时,提交信息不规范的问题
- 检查提交信息是否规范的插件
yarn add -D @commitlint/config-conventional @commitlint/cli
echo "module.exports = {extends: [‘@commitlint/config-conventional‘]};" > commitlint.config.js
- 添加Hook
npx husky add .husky/commit-msg ‘npx --no-install commitlint --edit "$1"‘
6、大功告成
git commit -m "fix: 配置了代码规范"