使用husky配置git代码提交规范

在团队开发中,保持一致的代码提交规范对于提高协作效率和代码管理质量至关重要。Husky是一个流行的Git钩子工具,它可以帮助我们在代码提交时运行脚本,以确保提交符合特定的规范和约定。本文将详细介绍如何使用Husky配置Git代码提交规范。

一、安装Husky

首先,确保你的项目已经初始化为Git仓库。然后,使用npm或yarn安装Husky:

npm install husky --save-dev  # 或者  
yarn add husky --dev

安装完成后,项目的package.json文件会更新,显示husky作为开发依赖。

二、配置Husky

1、启用Git钩子

在项目的package.json文件中添加prepare脚本,以自动启用Husky:


{  
  "scripts": {  
    "prepare": "husky install"  
  }  
}

运行npm install或yarn install后,Husky会自动设置Git钩子。

2、初始化Husky

执行以下命令进行Husky初始化,自动生成.husky文件夹:

npx husky install

或者,如果你已经在package.json中配置了prepare脚本,可以手动运行:

npm run prepare
3、添加Git钩子
  • pre-commit钩子:用于在每次提交前运行脚本,如代码格式检查、静态分析等。
npx husky add .husky/pre-commit "npm run lint"

这里的npm run lint是一个示例,你可以根据需要替换为其他脚本命令。

  • commit-msg钩子:用于在提交信息被保存之后运行,通常用于校验提交信息的格式。
npx husky add .husky/commit-msg 'npx --no-install commitlint --edit "$1"'

确保钩子脚本具有执行权限:

chmod +x .husky/commit-msg

三、配置Commitlint

Commitlint是一个用于检查提交信息是否符合预定规范的工具。我们需要安装Commitlint及其配置文件,并配置校验规则。

1、安装Commitlint
npm install @commitlint/config-conventional @commitlint/cli --save-dev
2、配置Commitlint






扫描下方二维码,关注公众号:程序进阶之路,实时获取更多优质文章推送。


扫码关注

评论