# 项目中集成 Git Hooks 工具

# 一、配置 prettier

安装创建

npm i -D --save-exact prettier
npm i -D eslint-config-prettier
echo {}> .prettierrc.json
echo > .prettierignore

1
2
3
4

.prettierignore 文件写入

build
coverage

1
2

# 二、添加插件

husky 和 lint-staged，以及 commitlint

npx mrm@2 lint-staged
npm install --save-dev @commitlint/config-conventional @commitlint/cli
echo "module.exports = {extends: ['@commitlint/config-conventional']}" > commitlint.config.js
npx husky add .husky/commit-msg "npx --no-install commitlint --edit $1"

1
2
3
4

.eslintrc.js 文件写入

"extends": [
  "prettier"
]

1
2
3

package.json 文件写入

"lint-staged": {
  "*.{js,css,html,md,ts,tsx,vue}": "eslint --cache --fix"
},
"husky": {
    "hooks": {
      "pre-commit": "lint-staged",
      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
    }
},

1
2
3
4
5
6
7
8
9

# 三、默认规则

build : 更改构建系统和外部依赖项（如将 gulp 改为 webpack，更新某个 npm 包）
ci : 对 CI 配置文件和脚本的更改
docs : 仅仅修改文档说明
feat : 增加一个新特性
fix : 修复一个 bug
perf : 更改代码以提高性能
refactor : 代码重构时使用
style : 不影响代码含义的改动，例如去掉空格、改变缩进、增删分号
test : 增加新的测试功能或更改原有的测试模块

1
2
3
4
5
6
7
8
9

← 如何创建发布