Git commit规范：使用husky让你的提交更规范

前端

2023-12-18 13:59:34

正文

在团队协作的开发过程中，为了保证代码质量和提高开发效率，通常会制定一些commit规范，比如提交代码前需要先进行代码审查，提交时需要填写详细的提交信息，等等。

而要实现这些规范，通常需要通过人工来检查和执行，这不仅繁琐，而且容易出错。为了解决这个问题，我们可以借助一些工具来实现commit规范的自动化，比如husky。

Husky是一个用于git钩子的npm包，它可以让我们在git提交代码时，自动执行一些脚本。比如，我们可以使用husky来强制执行commit规范，或者在提交代码前自动运行一些代码检查工具。

下面我们来看一下如何使用husky来实现commit规范。

安装husky

首先，我们需要安装husky。我们可以使用以下命令来安装husky：

npm install husky --save-dev

配置husky

安装husky之后，我们需要在项目中配置husky。我们可以创建一个名为.husky的文件夹，并在该文件夹中创建一个名为pre-commit的文件。

mkdir .husky
touch .husky/pre-commit

pre-commit文件是husky在提交代码前执行的脚本。我们可以使用任何脚本语言来编写pre-commit文件，比如JavaScript、Shell、Python等。

使用husky强制执行commit规范

接下来，我们就可以使用husky来强制执行commit规范了。我们可以使用以下代码来实现：

#!/usr/bin/env node
const { exec } = require('child_process');

exec('npm run lint', (err, stdout, stderr) => {
  if (err) {
    console.error(err);
    process.exit(1);
  }

  if (stdout.indexOf('Found some errors') !== -1) {
    console.error('There are some lint errors. Please fix them before committing.');
    process.exit(1);
  }
});