cggit 简化 Git 提交、合并、分支偏移小神器，提升开发、修BUG效率！

一、简介

• 在开发过程中习惯用 Git 命令 提交、合并代码的小伙伴会发现经常在重复的敲提交代码就算了尤其是测试环节修好之后来回切换提交、合并操作所以这也是很多小伙伴选择用可视化操作的原因。

• 博主就是一个喜欢用 Git 命令 的人不太喜欢可视化的软件。所以使用 Node 对 Git 相关命令进行包装做了一个自动化命令工具【cggit】。

• 在执行 cggit 自动化命令过程中遇到冲突解决后可继续执行一遍相关命令 push merge 完成提交。

  

  

二、安装

• 请务必安装好 Git 、 Node 环境

• 将 cggit 安装到全局使用命令 $ ggit xxx

  $ npm i -g cggit
  

  $ ggit -v
  

  如果安装失败可将镜像切换到官方镜像尝试

  # 查看镜像
  $ npm get registry
  
  # 切换为官方镜像
  $ npm config set registry https://registry.npmjs.org
  
  # 切换为淘宝镜像
  $ npm config set registry https://registry.npm.taobao.org
  

• 可通过 ggit -h 查看帮助文档查看支持子命令与参数

  $ ggit -h
  

  # 输出
  Usage: ggit [options] [command]
  
  # ggit 支持的参数
  Options:
    -v               output the version number
    -V, --version    output the version number
    -h, --help       display help for command
  
  # ggit 支持的子命令
  Commands:
    push [options]   提交当前分支到远程仓库并可在提交完成后自动切换到指定分支
    merge [options]  提交当前分支到远程仓库并合并到指定分支再返回当前分支/指定分支
    fix [options]    目前主要作用于修复分支偏移问题
    help [command]   display help for command
  

• 可通过 ggit push|merge|fix -h 查看帮助文档查看子命令支持参数

  $ ggit push -h
  

  Usage: ggit push [options]
  
  提交当前分支到远程仓库
  
  # push 支持的参数
  Options:
    -g, --go [branch]    合并提交结束后切换到指定分支
    -s, --stash [type]   使用 stash 暂存区方式合并代码如果手动终止了脚本需要使用 $ git pop 放出暂存区的代码以免丢失 (default: true)
    -m, --message [msg]  提交日志信息 (default: "2023-06-09 11:32:11 提交优化")
    -h, --help           display help for command
  

三、使用

• ggit 目前只支持 3 个子命令所有命令的参数都是可选非必传。

  # 提交代码
  $ ggit push
  
  # 合并代码
  $ ggit merge
  
  # 修复分支偏移一般情况不需要看到报错分支偏移时可以使用
  $ ggit fix
  

• 子命令参数介绍

  push	含义	支持传参	默认值
  -g, --go [branch]	合并提交结束后切换到指定分支	分支名称	-
  -s, --stash [type]	使用 stash 暂存区方式合并代码如果手动终止了脚本需要使用 $ git pop 放出暂存区的代码以免丢失	0/1/true/false/Ture/False	true
  -m, --message [msg]	提交日志信息	-	当前时间 + 提交优化

  merge	含义	支持传参	默认值
  -t, --to [branch]	合并到指定的分支	分支名称	dev
  -g, --go [branch]	合并提交结束后切换到指定分支	分支名称	当前分支
  -s, --stash [type]	使用 stash 暂存区方式合并代码如果手动终止了脚本需要使用 $ git pop 放出暂存区的代码以免丢失	0/1/true/false/Ture/False	true
  -m, --message [msg]	提交日志信息	-	当前时间 + 提交优化

  fix	含义	支持传参	默认值
  -p, --push [type]	修复完成后将代码提交到远程分支	0/1/true/false/Ture/False	true
  -g, --go [branch]	合并提交结束后切换到指定分支	分支名称	-
  -m, --message [msg]	提交日志信息	-	当前时间 + 修复分支偏移

• 子命令参数使用

  例如当前在 2.0 分支需要直接提交当前分支使用默认备注即可。

  $ ggit push 
  

  例如当前在 2.0 分支需要带上提交备注提交当前分支到远程。

  $ ggit push -m "优化代码"
  
  或
  
  $ ggit push --message '优化代码'
  

  例如当前在 2.0 分支需要带上提交备注提交当前分支到远程提交完成后切换到 1.0 分支。

  $ ggit push -m '优化代码' -g 1.0
  

四、与 Git 原生命令对比

• 提交代码

  # 原生
  $ git add .
  $ git commit -m '优化代码'
  $ git pull origin 当前分支
  $ git push origin 当前分支
  

  # ggit
  $ ggit push -m "优化代码"
  
  # 如果不需要备注使用默认备注
  $ ggit push
  

• 修复 BUG提交当前分支合并到 dev 分支并切回当前开发分支或其他分支

  # 原生
  $ git add .
  $ git commit -m '优化代码'
  $ git pull origin 开发分支
  $ git push origin 开发分支
  $ git checkout dev
  $ git pull origin dev
  $ git merge 开发分支
  # 如果 merge 遇到冲突解决后继续执行一遍 merge 命令也能完成提交代码加上 -g 就能再次回到指定分支
  # 也可以使用 push 命令上传
  $ git push origin dev
  $ git checkout 开发分支/指定分支
  

  # ggit
  
  # 提交合并完成回到当前分支-g 默认当前分支
  $ ggit merge -m "优化代码"
  
  # 提交合并完成回到指定分支
  $ ggit merge -m "优化代码" -g 1.0
  
  # 如果不需要备注使用默认备注
  $ ggit merge