update docs

Author: foolin

cli/main.go

@@ -22,12 +22,12 @@ THE SOFTWARE.
 package main
 
 import (
-	goversion "github.com/caarlos0/go-version"
 	"github.com/foolin/sumdiff/cmd"
+	"github.com/foolin/sumdiff/vo"
 )
 
 var (
-	version = "dev"
+	version = "devel"
 	commit  = "none"
 	date    = "unknown"
 )
@@ -36,21 +36,17 @@ func main() {
 	cmd.Execute(buildVersion(version, commit, date))
 }
 
-const website = "https://1024km.com/sumdiff"
-
-func buildVersion(version, commit, date string) goversion.Info {
-	return goversion.GetVersionInfo(
-		goversion.WithAppDetails("sumdiff", "A useful comparison tool for differences", website),
-		func(i *goversion.Info) {
-			if commit != "" {
-				i.GitCommit = commit
-			}
-			if date != "" {
-				i.BuildDate = date
-			}
-			if version != "" {
-				i.GitVersion = version
-			}
-		},
-	)
+func buildVersion(version, commit, date string) vo.AppInfo {
+	info := vo.NewAppInfo()
+	if version != "" {
+		info.Version = version
+	}
+	if commit != "" {
+		info.Commit = commit
+	}
+	if date != "" {
+		info.Date = date
+	}
+
+	return info
 }

cmd/root.go

@@ -22,7 +22,8 @@ THE SOFTWARE.
 package cmd
 
 import (
-	goversion "github.com/caarlos0/go-version"
+	"fmt"
+	"github.com/foolin/sumdiff/vo"
 	"os"
 	"path/filepath"
 
@@ -87,8 +88,9 @@ var rootCmd = &cobra.Command{
 
 // Execute adds all child commands to the root command and sets flags appropriately.
 // This is called by main.main(). It only needs to happen once to the rootCmd.
-func Execute(verInfo goversion.Info) {
-	rootCmd.Version = verInfo.String()
+func Execute(appInfo vo.AppInfo) {
+	appInfo.Description = fmt.Sprintf("%v: %v", rootCmd.Use, rootCmd.Long)
+	rootCmd.Version = appInfo.String()
 	rootCmd.SetVersionTemplate("{{.Version}}")
 	err := rootCmd.Execute()
 	if err != nil {

go.mod

@@ -3,7 +3,6 @@ module github.com/foolin/sumdiff
 go 1.20
 
 require (
-	github.com/caarlos0/go-version v0.1.1
 	github.com/hashicorp/go-multierror v1.1.1
 	github.com/liushuochen/gotable v0.0.0-20221119160816-1113793e7092
 	github.com/mattn/go-runewidth v0.0.15

go.sum

@@ -1,5 +1,3 @@
-github.com/caarlos0/go-version v0.1.1 h1:1bikKHkGGVIIxqCmufhSSs3hpBScgHGacrvsi8FuIfc=
-github.com/caarlos0/go-version v0.1.1/go.mod h1:Ze5Qx4TsBBi5FyrSKVg1Ibc44KGV/llAaKGp86oTwZ0=
 github.com/cpuguy83/go-md2man/v2 v2.0.3/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=

vo/version.go

@@ -0,0 +1,55 @@
+package vo
+
+import (
+	"fmt"
+	"runtime"
+	"strings"
+	"text/tabwriter"
+)
+
+type AppInfo struct {
+	Description string `json:"description" yaml:"description"`
+	Version     string `json:"version" yaml:"version"`
+	Commit      string `json:"commit" yaml:"commit"`
+	Date        string `json:"date" yaml:"date"`
+	GoVer       string `json:"goVer" yaml:"goVer"`
+	Compiler    string `json:"compiler" yaml:"compiler"`
+	Platform    string `json:"platform" yaml:"platform"`
+}
+
+func NewAppInfo() AppInfo {
+	return AppInfo{
+		Description: "",
+		Version:     "devel",
+		Commit:      "none",
+		Date:        "none",
+		GoVer:       runtime.Version(),
+		Compiler:    runtime.Compiler,
+		Platform:    fmt.Sprintf("%s/%s", runtime.GOOS, runtime.GOARCH),
+	}
+}
+
+func (r AppInfo) Array() [][]string {
+	return [][]string{
+		{"Version", "Commit", "Date", "GoVer", "Compiler", "Platform"},
+		{r.Version, r.Commit, r.Date, r.GoVer, r.Compiler, r.Platform},
+	}
+}
+
+func (r AppInfo) String() string {
+	b := strings.Builder{}
+	w := tabwriter.NewWriter(&b, 0, 0, 2, ' ', 0)
+	if r.Description != "" {
+		_, _ = fmt.Fprint(w, r.Description)
+		_, _ = fmt.Fprint(w, "\n\n")
+	}
+	_, _ = fmt.Fprintf(w, "Version:\t%s\n", r.Version)
+	_, _ = fmt.Fprintf(w, "Commit:\t%s\n", r.Commit)
+	_, _ = fmt.Fprintf(w, "Date:\t%s\n", r.Date)
+	_, _ = fmt.Fprintf(w, "GoVer:\t%s\n", r.GoVer)
+	_, _ = fmt.Fprintf(w, "Compiler:\t%s\n", r.Compiler)
+	_, _ = fmt.Fprintf(w, "Platform:\t%s\n", r.Platform)
+
+	_ = w.Flush()
+	return b.String()
+}