用开源的方式扩展 git hooks 的能力，为开发提速！

git hooks 是一种强大的工具，可以帮助开发人员在提交代码之前检查代码质量、运行单元测试、格式化代码等，它可以显著提高开发效率，并确保代码质量。husky 是一个流行的 git hooks 库，它提供了一系列开箱即用的 git hooks，可以帮助开发人员轻松地实现这些检查。在本文中，我们将介绍如何使用 husky 来扩展 git hooks 的能力，为开发提速。

husky 简介

husky 是一个 JavaScript 库，它提供了一系列开箱即用的 git hooks。这些 git hooks 可以帮助开发人员在提交代码之前检查代码质量、运行单元测试、格式化代码等。husky 是一个非常轻量级的库，它不会对项目造成任何影响。

安装 husky

要安装 husky，可以使用以下命令：

npm install husky -D

安装完成后，需要在项目根目录下创建一个名为 ".husky" 的文件夹。这个文件夹用于存放 git hooks。

配置 husky

在 ".husky" 文件夹下，需要创建一个名为 "husky.js" 的文件。这个文件用于配置 husky。在 "husky.js" 文件中，可以使用以下代码来配置 husky：

module.exports = {
  hooks: {
    'pre-commit': 'npm run lint-staged',
    'commit-msg': 'commitlint -E HUSKY_GIT_PARAMS',
    'pre-push': 'npm run test'
  }
};

在上面的代码中，我们配置了三个 git hooks。分别是：

• pre-commit：在提交代码之前，运行 "npm run lint-staged" 命令。这个命令将使用 ESLint 来检查代码的格式是否正确。
• commit-msg：在提交代码时，使用 "commitlint" 来检查提交信息的格式是否正确。
• pre-push：在推送代码之前，运行 "npm run test" 命令。这个命令将使用 Jest 来运行单元测试。

使用 husky

配置好 husky 之后，就可以使用它了。要使用 husky，只需要在终端中运行 "git commit" 命令。husky 会自动执行配置好的 git hooks。

扩展 husky 的能力

husky 提供了一系列开箱即用的 git hooks，但这些 git hooks并不能满足所有开发人员的需求。因此，husky 提供了扩展的能力，开发人员可以根据自己的需求来扩展 husky 的能力。

要扩展 husky 的能力，需要在 ".husky" 文件夹下创建一个名为 "hooks" 的文件夹。这个文件夹用于存放自定义的 git hooks。在 "hooks" 文件夹下，创建一个与 git hook 名称相同的文件。例如，要创建一个名为 "pre-commit" 的 git hook，需要在 "hooks" 文件夹下创建一个名为 "pre-commit" 的文件。

在自定义的 git hook 文件中，可以编写任何代码。例如，可以在 "pre-commit" 文件中编写以下代码：

#!/usr/bin/env sh

# 检查代码的格式是否正确
eslint --fix .

# 运行单元测试
jest

在上面的代码中，我们首先使用 ESLint 来检查代码的格式是否正确。如果代码的格式不正确，则 ESLint 会自动修复代码的格式。然后，我们使用 Jest 来运行单元测试。

总结

husky 是一个非常强大的 git hooks 库，它可以帮助开发人员在提交代码之前检查代码质量、运行单元测试、格式化代码等。husky 可以显著提高开发效率，并确保代码质量。在本文中，我们介绍了如何使用 husky 来扩展 git hooks 的能力，为开发提速。