使用 ESLint 统一 JavaScript 的代码风格,husky 管理 git 的钩子函数,并且规定了 git 的提交日志格式,确保代码的可维护性。要使用 Husky 设置提交规范,您需要按照以下步骤操作:
-
安装 Husky:在项目的根目录下运行以下命令来安装 Husky 和它的依赖:
npm install husky --save-dev
-
创建 Git 钩子脚本:在项目的根目录下创建一个名为
.husky
的文件夹,并在其中创建一个名为pre-commit
的文件,该文件是 Git 提交前触发的钩子脚本。在pre-commit
文件中,您可以使用任何脚本语言(如 Bash、JavaScript 等)来设置提交规范。例如,使用 Bash 脚本来设置提交规范,可以在
pre-commit
文件中添加以下内容:#!/bin/sh npx commitlint --edit $1
在这个例子中,我们使用了
commitlint
工具来进行提交规范的验证。您可以根据自己的需求选择其他工具。 -
设置 Git 钩子:在项目的根目录下的
package.json
文件中,添加以下内容来设置 Git 钩子:{ "scripts": { "prepare": "husky install", "commitmsg": "npx commitlint -e $GIT_PARAMS" } }
在这个例子中,我们使用了
commitlint
工具来验证提交信息的规范性。 -
安装和配置提交规范工具:根据您选择的提交规范工具,您可能需要进行一些额外的安装和配置。例如,如果您选择使用
commitlint
工具,您需要按照它的文档来进行安装和配置。 -
运行 Husky:运行以下命令来启用 Husky:
npm run prepare
这将安装和配置 Husky,使其能够在提交前运行相应的钩子脚本。
现在,当您执行 Git 提交时,Husky 将自动触发设置的钩子脚本,从而进行提交规范的验证。如果提交不符合规范,将会出现相应的错误提示,并且提交将被阻止。