git commit前检测husky与pre-commit

一、前言

现在最流行的版本管理工具非git莫属,而良好的代码规范有助于项目的维护,为了防止一些不规范的代码 commitpush到远端,我们可以在git命令执行前用一些钩子来检测并阻止。现在大前端主要有两种git钩子插件:husky(jquery与next.js都在用),pre-commit(antd在用)。
下面我将现介绍一个git钩子,再介绍下huskypre-commit的用法

二、git钩子

用过git的小伙伴们都知道git有很多命令commitpushrebase等等。那这些命令主要是在执行.git文件夹中的东西,那么git 钩子目录就是在.git文件夹的hooks下,如下所示:

    cd .git/hooks
    ls -l
hook.png

上图为各个钩子的案例脚本,可以把sample去掉,直接编写shell脚本来执行。
而前端的小伙伴们则可以用插件huskypre-commit,来使钩子生效。

注意: 一般.git为隐藏文件,可以把项目拖入IDE中查看,.git文件里的内容一般不允许手动更改的。

三、husky

husky能够防止不规范代码被commit、push、merge等等。
首先安装husky

    npm install husky --save-dev

    yarn add husky --dev

编辑package.json文件,如:

{
  "scripts": {
    "precommit": "webpack  --config ./web/webpack.config.js",
    "...": "..."
  }
}

当你git commit的时候,将会现现执行 precommit里的脚本,没有问题了再提交。

husky.png

具体案例可查看https://github.com/raoenhui/create-img

四、pre-commit

pre-commit能够防止不规范代码被commit,没有husky这么全面,但是你可以接着安装pre-push等插件来防止对应的git操作。下面以pre-commit为例:

首先安装pre-commit

    npm install pre-commit --save-dev

编辑package.json文件,如:

"scripts": {
    "test": "echo \"Error: I SHOULD FAIL LOLOLOLOLOL \" && exit 1",
    "foo": "echo \"fooo\" && exit 0",
    "bar": "echo \"bar\" && exit 0"
  },
  "pre-commit": [
    "foo",
    "bar",
    "test"
  ]

pre-commit的配置项非常灵活,还可以下面这样写:

{
  "precommit": "foo, bar, test"
  "pre-commit": "foo, bar, test"
  "pre-commit": ["foo", "bar", "test"]
  "precommit": ["foo", "bar", "test"],
  "precommit": {
    "run": "foo, bar, test",
  },
  "pre-commit": {
    "run": ["foo", "bar", "test"],
  },
  "precommit": {
    "run": ["foo", "bar", "test"],
  },
  "pre-commit": {
    "run": "foo, bar, test",
  }
}

你配置好后,执行git commit命令,它将会依次执行foo、bar、test来检测完善代码。

五、总结

我们已经怎么用git钩子插件了,那么我们一般用它来做什么呢。
prevent commit时,我们可以把eslint以及test命令加上,检测代码规范:

"scripts": {
    "precommit": "lint-staged && npm run test"
  }

prevent publish 主干分支时,我们可以把tag打上:

"scripts": {
    "precommit": "npm run tag"
  }

具体怎么自动化打tag标签,可以参考我的另外篇文章https://raoenhui.github.io/nodejs/git/2018/03/30/nodejs%E8%87%AA%E5%8A%A8%E7%94%9F%E6%88%90tag

参考资料

Happy coding .. :)

推荐阅读更多精彩内容

  • 内容最后更新时间:2017-08-10 以下内容是我在收集而来,再经过自己的经验修改而成,希望对你有用(在不断的更...
    1001个愿望阅读 2,563评论 4 87
  • Spring Boot 参考指南 介绍 转载自:https://www.gitbook.com/book/qbgb...
    毛宇鹏阅读 33,642评论 5 336
  • Table of Contents 转载自子龙山人 GitHub Spacemacs Rocks 第二季 第一天...
    躺在云上数星星阅读 3,586评论 3 5
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 66,851评论 12 114
  • 计算机视觉漫谈(3) 学号:14020199025 姓名:徐铭晟 【嵌牛导读】:前段时间讲了最简单的分类算法:KN...
    supportingvecto阅读 109评论 1 2