git 的一些常规操作命令以及小规范

[前端厚说] 2020-11-21 更新

文中涉及的代码案例 frontend-thick-talk……

本文线上阅读地址将会在第一时间更新…… 备用地址

本章节B站视频教程前端工程化 | 企业开发中的commit规范（代码提交规范）

企业开发中的commit规范

背景

从个人角度来说

首先自己习惯把自己的一些代码案例放在github 上一方面是记录学习，最重要的一点就在在未来的某天看看现在写的代码，在现在去总结过去写的代码，接着自我嘲讽一番。笔者2020年截至11月份已经提交了 653次 :smiley:，早期 commit 每次都是乱七八糟，随便贴一条。你是否也有同样的问题？每一次commit 都像是回答你女朋友的问题，不知道如何更好的描述自己的这次提交信息

从一个企业开发小组的角度

在实际开发场景中，一个成熟的团队是有一种不言而喻的默契。甚至连commit 信息都能重复。那么团队协作的规范化更是迫在眉睫

规范化
一体化
简约化
性感化

团队协作是如此的美妙。

BUT 真实场景是这样的吗?甚至有的 连 node_modules 都上传上去了。（我是在掘金沸点看到的有孩子这样吐槽）。commit 信息更是写的乱起八遭。那会有什么问题呢？在企业开发的过程中，尤其是

分支较多
项目定制型需求频繁
cherry-pick需求

那每当想 cherry-pick 一小块需求的时候，甚至不知道是哪个commit

关键词

commmit commitizen husky commitlint cz-conventional-changelog

git commit

规范化提交

commitizen

husky

commitlint

cz-conventional-changelog

前端工程化

优秀的开源项目

我们先来看一看一些优秀的开源项目，他们的commit 日志

好了，够了，那么咱们也许可能没有这样完善的项目架构，但是这种规范还是值得学习的。那么这么才能够规范化我们的代码呢，往下看

实操过程

第一步

我们可以尝试在全局安装一个包 commitizen

npm install -g commitizen

第二步

首先全局安装 cz-conventional-changelog

npm install -g cz-conventional-changelog

然后在项目里安装

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

接着你可以看下你项目的package.json ,会多出一部分配置

"devDependencies": {
    "cz-conventional-changelog": "^3.2.0"
  },
  "config": {
    "commitizen": {
      "path": "./node_modules/cz-conventional-changelog"
    }
  }

之后需要 git commit 的操作全部换成 git cz

第三步

项目内安装 commitlint

yarn add @commitlint/config-conventional @commitlint/cli

之后你的 package.json 又会多出一部分的配置

  "dependencies": {
    "@commitlint/cli": "^8.3.5",
    "@commitlint/config-conventional": "^8.3.4"
  }

接着在package.json 统计目录新建 commitlint.config.js 文件然后写入

module.exports = { extends: ["@commitlint/config-conventional"] };

第四步

项目中安装husky

yarn add husky

接着配置 husky

"dependencies": {
    "@commitlint/cli": "^8.3.5",
    "@commitlint/config-conventional": "^8.3.4",
    "husky": "^4.2.5"
  },
  "husky": {
    "hooks": {
      "commit-msg": "commitlint -e $GIT_PARAMS"
    }
  }

当我们去以不合法的提交信息进行提交代码时，会进行检查

总结

整个提交的流程,大概就是这样的，以下我贴出步骤，至于具体的像以下内容代表的含义，你可以直接，在某搜索引擎，然后，输入上文提到的关键词，应该会有词条告诉你都是啥意思

feat：新功能（feature）
fix：修补bug
docs：文档（documentation）
style： 格式方面的优化
refactor：重构
test：测试
chore：构建过程或辅助工具的变动

$ git cz
cz-cli@4.1.2, cz-conventional-changelog@3.2.0

? Select the type of change that you're committing: docs:     Documentation only changes
? What is the scope of this change (e.g. component or file name): (press enter to skip) format docs ? Write a short, imperative tense description of the change (max 53 chars):
 (11) format docs
? Provide a longer description of the change: (press enter to skip)
 n
? Are there any breaking changes? No
? Does this change affect any open issues? No
\husky > commit-msg (node v12.16.1)
[master 4baa2ce] docs(format docs): format docs
 1 file changed, 16 deletions(-)
 rewrite flutter_state_provider/README.md (100%)

git log --reverse 命令

通过此命令进行倒序展示log 信息，排在第一个的就是仓库的第一次 commit 信息，这也是git 查看第一次 commit的方式，接着通过 git checkout xxx 可以很方便的签出该 commit 的代码。通过此种方式可以更好的阅读一些开源的库或者框架

「前端厚说」Git常用命令以及小技巧