Git 提交规范怎么落地？husky + commitlint 配置后不生效怎么排查？

Question

仓乃文 · Accepted Answer

团队约定了 Git 提交规范（feat/fix/docs...），但总有人不遵守。配置了 husky + commitlint 后发现不生效，提交不规范信息照样能提交。配置步骤： ```bash # 1. 安装依赖 npm install --save-dev husky @commitlint/cli @commitlint/config-conventional # 2. 初始化 husky npx husky init # 3. 添加 commit-msg 钩子 echo "npx --no -- commitlint --edit \$1" > .husky/commit-msg # 4. 配置 commitlint # commitlint.config.js module.exports = { extends: ["@commitlint/config-conventional"], }; # 5. 配置 pre-commit 钩子 echo "npx lint-staged" > .husky/pre-commit ``` 提交规范格式： ``` (): 类型：feat/fix/docs/style/refactor/perf/test/build/ci/chore 示例： git commit -m "feat(auth): 添加用户登录功能" git commit -m "fix(api): 修复请求超时重试失败" ``` 不生效排查清单： ```bash # 1. 检查钩子文件是否存在 cat .husky/commit-msg # 2. 检查执行权限 chmod +x .husky/commit-msg .husky/pre-commit # 3. 检查 prepare 脚本 # package.json { "scripts": { "prepare": "husky" } } # 4. 检查 git hooks 路径 git config core.hooksPath # 应该输出 .husky，如果为空：git config core.hooksPath .husky # 5. 检查是否用了 --no-verify 跳过钩子 # 禁止使用 --no-verify！ # 6. 检查 IDE 是否触发钩子 # VS Code Git 插件可能不触发钩子，建议终端提交 # 7. Husky 9 不再需要 husky.sh # 钩子文件直接放在 .husky/ 目录 ``` lint-staged 配置： ```json { "lint-staged": { "*.{js,jsx,ts,tsx}": ["eslint --fix", "prettier --write"], "*.{css,scss}": ["stylelint --fix", "prettier --write"], "*.{json,md}": ["prettier --write"] } } ``` 补充说明： - 规则：husky + commitlint + lint-staged 三件套是团队规范的基石 - 钩子文件必须有执行权限 - git config core.hooksPath 必须指向 .husky - 禁止使用 --no-verify 绕过钩子 - IDE 提交可能不触发钩子，建议在终端提交