前端代码规范之 Husky

Git Husky介绍和使用指南

目录

• 1. 简介

• 2. Git Hook的概念

• 3. 为什么使用Git Husky？

• 4. 如何安装Git Husky？

• 5. 使用Git Husky的示例

• 6. 总结

1. 简介

Git Husky 是一个Git辅助工具，它允许开发人员在代码提交前或者推送前执行自定义的脚本，来保证代码的质量和一致性。它基于Git的钩子函数（Git Hooks）机制，可以在特定的Git事件触发时执行一些自定义操作。

2. Git Hook的概念

Git Hooks 是一种在特定Git事件发生时触发执行的脚本。Git钩子分为两种类型：客户端钩子和服务器端钩子。客户端钩子是在本地仓库上触发的，比如提交代码前的钩子；服务器端钩子是在远程仓库上触发的，比如推送代码前的钩子。

3. 为什么使用Git Husky？

Git Husky 简化了Git Hooks配置的过程，让我们能够更方便地引入自定义脚本。通常，使用Git Hook可以做以下几方面的工作：

• 在代码提交前或推送前运行代码质量检查、单元测试等。
• 阻止包含错误或非法代码的提交或推送。
• 规范化代码提交信息的格式，以便后续统计和分析。

4. 如何安装Git Husky？

在项目的根目录下，打开终端执行以下命令来安装Git Husky：

npm install husky --save-dev

5. 使用Git Husky的示例

在这个示例中，我们将使用Git Husky来验证代码提交信息的格式，以确保符合规范。首先，在终端中导航到项目的根目录，并执行以下命令：

npx husky install

这将在项目中创建一个.husky目录，并在.git目录的 hooks目录中创建一个commit-msg文件。接下来，在.husky目录中创建一个commit-msg脚本：

#!/bin/sh
. "$(dirname "$0")/_/husky.sh"

commit_msg=$(cat $1)
pattern="^(\w)+-(\d)+: .+$"

if [[ ! $commit_msg =~ $pattern ]]; then
  echo "Error: Commit message should match pattern: <issue_number>: <commit_message>"
  exit 1
fi

这个脚本会检查提交信息的格式是否符合<issue_number>: <commit_message>的要求。如果提交信息不匹配，它会显示一个错误，并阻止代码的提交。

最后，在终端中执行以下命令来激活Git Husky：

npx husky add .husky/commit-msg 'bash .husky/commit-msg'

现在，每次你尝试提交代码时，Git Husky都会验证提交信息的格式，并阻止错误格式的提交。

6. 总结

通过Git Husky，我们可以轻松地引入Git Hook，增加代码的质量和一致性。它可以用于许多不同的场景，如代码质量检查、单元测试和提交信息规范等。通过本文的示例，你可以开始体验并探索Git Husky在你的项目中的应用。

至此，我们已经了解了Git Husky的基本概念、如何安装以及一个简单的示例。希望这篇文章对你理解和使用Git Husky有所帮助。

参考链接：

• Husky Documentation