最近刚好项目需要提交规范,同时参考了一些博文,大部分博文中的步骤调试不通,所以记录一下自己调试步骤给需要的人参考一下。
--安装前准备:--
环境依赖:npm (mac: brew install nodejs即可)因比较简单跳过
--正式开始--
1.项目跟目录,创建package.json文件
项目跟目录运行命令:npm init -y
2.配置commitlint
2.1安装包
命令:npm install --save-dev @commitlint/config-conventional @commitlint/cli
2.2 创建 commitlint.config.js 文件 (UTF-8 格式)
这里又一份文件可以拿来参考:
[代码片段](https://code.juejin.cn/pen/7133406427787296801)
3.安装配置husky、git钩子
3.1 安装依赖 :npm install husky --save-dev
3.2 启动 hooks, 生成 .husky 文件夹 :npx husky install
3.3 package.json 中生成 prepare指令 :npm pkg set scripts.scriptname="husky install"
3.4 执行 prepare 指令 :npm run prepare———— (执行不成功可以跳过先)
3.5 添加 commitlint 的 hook 到 husky 中,commit-msg 时进行校验 :npx husky add .husky/commit-msg 'npx --no-install commitlint --edit "$1"'
PS:commit示例: git commit -m “fix: 111” (fix: 后面有个空格【大坑】)