Git command (#3)

* add glog command for extend git log

* 测试根据目录下所有git仓库列表

* 增加多仓库解析

* feature:新增控制台&文件表格形式输出

* fix:windows下陆路径混用&输出多引号特殊字符

* 以表格形式输出提交记录更换为go-pretty库

* 优化build后的二进制文件大小

* 完善命令提示&交互提示

* 更换分隔符&增加glog文档

* 修改文档格式、排版

---------

Co-authored-by: yesand<wangyingjie>

Author: yesAnd92

Makefile

@@ -1,9 +1,9 @@
 BINARY_NAME=lwe
 
 build:
-	GOARCH=amd64 GOOS=darwin go build -o ${BINARY_NAME}_mac main.go
-	GOARCH=amd64 GOOS=linux go build -o ${BINARY_NAME}_linux main.go
-	GOARCH=amd64 GOOS=windows go build -o ${BINARY_NAME}_win64.exe main.go
+	GOARCH=amd64 GOOS=darwin go build -ldflags "-s -w" -o ${BINARY_NAME}_mac main.go
+	GOARCH=amd64 GOOS=linux go build -ldflags "-s -w" -o ${BINARY_NAME}_linux main.go
+	GOARCH=amd64 GOOS=windows go build -ldflags "-s -w" -o ${BINARY_NAME}_win64.exe main.go
 run:
 	./${BINARY_NAME}
 
@@ -13,19 +13,19 @@ release:
 	rm -rf ./*.gz
 
 	# Build for mac
-	GOARCH=amd64 GOOS=darwin go build -o ${BINARY_NAME}_mac main.go
+	GOARCH=amd64 GOOS=darwin go build -ldflags "-s -w" -o ${BINARY_NAME}_mac main.go
 	tar czvf ${BINARY_NAME}_mac_${VERSION}.tar.gz ./${BINARY_NAME}_mac
 	rm -rf ./${BINARY_NAME}_mac
 
 	# Build for linux
 	go clean
-	GOARCH=amd64 GOOS=linux go build -o ${BINARY_NAME}_linux main.go
+	GOARCH=amd64 GOOS=linux go build -ldflags "-s -w" -o ${BINARY_NAME}_linux main.go
 	tar czvf ${BINARY_NAME}_linux_${VERSION}.tar.gz ./${BINARY_NAME}_linux
 	rm -rf ./${BINARY_NAME}_linux
 
 	# Build for win
 	go clean
-	GOARCH=amd64 GOOS=windows go build -o ${BINARY_NAME}_win64.exe main.go
+	GOARCH=amd64 GOOS=windows go build -ldflags "-s -w" -o ${BINARY_NAME}_win64.exe main.go
 	tar czvf ${BINARY_NAME}_win64_${VERSION}.tar.gz ./${BINARY_NAME}_win64.exe
 	rm -rf ./${BINARY_NAME}_win64.exe
 	go clean

README.md

@@ -10,7 +10,7 @@ lwe是leave work early的缩写，也就是"早点下班"！🤣🤣🤣
 
 [3.获取Navicat连接配置中的密码](#3)
 
-[4.获取给定值的md5值](#4)
+[4.增强Git日志功能：查看给定目录下所有git仓库提交日志](#4)
 
 ## 安装
 
@@ -55,6 +55,7 @@ Available Commands:
 completion  Generate the autocompletion script for the specified shell
 es          Translate SQL to elasticsearch's DSL
 fmt         Generate the specified file based on SQL
+glog        Get all git repository commit log under the given dir 
 help        Help about any command
 md5         Get a md5 for the given value or  a random md5 value
 ncx         Decrypt password of connection in .ncx file
@@ -237,25 +238,54 @@ Connection username: root
 Connection password: This is a test
 ```
 
-<h3 id="4">4、获取给定值的md5值</h3>
-这个命令非常的简单，返回给定值的md5值，如果未给定值则随机返回一个md5值
-
+<h3 id="4">4、增强Git日志功能：查看给定目录下所有git仓库提交日志</h3>
+开发人员可能同时维护多个项目或者一个项目中多个模块在不同git仓库，如果有跨仓库查看多个仓库提交日志的需求，glog子命令就派上用场了。
 ```bash
-lwe md5 [给定的串]
+lwe glog  <仓库所在目录>  [可选参数] 
 ```
-如：
+> 查询结果对应的是每个git仓库当前使用分支的提交记录
+
+> 如果未指定目录，则在当前目录下搜寻git仓库,另，如果目录层级过深，可能会影响性能
+
+如：写周报时，需要查看自己近一周在哪些仓库提交了哪些代码,来辅助我写总结，假定我的工作目录在/Users/yesand/work/
+
 ```bash
-lwe md5 yesAnd
+lwe glog /Users/yesand/work/  -a=yesand -f=false -n=20 -s=2023-05-15 -e=2023-05-19
+```
+其中：
+
+`-a, --author string`,可选参数，该参数用于指定提交者，未指定查询所有提交者。\
+`-f, --file bool`,可选参数，该参数决定将查询结果写到文件中，默认在控制台输出。\
+`-n, --recentN int16`,可选参数，该参数指定每个仓库查询最近N条的提交记录。\
+`-s, --start string`,可选参数，该参数指定筛选提交记录的开始日期，格式：'yyyy-MM-dd'。\
+`-e, --end string`,可选参数，该参数指定筛选提交记录的结束日期，格式：'yyyy-MM-dd'。\
+
+结果:示例
+
+```text
+#1 Git Repo >> /Users/yesand/work/lwe
++---------+--------+-----------------------------------------+---------------------+
+| HASH    | AUTHOR | COMMIT                                  | TIME                |
++---------+--------+-----------------------------------------+---------------------+
+| bf67fcd | yesand | 完善命令提示&交互提示                      | 2023-05-19 17:21:34 |
+| 3739c60 | yesand | 优化build后的二进制文件大小                 | 2023-05-19 09:44:14|
+| 7a2ca47 | yesand | 以表格形式输出提交记录更换为go-pretty库      | 2023-05-19 09:21:26 |
++---------+--------+-----------------------------------------+---------------------+
+
+#2 Git Repo >> /Users/yesand/work/xxx
+...
 ```
 
 
+
 ## 说明
 1.使用[spf13/cobra](github.com/spf13/cobra)库来方便的构建命令行工具
 
 2.es子命令实现借助了[sqlparser](github.com/xwb1989/sqlparser)库来解析SQL语句，一个库很优秀的解析SQL库
 
 3.sql转换成dsl，曹大的[elasticsql](https://github.com/cch123/elasticsql)项目已经是一个很成熟好用的轮子了，lwe也大量借鉴了它的实现思路；没直接调用这个库的原因是想自己练手，同时后续增减功能也更加灵活
 
+4.glog结果输出时使用了[go-pretty](https://github.com/jedib0t/go-pretty)库来表格化提交信息
 ## RoadMap
 - fmt 根据需求支持更多类型的转换
 - es 按需增加对insert、update、delete

cmd/git.go

@@ -0,0 +1,58 @@
+package cmd
+
+import (
+	"github.com/spf13/cobra"
+	"lwe/handler/gitcmd"
+)
+
+/**
+* git命令相关功能
+ */
+var (
+	detail    = false //是否展示每次提交变动的文件 !!!没找到合适的展示方式，且性能稳定性不可控，暂时先不开放
+	file      bool    //日志结果控制台输出，或者生成文件，默认控制台输出
+	committer string  //指定查询提交者，不指定查所有
+	recentN   int16   //指定查询仓库
+	start     string  //开始时间
+	end       string  //结束时间
+
+	gitCmd = &cobra.Command{
+		Use:   "glog",
+		Short: "Get all git repository commit log under the given dir ",
+		Long:  `Get all git repository commit log under the given dir ,and  specify author，date etc. supported!`,
+		Args:  cobra.MatchAll(),
+		Run: func(cmd *cobra.Command, args []string) {
+
+			var dir = "."
+			if len(args) > 0 {
+				dir = args[0]
+			}
+
+			if recentN > int16(200) {
+				cobra.CheckErr("recentN can't exceed 200")
+			}
+
+			commitLogs, err := gitcmd.GetAllGitRepoCommitLog(detail, recentN, dir, committer, start, end)
+			if err != nil {
+				cobra.CheckErr(err)
+			}
+
+			var output gitcmd.OutputFormatter = &gitcmd.ConsoleOutput{}
+			if file {
+				output = &gitcmd.FileOutput{}
+			}
+			output.Output(commitLogs)
+
+		},
+	}
+)
+
+func init() {
+
+	//gitCmd.PersistentFlags().BoolVarP(&detail, "detail", "d", false, "")
+	gitCmd.PersistentFlags().BoolVarP(&file, "file", "f", false, "result output to file,default value is false (meaning output to console). ")
+	gitCmd.PersistentFlags().StringVarP(&committer, "author", "a", "", "specify name of committer ")
+	gitCmd.PersistentFlags().StringVarP(&start, "start", "s", "", "specify the start of commit date. eg.'yyyy-MM-dd'")
+	gitCmd.PersistentFlags().StringVarP(&end, "end", "e", "", "specify the end of commit date. eg.'yyyy-MM-dd'")
+	gitCmd.PersistentFlags().Int16VarP(&recentN, "recentN", "n", 10, "specify the number of commit log for each git repo.")
+}

cmd/root.go

@@ -24,4 +24,5 @@ func init() {
 	rootCmd.AddCommand(md5Cmd)
 	rootCmd.AddCommand(esCmd)
 	rootCmd.AddCommand(navicatCmd)
+	rootCmd.AddCommand(gitCmd)
 }

cmd/version.go

@@ -11,13 +11,6 @@ var versionCmd = &cobra.Command{
 	Short: "Print the version number of lwe",
 	Long:  `All software has versions. This is lwe's`,
 	Run: func(cmd *cobra.Command, args []string) {
-		fmt.Println("0.1beta")
+		fmt.Println("v.0.0.3.beta")
 	},
 }
-
-func init() {
-
-	//versionCmd.PersistentFlags().StringP("abc", "c", "YOUR NAME", "author name for copyright attribution")
-	//versionCmd.PersistentFlags().Bool("viper", true, "use Viper for configuration")
-	//rootCmd.AddCommand(versionCmd)
-}

go.mod

@@ -9,5 +9,9 @@ require (
 
 require (
 	github.com/inconshreveable/mousetrap v1.1.0 // indirect
+	github.com/jedib0t/go-pretty/v6 v6.4.6 // indirect
+	github.com/mattn/go-runewidth v0.0.13 // indirect
+	github.com/rivo/uniseg v0.2.0 // indirect
 	github.com/spf13/pflag v1.0.5 // indirect
+	golang.org/x/sys v0.1.0 // indirect
 )

go.sum

@@ -1,13 +1,34 @@
 github.com/cpuguy83/go-md2man/v2 v2.0.2/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o=
+github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/inconshreveable/mousetrap v1.0.1/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLfsEA9PFc4w1p2J65bw=
 github.com/inconshreveable/mousetrap v1.1.0 h1:wN+x4NVGpMsO7ErUn/mUI3vEoE6Jt13X2s0bqwp9tc8=
 github.com/inconshreveable/mousetrap v1.1.0/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLfsEA9PFc4w1p2J65bw=
+github.com/jedib0t/go-pretty/v6 v6.4.6 h1:v6aG9h6Uby3IusSSEjHaZNXpHFhzqMmjXcPq1Rjl9Jw=
+github.com/jedib0t/go-pretty/v6 v6.4.6/go.mod h1:Ndk3ase2CkQbXLLNf5QDHoYb6J9WtVfmHZu9n8rk2xs=
+github.com/mattn/go-runewidth v0.0.9 h1:Lm995f3rfxdpd6TSmuVCHVb/QhupuXlYr8sCI/QdE+0=
+github.com/mattn/go-runewidth v0.0.9/go.mod h1:H031xJmbD/WCDINGzjvQ9THkh0rPKHF+m2gUSrubnMI=
+github.com/mattn/go-runewidth v0.0.13 h1:lTGmDsbAYt5DmK6OnoV7EuIF1wEIFAcxld6ypU4OSgU=
+github.com/mattn/go-runewidth v0.0.13/go.mod h1:Jdepj2loyihRzMpdS35Xk/zdY8IAYHsh153qUoGf23w=
+github.com/olekukonko/tablewriter v0.0.5 h1:P2Ga83D34wi1o9J6Wh1mRuqd4mF/x/lgBS7N7AbDhec=
+github.com/olekukonko/tablewriter v0.0.5/go.mod h1:hPp6KlRPjbx+hW8ykQs1w3UBbZlj6HuIJcUGPhkA7kY=
+github.com/pkg/profile v1.6.0/go.mod h1:qBsxPvzyUincmltOk6iyRVxHYg4adc0OFOv72ZdLa18=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/rivo/uniseg v0.2.0 h1:S1pD9weZBuJdFmowNwbpi7BJ8TNftyUImj/0WQi72jY=
+github.com/rivo/uniseg v0.2.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc=
 github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
 github.com/spf13/cobra v1.6.1 h1:o94oiPyS4KD1mPy2fmcYYHHfCxLqYjJOhGsCHFZtEzA=
 github.com/spf13/cobra v1.6.1/go.mod h1:IOw/AERYS7UzyrGinqmz6HLUo219MORXGxhbaJUqzrY=
 github.com/spf13/pflag v1.0.5 h1:iy+VFUOCP1a+8yFto/drg2CJ5u0yRoB7fZw3DKv/JXA=
 github.com/spf13/pflag v1.0.5/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=
+github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
+github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw=
+github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
+github.com/stretchr/testify v1.7.4/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU=
 github.com/xwb1989/sqlparser v0.0.0-20180606152119-120387863bf2 h1:zzrxE1FKn5ryBNl9eKOeqQ58Y/Qpo3Q9QNxKHX5uzzQ=
 github.com/xwb1989/sqlparser v0.0.0-20180606152119-120387863bf2/go.mod h1:hzfGeIUDq/j97IG+FhNqkowIyEcD88LrW6fyU3K3WqY=
+golang.org/x/sys v0.1.0 h1:kunALQeHf1/185U1i0GOB/fy1IPRDDpuoOOqRReG57U=
+golang.org/x/sys v0.1.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
 gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=