更优雅的使用 Git

时间 2019-11-06

标签优雅使用 git 栏目 Git 繁體版

原文原文链接

如何更优雅的使用 Git？javascript

写好 commit message

Git 每次提交代码，都要写 Commit message，不然提交不了。咱们不光得写 Commit message 并且还应该写的清晰明了，说明本次提交的目的。html

$ git commit -m "提交信息"

在编辑器中写commit messagejava

$ git commit

写好 Commit message 好处多多：git

一、统一团队Git commit 日志风格github

二、方便往后 Reviewing Codeshell

三、帮助咱们写好 Changelog npm

四、能很好的提高项目总体质量json

Commit 提交规范

业界比较推崇 Angular 的 commit 规范 http://suo.im/4rsYeebash

Commit message 包括三个部分：Header，Body 和 Footer。完整格式以下：编辑器

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

1) type

提交 commit 的类型，包括如下几种

- feat: 新功能

- fix: 修复问题

- docs: 修改文档

- style: 修改代码格式，不影响代码逻辑

- refactor: 重构代码，理论上不影响现有功能

- perf: 提高性能

- test: 增长修改测试用例

- chore: 修改工具相关（包括但不限于文档、代码生成等）

2) scope

修改文件的范围，好比：视图层、控制层、docs、config, plugin

3) subject

- subject 是 commit 目的的简短描述（用一句话清楚的描述此次提交作了什么），不超过50个字符

4) body

- 补充 subject 添加详细说明，能够分红多行，适当增长缘由、目的等相关因素，也可不写

5 ) footer

- 当有非兼容修改(Breaking Change)时必须在这里描述清楚

- 关闭issue或是连接到相关文档，如 Closes #1, Closes #2, #3

使用 commitzen

commitzen 这个工具能够帮助咱们写出规范的 Commit message。

GitHub：https://github.com/commitizen...

使用npm 全局安装

$ npm install -g commitizen

在项目中使用 angular 的 commit 规范

$ commitizen init cz-conventional-changelog --save-dev --save-exact

而后咱们就能够愉快的使用 git cz 代替 git commit 命令了。固然咱们也可也将其加到npm script 中

"script": {
    "commit": "git cz"
}

而后直接使用npm run commit

使用 gitmoji

gitmoji 和 commitzen的做用都是帮助咱们写出规范的commit message，不过gitmoji有更好玩的 moji表情。（用moji来表示type ）

GitHub：https://github.com/carloscues...

安装使用

# 安装
$ npm i -g gitmoji-cli
# 使用
$ gitmoji -c

挑选个符合场景的moji 提交本次更改

使用Git hooks

与其余版本控制系统同样，当某些重要事件发生时，Git 能够调用自定义脚本，Git 有不少钩子能够用来调用脚本自定义 Git。在 .git -> hooks 目录下能够看到示例。例如：pre-commit就是在代码提交以前作些事情。若是你打开了 hooks 目录里面的 *.sample 文件，你能够看见里面写的shell脚本。可是我想用 Js 写 hooks 咋办？husky、pre-commit就能知足你。

如今咱们想实现一个提交代码时使用 Eslint 进行代码检查的功能

先来看pre-commit

GitHub：https://github.com/observing/...

# 下载安装
npm install --save-dev pre-commit

在package.json 中配置pre-commit

"scripts": {    
   "lint": "eslint [options] [file|dir|glob]*",
},
"pre-commit": [    
   "lint",
]

如今提交代码试试

git commit -m 'Keep calm and commit'

再试试 husky

GitHub：https://github.com/typicode/h...

开始仍是下载，不过这儿咱们用的是 @next 版，使用方法与正式版略有不一样。

npm install husky@next --save-dev

和 pre-commit 同样，仍是在package.json中配置。可是处理pre-commit钩子它还能够作的更多。

// package.json
{
  "scripts": {
    "lint": "eslint [options] [file|dir|glob]*",
  },
  "husky": {
    "hooks": {
      "pre-commit": "npm lint",
      "pre-push": "..."
    }
  }
}

本文介绍了如何规范的编写Commit message，以及使用commentzen与gitmoji这两个工具来帮助咱们写出规范的Commit message。最后介绍了下Git hooks，并经过 husky 或是 pre-commit 与 Eslint结合使用来构建一个代码检测工做流。固然，你还能够作的更多。

本文完

欢迎能够关注个人公众号，一块儿玩耍。有技术干货也有扯淡乱谈，关注回复[888] 领取惊喜

左手代码右手砖，抛砖引玉