Following changes:

 * Upgrade to Go 1.19 and upgrade library versions
 * Use github.com/deckarep/golang-set/v2 instead of custom implementation
 * Flag --shellscript-at-path
 * Documentation improvements

Author: m-manu

.github/workflows/build-and-test.yml

@@ -12,7 +12,7 @@ jobs:
       - name: Setup Golang
         uses: actions/setup-go@v2
         with:
-          go-version: 1.18
+          go-version: 1.19
       - name: Build code
         run: go build
       - name: Test code

.gitignore

@@ -3,4 +3,5 @@
 *.sh
 *.txt
 *.out
-/test_cases_*
+/test_cases_*
+.DS_Store

Dockerfile

@@ -1,4 +1,4 @@
-FROM golang:1.18-alpine3.15 as builder
+FROM golang:1.19-alpine3.16 as builder
 
 RUN apk --no-cache add build-base
 
@@ -14,7 +14,7 @@ RUN go build
 
 RUN go test -v ./...
 
-FROM alpine:3.15
+FROM alpine:3.16
 
 RUN apk --no-cache add bash rsync
 

README.md

@@ -13,6 +13,7 @@ photos, etc.) _that are reorganized frequently_.
 `rsync-sidekick` is a safe and simple tool that is designed to run **before** `rsync` is run.
 
 ## What does this do?
+
 `rsync-sidekick` propagates following changes (or any combination) from _source directory_ to _destination directory_:
 
 1. Change in file modification timestamp
@@ -33,7 +34,7 @@ Note:
 
 ## How to install?
 
-1. Install Go version at least **1.18**
+1. Install Go version at least **1.19**
     * On Ubuntu: `snap install go`
     * On Mac: `brew install go`
     * For anything else: [Go downloads page](https://go.dev/dl/)
@@ -76,14 +77,16 @@ where,
 	[destination-dir]   Destination directory
 
 flags: (all optional)
-  -x, --exclusions string   path to file containing newline separated list of file/directory names to be excluded
-                            (even if this is not set, files/directories such these will still be ignored: $RECYCLE.BIN, desktop.ini, Thumbs.db etc.)
-  -h, --help                display help
-      --list                list files along their metadata for given directory
-  -s, --shellscript         instead of applying changes directly, generate a shell script
-                            (this flag is useful if you want 'dry run' this tool or want to run the shell script as a different user)
-  -v, --verbose             generates extra information, even a file dump (caution: makes it slow!)
-      --version             show version
+  -x, --exclusions string            path to file containing newline separated list of file/directory names to be excluded
+                                     (even if this is not set, files/directories such these will still be ignored: $RECYCLE.BIN, desktop.ini, Thumbs.db etc.)
+  -h, --help                         display help
+      --list                         list files along their metadata for given directory
+  -s, --shellscript                  instead of applying changes directly, generate a shell script
+                                     (this flag is useful if you want 'dry run' this tool or want to run the shell script as a different user)
+  -p, --shellscript-at-path string   similar to --shellscript option but you can specify output script path
+                                     (this flag cannot be specified if --shellscript option is specified)
+  -v, --verbose                      generates extra information, even a file dump (caution: makes it slow!)
+      --version                      show application version (v1.5.0) and exit
 
 More details here: https://github.com/m-manu/rsync-sidekick
 ```

action/action.go

@@ -18,6 +18,7 @@ type SyncAction interface {
 
 const cmdSeparator = "\u0001"
 
+// escape escapes the path for use in a unix command
 func escape(path string) string {
 	escaped := path
 	escaped = strings.ReplaceAll(escaped, "\\", "\\\\") // This replace should be first

bytesutil/human_readable_size.go

@@ -22,13 +22,16 @@ const (
 	EXBI       = PEBI * KIBI // 1024 power 6 (2 power 60)
 )
 
-// BinaryFormat formats a byte size to a human readable string in binary format.
+// BinaryFormat formats a byte size to a human-readable string in binary format.
 // Uses binary prefixes. See: https://en.m.wikipedia.org/wiki/Binary_prefix
 //
 // For example,
-//		fmt.Println(bytesutil.BinaryFormat(2140))
+//
+//	fmt.Println(bytesutil.BinaryFormat(2140))
+//
 // prints
-//		2.09 KiB
+//
+//	2.09 KiB
 func BinaryFormat(size int64) string {
 	if size < 0 {
 		return ""
@@ -49,13 +52,16 @@ func BinaryFormat(size int64) string {
 	}
 }
 
-// DecimalFormat formats a byte size to a human readable string in decimal format.
+// DecimalFormat formats a byte size to a human-readable string in decimal format.
 // Uses metric prefixes. See: https://en.m.wikipedia.org/wiki/Metric_prefix
 //
 // For example,
-//		fmt.Println(bytesutil.DecimalFormat(2140))
+//
+//	fmt.Println(bytesutil.DecimalFormat(2140))
+//
 // prints
-//		2.14KB
+//
+//	2.14KB
 func DecimalFormat(size int64) string {
 	if size < 0 {
 		return ""

go.mod

@@ -1,11 +1,12 @@
 module github.com/m-manu/rsync-sidekick
 
-go 1.18
+go 1.19
 
 require (
+	github.com/deckarep/golang-set/v2 v2.3.0
 	github.com/spf13/pflag v1.0.5
-	github.com/stretchr/testify v1.8.1
-	golang.org/x/text v0.5.0
+	github.com/stretchr/testify v1.8.2
+	golang.org/x/text v0.9.0
 )
 
 require (

go.sum

@@ -1,6 +1,8 @@
 github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 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=
+github.com/deckarep/golang-set/v2 v2.3.0 h1:qs18EKUfHm2X9fA50Mr/M5hccg2tNnVqsiBImnyDs0g=
+github.com/deckarep/golang-set/v2 v2.3.0/go.mod h1:VAky9rY/yGXJOLEDv3OMci+7wtDpOF4IN+y82NBOac4=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/spf13/pflag v1.0.5 h1:iy+VFUOCP1a+8yFto/drg2CJ5u0yRoB7fZw3DKv/JXA=
@@ -10,10 +12,10 @@ github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSS
 github.com/stretchr/objx v0.5.0/go.mod h1:Yh+to48EsGEfYuaHDzXPcE3xhTkx73EhmCGUpEOglKo=
 github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
 github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU=
-github.com/stretchr/testify v1.8.1 h1:w7B6lhMri9wdJUVmEZPGGhZzrYTPvgJArz7wNPgYKsk=
-github.com/stretchr/testify v1.8.1/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4=
-golang.org/x/text v0.5.0 h1:OLmvp0KP+FVG99Ct/qFiL/Fhk4zp4QQnZ7b2U+5piUM=
-golang.org/x/text v0.5.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8=
+github.com/stretchr/testify v1.8.2 h1:+h33VjcLVPDHtOdpUCuF+7gSuG3yGIftsP1YvFihtJ8=
+github.com/stretchr/testify v1.8.2/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4=
+golang.org/x/text v0.9.0 h1:2sjJmO8cDvYveuX97RDLsxlyUxLl+GHoLxBiRdHllBE=
+golang.org/x/text v0.9.0/go.mod h1:e1OnstbJyHTd6l/uOt8jFFHp6TRDWZR/bV3emEE/zU8=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
 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=

lib/set.go

@@ -1,6 +1,7 @@
 package lib
 
 import (
+	set "github.com/deckarep/golang-set/v2"
 	"io/fs"
 	"os"
 	"path/filepath"
@@ -31,27 +32,23 @@ func IsReadableFile(path string) bool {
 	return fileInfo.Mode().IsRegular()
 }
 
-// WriteSliceToFile writes a slice to a file
+// WriteSliceToFile writes a slice of strings to a file
 func WriteSliceToFile(slice []string, fileName string) {
 	sliceAsString := strings.Join(slice, "\n")
 	_ = os.WriteFile(fileName, []byte(sliceAsString), fs.ModePerm)
 }
 
-// LineSeparatedStrToMap converts a line-separated string to a map with keys and empty values
-func LineSeparatedStrToMap(lineSeparatedString string) (set Set[string], firstFew []string) {
-	set = NewSet[string](20)
+// LineSeparatedStrToMap converts a line-separated string to a Set of values
+func LineSeparatedStrToMap(lineSeparatedString string) (entries set.Set[string], firstFew []string) {
+	entries = set.NewThreadUnsafeSetWithSize[string](20)
 	firstFew = []string{}
 	for _, e := range strings.Split(lineSeparatedString, "\n") {
-		set.Add(e)
+		entries.Add(strings.TrimSpace(e))
 		firstFew = append(firstFew, e)
 	}
 	if len(firstFew) > 3 {
 		firstFew = firstFew[0:3]
 	}
-	for e := range set {
-		if strings.TrimSpace(e) == "" {
-			delete(set, e)
-		}
-	}
+	entries.Remove("")
 	return
 }