git husky

git husky

Git husky 是一个用于强制规范 git 操作的工具，可以通过配置 pre-commit、commit-msg 等 git 钩子(hooks)在 git 操作前执行自定义脚本。Husky 可以帮助团队保持代码风格一致，避免一些常见的错误，提高开发效率和代码质量。

什么是 Git Hooks

Git 钩子(hooks)是一些在 Git 执行特定动作时被触发的脚本。它们位于 .git/hooks 目录下，是可执行文件，可以通过编写 Shell 脚本或其他可执行文件来定制 Git 操作的行为。常见的 Git 钩子有 pre-commit、commit-msg、pre-push 等。

Pre-commit 钩子

Pre-commit 钩子会在执行 git commit 操作前被触发，可以在此时运行一些代码风格检查、静态代码分析等操作，如果脚本运行失败，则会阻止 commit 操作。这样可以避免一些低级错误的提交。

Commit-msg 钩子

Commit-msg 钩子会在执行 git commit 操作时被触发，可以在此时验证提交信息的格式是否符合规范，例如是否包含 Jira ID、是否符合指定的提交信息格式等。

Pre-push 钩子

Pre-push 钩子会在执行 git push 操作前被触发，可以在此时运行一些测试、代码校验操作，如果检查失败，则会阻止 push 操作。

Husky 的作用

Husky 是一个 Git hooks 工具，通过 Husky 可以方便地在项目中配置 pre-commit、commit-msg 等钩子，用于规范提交的代码和提交信息。

Husky 主要有以下几个作用：

• 代码规范检查：在 pre-commit 钩子中运行代码风格检查、静态代码分析等操作，提高代码质量。
• 提交信息校验：在 commit-msg 钩子中验证提交信息的格式是否符合规范，提高提交信息的可读性。
• 阻止不符合规范的提交：如果代码不符合规范或提交信息格式不正确，可以阻止提交操作，避免低质量的提交。

如何在项目中使用 Husky

以下是在项目中使用 Husky 的步骤：

安装 Husky

首先，需要在项目中安装 Husky 包：

npm install husky --save-dev

或者

yarn add husky --dev

配置 Husky

在项目根目录下创建 husky.config.js 文件，并编写配置：

module.exports = {
  hooks: {
    'pre-commit': 'npm run lint',
    'commit-msg': 'npm run validate-commit-msg'
  }
}

上面的配置中，我们配置了 pre-commit 钩子执行 npm run lint 命令进行代码规范检查，commit-msg 钩子执行 npm run validate-commit-msg 命令进行提交信息校验。

安装 Git hooks

运行以下命令，安装 Git hooks：

npx husky install

启用 Git hooks

运行以下命令，启用 Git hooks：

npx husky add .husky/pre-commit "npx --no-install lint-staged"
npx husky add .husky/commit-msg "npx --no-install commitlint --edit $1"

测试

现在可以测试 Husky 是否正常工作了，尝试提交一次代码，看看是否会执行 lint 和 validate-commit-msg 操作。如果代码不符合规范或提交信息格式不正确，提交将被阻止。

总结

Git husky 是一个非常有用的工具，可以帮助团队保持代码规范，避免一些低级错误的提交，提高代码质量并提高开发效率。通过配置 pre-commit、commit-msg 等 Git 钩子，可以实现对提交代码和提交信息的检验和校验。

在现代的团队开发中，使用 Git husky 是一个很好的选择，可以保证团队成员在提交代码时都遵循相同的规范，减少代码质量问题和沟通成本。