Merge pull request #3

Add version

Author: foolin

.goreleaser.yaml

@@ -17,7 +17,7 @@ before:
 
 builds:
   - binary: sumdiff
-    main: ./cli/sumdiff.go
+    main: ./cli/main.go
     goos:
       - linux
       - darwin

README.md

@@ -1,6 +1,14 @@
 # sumdiff
 Compare sdk/tools for directory and files.
 
+## Features
+- [x] Support comparing files or directories result is equals. 
+- [x] Supports comparing files or directories with the difference list. 
+- [x] Support for calculating the hash of a file or directories md5/sha1/sha256/sha512. 
+- [x] This library supports both SDK and CLI tools.
+- [x] CLI support result format : table/json/csv/yaml 
+- [x] CLI support result output to a file.
+
 # SDK
 
 ## Install
@@ -12,38 +20,42 @@ go get -u github.com/foolin/sumdiff
 ```go
 
 //Compare 
-ok, result, err := Cmp(path1, path2)
+ok, result, err := sumdiff.Cmp(path1, path2)
 
 //Equal
-ok, err := Equal(v.path1, v.path2)
+ok, err := sumdiff.Equal(v.path1, v.path2)
 
 ```
 
 # CLI Tool
 
 ```
 sumdiff  --help
+
 A useful comparison tool for differences and hash
 
 Usage:
   sumdiff [command]
 
 Available Commands:
-  eq          Compare whether two files or directory are equal
   cmp         Compare the two files or directories are different
+  completion  Generate the autocompletion script for the specified shell
+  eq          Compare whether two files or directory are equal
   hash        Calculate hash algorithm [md5|sha1|sha256|sha512] hex string
   help        Help about any command
   md5         Calculate md5 hex string
   sha1        Calculate sha1 hex string
   sha256      Calculate sha256 hex string
-  completion  Generate the autocompletion script for the specified shell
-  
+
 Flags:
-  -h, --help      help for sumdiff
-  -v, --verbose   Verbose output info
+  -f, --format string   Format: table|json|csv|yaml (default "table")
+  -h, --help            help for sumdiff
+  -o, --output string   Output filename
+  -v, --verbose         Verbose output info
 
 Use "sumdiff [command] --help" for more information about a command.
 
+
 ```
 
 # Usage
@@ -58,7 +70,11 @@ Use "sumdiff [command] --help" for more information about a command.
     ```
   Output1:
     ```text                                                                               
-    true
+    +--------+                                                                                          
+    | result |
+    +--------+
+    |  true  |
+    +--------+
     ```
 
   Example2:
@@ -174,9 +190,4 @@ linux:
 
 tar -xvf sumdiff_Linux_x86_64.tar.gz && sudo mv sumdiff /usr/local/bin
 
-```
-
-## TODO
-- [ ] Output table,csv,yaml,json  
-- [ ] Config display statusbar  
-- [ ] Write file or console
+```

bin/sumdiff

@@ -21,8 +21,32 @@ THE SOFTWARE.
 */
 package main
 
-import "github.com/foolin/sumdiff/cmd"
+import (
+	"github.com/foolin/sumdiff/cmd"
+	"github.com/foolin/sumdiff/vo"
+)
+
+var (
+	version = "devel"
+	commit  = "none"
+	date    = "unknown"
+)
 
 func main() {
-	cmd.Execute()
+	cmd.Execute(buildVersion(version, commit, date))
+}
+
+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
 }

cli/main.go

@@ -24,31 +24,24 @@ package cmd
 import (
 	"github.com/foolin/sumdiff"
 	"github.com/foolin/sumdiff/internal/statusbar"
-	"github.com/foolin/sumdiff/vo"
-
+	"github.com/foolin/sumdiff/internal/vlog"
 	"github.com/spf13/cobra"
 )
 
-var detail bool
-
 // cmpCmd represents the cmp command
 var cmpCmd = &cobra.Command{
 	Use:   "cmp",
-	Short: "Compare the two files or directories are different",
-	Long:  `Compare the two files or directories are different`,
+	Short: "Compare two files or directories for a list of differences",
+	Long:  `Compare two files or directories for a list of differences`,
 	Run: func(cmd *cobra.Command, args []string) {
 		statusbar.Start()
 		ok, list, err := sumdiff.Cmp(args[0], args[1])
 		statusbar.Stop()
 		if err != nil {
-			writer.MustWrite(vo.NewErrInfo(err))
-			return
-		}
-		if detail {
-			writer.MustWrite(list)
-		} else {
-			writer.MustWrite(vo.NewAny("result", ok))
+			vlog.Printf("Error: %v", err)
 		}
+		vlog.Printf("Result: %v", ok)
+		writer.MustWrite(list)
 	},
 }
 
@@ -59,7 +52,7 @@ func init() {
 
 	// Cobra supports Persistent Flags which will work for this command
 	// and all subcommands, e.g.:
-	cmpCmd.PersistentFlags().BoolVarP(&detail, "detail", "", false, "Show detail result")
+	//cmpCmd.PersistentFlags().BoolVarP(&detail, "detail", "", false, "Show detail result")
 
 	// Cobra supports local flags which will only run when this command
 	// is called directly, e.g.:

cmd/cmp.go

@@ -24,6 +24,7 @@ package cmd
 import (
 	"github.com/foolin/sumdiff"
 	"github.com/foolin/sumdiff/internal/statusbar"
+	"github.com/foolin/sumdiff/internal/vlog"
 	"github.com/foolin/sumdiff/vo"
 	"github.com/spf13/cobra"
 )
@@ -39,10 +40,9 @@ var eqCmd = &cobra.Command{
 		ret, err := sumdiff.Equal(args[0], args[1])
 		statusbar.Stop()
 		if err != nil {
-			writer.MustWrite(vo.NewErrInfo(err))
-			return
+			vlog.Printf("Error: %v", err)
 		}
-		writer.MustWrite(vo.NewAny("result", ret))
+		writer.MustWrite(vo.NewAnyValue(ret))
 	},
 }
 

cmd/eq.go

@@ -33,8 +33,8 @@ import (
 // md5Cmd represents the md5 command
 var md5Cmd = &cobra.Command{
 	Use:   "md5 <path> ...",
-	Short: "Calculate md5 hex string",
-	Long:  `Calculate md5 hex string, eg: hash sha1 a.text`,
+	Short: "Calculate md5 hexadecimal string",
+	Long:  `Calculate md5 hexadecimal string, eg: hash sha1 a.text`,
 	Args:  cobra.MinimumNArgs(1),
 	Run: func(cmd *cobra.Command, args []string) {
 		statusbar.Start()

cmd/md5.go

@@ -22,6 +22,8 @@ THE SOFTWARE.
 package cmd
 
 import (
+	"fmt"
+	"github.com/foolin/sumdiff/vo"
 	"os"
 	"path/filepath"
 
@@ -53,7 +55,7 @@ var rootCmd = &cobra.Command{
 			var ok bool
 			format, ok = write.FormatOfName(config.Format)
 			if !ok {
-				vlog.Exit(1, "Format invalid: %v\n", config.Format)
+				vlog.Exit("Format invalid: %v\n", config.Format)
 				return
 			}
 		}
@@ -65,7 +67,7 @@ var rootCmd = &cobra.Command{
 			var err error
 			file, err = os.OpenFile(path, os.O_CREATE|os.O_TRUNC|os.O_RDWR, 0666)
 			if err != nil {
-				vlog.Exit(1, "Open file %v error: %\n", path, err)
+				vlog.Exit("Open file %v error: %\n", path, err)
 				return
 			}
 			w = file
@@ -86,9 +88,11 @@ 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() {
+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 {
 		os.Exit(1)
 	}

cmd/root.go

@@ -4,18 +4,18 @@ go 1.20
 
 require (
 	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
 	github.com/spf13/cobra v1.8.0
 	github.com/stretchr/testify v1.8.4
+	gopkg.in/yaml.v3 v3.0.1
 )
 
 require (
 	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/hashicorp/errwrap v1.0.0 // indirect
 	github.com/inconshreveable/mousetrap v1.1.0 // indirect
-	github.com/liushuochen/gotable v0.0.0-20221119160816-1113793e7092 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
 	github.com/rivo/uniseg v0.2.0 // indirect
 	github.com/spf13/pflag v1.0.5 // indirect
-	gopkg.in/yaml.v3 v3.0.1 // indirect
 )

go.mod

@@ -34,6 +34,9 @@ func ListPath(path string, acceptFn func(info PathInfo) bool) (map[string]PathIn
 func WalkPath(root string, fn WalkFunc) error {
 	return filepath.Walk(root, func(path string, info fs.FileInfo, err error) error {
 		relative := RelativePath(path, root)
+		if relative == "" {
+			return nil
+		}
 		walkInfo := PathInfo{
 			Relative: relative,
 			Path:     path,
@@ -78,5 +81,11 @@ func AbsPath(path string) string {
 }
 
 func RelativePath(path, root string) string {
-	return strings.TrimPrefix(AbsPath(path), AbsPath(root))
+	absPath := AbsPath(path)
+	absRoot := AbsPath(root)
+	relative := strings.TrimPrefix(absPath, absRoot)
+	if len(absPath) > len(relative) {
+		return strings.TrimPrefix(relative, string(filepath.Separator))
+	}
+	return relative
 }