一、背景
https://github.com/typicode/husky#readme
gitHooks: commit-msg_snow@li的博客-CSDN博客
之前实践过这个配置，本文在vue3 + ts 的项目中，再记录一次。
二、使用
2.1、安装
2.1.1、安装husky
pnpm add husky
2.1.2、package.json
"scripts": { "prepare": "husky install", }
2.1.3、pnpm run prepare
pnpm run prepare
执行后：
2.2、初始化husky
npx husky install .husky
执行后：
2.3、package.json
"gitHooks": { "pre-commit": "lint-staged", "commit-msg": "node scripts/verify-commit-msg.js" }
2.4、安装chalk，vue3+ts使用4.X版本
pnpm add chalk@4.1.2
2.5、/scripts/verify-commit-msg.js
import chalk from 'chalk'; // 控制台日志标注样式 import fs from 'fs'; const msgPath = process.env.GIT_PARAMS || '.git/COMMIT_EDITMSG' // 读取到保存 git commit 时输入的描述信息的文件目录，一般路径如下：.git/COMMIT_EDITMSG const msg = fs.readFileSync(msgPath, 'utf-8').trim() const commitRE = /^(revert: )?(wip|release|feat|fix|polish|docs|style|refactor|perf|test|workflow|ci|chore|types|build)(\(.+\))?: .{1,50}/ if (!commitRE.test(msg)) { console.log() console.error( ` ${chalk.bgRed.white(' ERROR ')} ${chalk.red( `invalid commit message format.` )}\n\n` + chalk.red( ` Proper commit message format is required for automated changelog generation. Examples:\n\n` ) + ` ${chalk.green(`feat(compiler): add 'comments' option`)}\n` + ` ${chalk.green( `fix(v-model): handle events on blur (close #28)` )}\n\n` + chalk.red(` See .github/COMMIT_CONVENTION.md for more details.\n`) ) process.exit(1) }
2.6、添加一个commit msg钩子
npx husky add .husky/commit-msg "node scripts/verify-commit-msg.js"
2.7、测试提交
不规范示例：
规范示例：
经测试提交成功。
过程记录：
记录一、
ReferenceError require is not defined in ES module scope, you can use import instead_绘绘～的博客-CSDN博客
记录二、
const msgPath = process.env.GIT_PARAMS
const msgPath = process.env.GIT_PARAMS || '.git/COMMIT_EDITMSG'
GIT_PARAMS没有读到目录，本文使用静态目录，待后续研究。
记录三、
引入chalk、fs需要使用import，使用require报错
记录四、 git 钩子
