在项目中添加git comit hook

430 阅读1分钟

添加git提交前的校验

一、自动配置(推荐)

  1. 执行,下面两个命令的任何一个即可。
    • $ npx husky-init && npm install
    • $ npx husky-init && yarn
  2. 设置git commit之前执行npm test
    • $ npx husky add .husky/pre-commit "npm test"

二、手动配置

  1. 安装

    • $ npm install husky --save-dev
  2. 启用git挂钩

    • $ npx husky install
  3. npm install之后,自动启用git hooks,有以下两种方式

    • 第一种执行npm命令进行设置

      • $ npm set-script prepare "husky install"
    • 第二种:修改package.json文件

      • // package.json
        {
          "scripts": {
            "prepare": "husky install"
          }
        }
        
  4. 创建一个git hook

    • npx husky add .husky/pre-commit "npm test"
  5. 完成之后会生成.husky目录,并且会在.husky/pre-commit中添加npm test

    • image-20210416141506951.png

卸载:

  • 执行命令npm uninstall husky

参考文档