Skip to main content

git-br引入

日常开发中会存在很多分支，又会有多个分支并行开发的时候，一旦分支比较多时，清晰记得每个分支的功能就不是一件容易的事情。今天介绍一个简单的第三方插件，它可以帮助我们给每个分支做一个备注，这样查看备注就能很容易得知道每个分支的作用。

1. 安装​

  • npm
npm install git-br -g
  • yarn
yarn global add git-br

2. 官方网站​

  1. 作用：给分支做备注，并查看每个分支的作用；
  2. npm镜像地址：https://www.npmjs.com/package/git-br
  3. 官方文档：https://github.com/bahmutov/git-branches#readme

3. 使用教程​

3.1 添加备注​

  1. 以vim编辑器模式添加备注，这个命令会打开一个vim编辑器，需使用vim语法添加备注并保存退出
git branch --edit-description
  1. 命令行参数形式直接添加备注
git config branch.<branch_name>.description "<description text>"

例如：

~/workspace/github/git-study(master ✔)git config branch.master.description "master分支"

3.2 查看备注​

  1. 查看指定分支备注
git config branch.<branch_name>.description

例如:

~/workspace/github/git-study(master ✔) git config branch.master.description
master分支
  1. 查看所有分支备注
git br

例如:

~/workspace/github/git-study(master ✔) git br
  dev
  hotfix
* master master分支

可以很清楚的看到刚才给master分支打的备注是“master分支”。