宁夏城乡和住房建设厅网站,网站的建设与规划方案,环球易购招聘网站建设,wordpress首页聚合介绍
Git Husky 是一个可以管理 Git Hooks 的工具#xff0c;它可以帮助我们在代码提交的时候运行脚本#xff0c;以确保代码提交符合特定的规范和约定。
在 Git 中#xff0c;允许在操作特定的事件时执行特定的脚本#xff0c;这些事件我们称之为 Hooks。
Git Husky 利…介绍
Git Husky 是一个可以管理 Git Hooks 的工具它可以帮助我们在代码提交的时候运行脚本以确保代码提交符合特定的规范和约定。
在 Git 中允许在操作特定的事件时执行特定的脚本这些事件我们称之为 Hooks。
Git Husky 利用这些 Hooks 实现了在代码提交前、提交信息规范校验等自动化运行脚本的功能。
安装与配置
1、安装
yarn add husky -D首先我们需要在项目内安装 husky并且初始化。
2、添加配置
npx husky install执行 npx husky install 将会生成 ./husky 的文件夹在这里我们可以配置 Git Hooks 的脚本文件。
3、初始化
npm pkg set scripts.preparehusky install执行 npm pkg set scripts.preparehusky install 将会设置 prepare 的脚本并将该脚本的执行命令设置为 husky install它将会在项目启动时初始化 Git Husky。
4、添加 pre-commit hook
npx husky add .husky/pre-commit执行 npx husky add .husky/pre-commit 将会生成脚本 ./husky/pre-commit 它会在 git commit 之前执行脚本如果脚本报错的情况下将无法提交。
#!/usr/bin/env sh
. $(dirname -- $0)/_/husky.shundefined5、配置执行脚本
在我们常用的场景中我们需要在 git commit 之前对脚本进行代码规范的检测。
#!/usr/bin/env sh
. $(dirname -- $0)/_/husky.shnpm run lint我们将命令修改以上配置它将会在 git commit 之前执行 npm run lint 命令来执行 eslint 代码检测如果检测不通过将会拒绝提交。
当然你也可以通过 npx husky add .husky/pre-commit npm run lint 命令直接生成脚本。
7、添加 commit-msg hook
npx husky add .husky/commit-msg npx --no-install commitlint --edit $1commit-msg hooks 用于提交信息被保存之后运行。
8、commitlint 校验
yarn add commitlint/cli -D我们通常使用 commitlint 工具对提交信息格式进行校验所以我们需要安装 commitlint/cli 。
9、常用配置
yarn add commitlint/config-conventional -Dcommitlint/config-conventional 是一个符合提交信息规范的配置我们可以直接使用。
在 commitlint/config-conventional 的规范中为我们提供了一下规则。
分类描述feat新特性fix修复 bugperf性能优化refactor代码重构build外部依赖项的更改chore测试文件的更改ci修改构建配置或脚本docs仅文档修改revert撤销之前的提交test添加或修正测试用例
新建文件 commitlint.config.cjs 导入 commitlint/config-conventional 规则。
module.exports {extends: [commitlint/config-conventional],
};10、测试
git commit -m 修复了bug // ×
git commit -m fix: 修复了bug // √通过分别执行以上代码我们发现当提交的信息不符合规范时Git Hooks 拒绝了我们的提交。
总结
Git husky 是一个 Git hooks 管理的工具它可以帮助我们在代码提交时运行脚本确保代码提交符合特定的规范和约定。 通过 husky 可以自动化地运行脚本避免了手动操作的繁琐性提高了效率。 在代码提交前、提交信息保存后等多个阶段进行校验和处理保证了代码质量和规范性。 可以结合其他工具和规范进行使用如 ESLint、Prettier、commitlint 等增加了灵活性和可扩展性。
写在最后
感谢你的阅读~
如果你有任何的疑问欢迎您在后台私信我们一同探讨学习
如果觉得这篇文章对你有所帮助点赞、在看是最大的支持
