husky + commitlint: 提交较验 commit message

使用 npm/yarn

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

配置

{
  "script": {
    "prepare": "husky",
    "lint-staged": "lint-staged",
  },
  "lint-staged": {
    "*.{js,vue}": ["eslint --fix", "prettier --write"]
  }
}

使用命令

npx husky init

.commitlintrc.js

// .commitlintrc.js
// https://www.npmjs.com/package/@commitlint/config-conventional
// [
//   'build',
//   'chore',
//   'ci',
//   'docs',
//   'feat',
//   'fix',
//   'perf',
//   'refactor',
//   'revert',
//   'style',
//   'test'
// ];
module.exports = {
  extends: ['@commitlint/config-conventional'],
};

常用配置

• commit-msg
• pre-commit

# .husky/commit-msg
npx --no -- commitlint --edit ${1}
# .husky/pre-commit
npx lint-staged