husky 优化您的提交记录和其他功能,能自动检查提交信息、代码,并在提交或推送时运行测试。
lint-staged 是一个在Git暂存区的文件上运行代码检查的工具。
二者配合使用,在代码提交前的hook中加入lint-staged命令,对即将提交的代码进行格式化。
一、 husky
1. install
pnpm add --save-dev husky
2. husky init
pnpm exec husky init
二、lint-staged
1. install
pnpm add --save-dev lint-staged
2. 加入husky的hook中
# .husky/pre-commit
pnpm lint-staged
3. 配置lint-staged
- 直接在package.json中配置
"lint-staged": {
"*.{tsx,jsx,ts,js}": [
"prettier --write"
],
"*.{scss}": [
"stylelint --fix"
]
}
- 创建文件.lintstagedrc.json(或yaml文件)
{
"*.{tsx,jsx,ts,js}": [
"prettier --write"
],
"*.{scss}": [
"stylelint --fix"
]
}
三、补全依赖
1. 安装使用prettier
- 安装
pnpm add --save-dev --save-exact prettier
创建.prettierrc,新增配置
格式化所有文件
pnpm exec prettier . --write
2. 安装使用stylelint
- 安装
pnpm add --save-dev stylelint stylelint-config-standard-scss
创建.stylelintrc.json文件,新增配置
在.stylelintrc.json文件中新增
"extends": "stylelint-config-standard-scss"
3. 安装使用eslint
- 安装
pnpm add -save-dev eslint
- 生成配置文件
npx eslint --init