使用 husky 管理 git 的钩子函数,在每次代码提交至 git 之前去执行 ESLint,只有 ESLint 的校验通过,commit 才能执行成功

文章介绍了如何利用Husky管理git钩子,结合ESLint统一JavaScript代码风格,并设定提交日志格式,以提升代码的可维护性。主要步骤包括安装Husky,创建.git/husky/pre-commit文件,设置Git钩子脚本,配置commitlint验证提交信息,以及启用Husky进行自动化验证。
摘要由CSDN通过智能技术生成

使用 ESLint 统一 JavaScript 的代码风格,husky 管理 git 的钩子函数,并且规定了 git 的提交日志格式,确保代码的可维护性。要使用 Husky 设置提交规范,您需要按照以下步骤操作:

  1. 安装 Husky:在项目的根目录下运行以下命令来安装 Husky 和它的依赖:

    npm install husky --save-dev
    
  2. 创建 Git 钩子脚本:在项目的根目录下创建一个名为 .husky 的文件夹,并在其中创建一个名为 pre-commit 的文件,该文件是 Git 提交前触发的钩子脚本。在 pre-commit 文件中,您可以使用任何脚本语言(如 Bash、JavaScript 等)来设置提交规范。

    例如,使用 Bash 脚本来设置提交规范,可以在 pre-commit 文件中添加以下内容:

    #!/bin/sh
    npx commitlint --edit $1
    

    在这个例子中,我们使用了 commitlint 工具来进行提交规范的验证。您可以根据自己的需求选择其他工具。

  3. 设置 Git 钩子:在项目的根目录下的 package.json 文件中,添加以下内容来设置 Git 钩子:

    {
      "scripts": {
        "prepare": "husky install",
        "commitmsg": "npx commitlint -e $GIT_PARAMS"
      }
    }
    

    在这个例子中,我们使用了 commitlint 工具来验证提交信息的规范性。

  4. 安装和配置提交规范工具:根据您选择的提交规范工具,您可能需要进行一些额外的安装和配置。例如,如果您选择使用 commitlint 工具,您需要按照它的文档来进行安装和配置。

  5. 运行 Husky:运行以下命令来启用 Husky:

    npm run prepare
    

    这将安装和配置 Husky,使其能够在提交前运行相应的钩子脚本。

现在,当您执行 Git 提交时,Husky 将自动触发设置的钩子脚本,从而进行提交规范的验证。如果提交不符合规范,将会出现相应的错误提示,并且提交将被阻止。

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值