GitHook 工具 —— husky 配置

husky 是一個 Git Hook 工具。本文主要實現提交前 eslint 校驗和 commit 信息的規範校驗。

1. 安裝 husky，lint-staged，@commitlint/cli，@commitlint/config-conventional 依賴

lint-staged: 用於實現每次提交只檢查本次提交所修改的文件。

npm i -D husky lint-staged @commitlint/cli @commitlint/config-conventional

注意：一定要使用 npm 安裝 eslint 和 husky，因爲在 windows 操作系統下, 用 yarn 安裝依賴，不會觸發 husky pre-commit 鉤子命令。

2. 創建 .huskyrc

{
  "hooks": {
    "pre-commit": "lint-staged",
    "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
  }
}

3. 創建 .lintstagedrc

{
  "src/**/*.js": "eslint"
}

設置 fix 可以自動修復錯誤：

{
   "src/**/*.js": ["eslint --fix", "git add"]
}

或者使用下面的配置，自動格式化代碼（謹慎使用）：

{
   "src/**/*.js": ["prettier --write", "git add"]
}

4. 創建 commitlint.config.js

module.exports = {
  extends: ['@commitlint/config-conventional'],
  rules: {
    'type-enum': [
        2,
        'always',
        [
        'feat', // 新功能（feature）
        'fix', // 修補bug
        'docs', // 文檔（documentation）
        'style', // 格式（不影響代碼運行的變動）
        'refactor', // 重構（即不是新增功能，也不是修改bug的代碼變動）
        'test', // 增加測試
        'revert', // 回滾
        'config', // 構建過程或輔助工具的變動
        'chore', // 其他改動
        ],
    ],
    'type-empty': [2, 'never'], // 提交不符合規範時,也可以提交,但是會有警告
    'subject-empty': [2, 'never'], // 提交不符合規範時,也可以提交,但是會有警告
    'subject-full-stop': [0, 'never'],
    'subject-case': [0, 'never'],
  }
}