Renamed Config.Save to SaveName for clarity.

Author: bengarrett

lib/example_posix_test.go

@@ -10,12 +10,12 @@ import (
 
 func ExampleConfig_clean() {
 	c := Config{
-		Save: "..//test///.",
+		SaveName: "..//test///.",
 	}
 	if err := c.clean(); err != nil {
 		log.Fatalln(err)
 	}
-	fmt.Print(c.Save)
+	fmt.Print(c.SaveName)
 	// Output: ../test
 }
 

lib/log.go

@@ -59,7 +59,7 @@ func (c *Config) WriteLog(s string) {
 	if !c.Dupes {
 		l += fmt.Sprintf("hashes: %s; ", humanize.Bytes(uint64(len(c.hashes)*32)))
 	}
-	if c.Save != "" {
+	if c.SaveName != "" {
 		l += fmt.Sprintf("names: %s; ", humanize.Bytes(uint64(c.names)))
 	}
 	l += fmt.Sprintf("%s\n", s)

lib/zipcmt.go

@@ -23,7 +23,7 @@ import (
 
 type Config struct {
 	Dirs      []string
-	Save      string // rename to SaveName
+	SaveName  string
 	Dupes     bool
 	Export    bool
 	Log       bool
@@ -197,8 +197,8 @@ func (c *Config) WalkDir(root string) error {
 				c.saved++
 			}
 		}
-		if c.Save != "" {
-			dat.name = c.exports.unique(path, c.Save)
+		if c.SaveName != "" {
+			dat.name = c.exports.unique(path, c.SaveName)
 			c.names += len(dat.name)
 			if c.save(dat) {
 				c.WriteLog(fmt.Sprintf("SAVED: %s (%s) << %s", dat.name, humanize.Bytes(uint64(len(cmmt))), path))
@@ -212,32 +212,33 @@ func (c *Config) WalkDir(root string) error {
 
 // clean the syntax of the target export directory path.
 func (c *Config) clean() error {
-	if c.Save != "" {
-		c.Save = filepath.Clean(c.Save)
-		p := strings.Split(c.Save, string(filepath.Separator))
+	if name := c.SaveName; name != "" {
+		name = filepath.Clean(name)
+		p := strings.Split(name, string(filepath.Separator))
 		if p[0] == "~" {
 			hd, err := os.UserHomeDir()
 			if err != nil {
 				return err
 			}
-			c.Save = strings.Replace(c.Save, "~", hd, 1)
+			name = strings.Replace(name, "~", hd, 1)
 		}
-		s, err := os.Stat(c.Save)
+		s, err := os.Stat(name)
 		if errors.Is(err, fs.ErrInvalid) {
-			return fmt.Errorf("%s: export %w", c.Save, ErrValid)
+			return fmt.Errorf("%s: export %w", name, ErrValid)
 		}
 		if errors.Is(err, fs.ErrNotExist) {
-			return fmt.Errorf("%s: export %w", c.Save, ErrMissing)
+			return fmt.Errorf("%s: export %w", name, ErrMissing)
 		}
 		if errors.Is(err, fs.ErrPermission) {
-			return fmt.Errorf("%s: export %w", c.Save, ErrPerm)
+			return fmt.Errorf("%s: export %w", name, ErrPerm)
 		}
 		if err != nil {
-			return fmt.Errorf("%s: export %w", c.Save, err)
+			return fmt.Errorf("%s: export %w", name, err)
 		}
 		if !s.IsDir() {
-			return fmt.Errorf("%s: export %w", c.Save, ErrIsFile)
+			return fmt.Errorf("%s: export %w", name, ErrIsFile)
 		}
+		c.SaveName = name
 	}
 	return nil
 }
@@ -288,7 +289,7 @@ func (c Config) separator(name string) string {
 // Status summarizes the zip files scan.
 func (c Config) Status() string {
 	if c.Log {
-		if c.Save != "" {
+		if c.SaveName != "" {
 			s := fmt.Sprintf("Saved %d comments from %d finds", c.saved, c.cmmts)
 			c.WriteLog(s)
 		}
@@ -314,7 +315,7 @@ func (c Config) Status() string {
 	}
 	s += color.Secondary.Sprint("Scanned ") +
 		color.Primary.Sprintf("%d zip %s", c.zips, a)
-	if c.Save != "" && c.saved != c.cmmts {
+	if c.SaveName != "" && c.saved != c.cmmts {
 		s += color.Secondary.Sprint(", saved ") +
 			color.Primary.Sprintf("%d text files", c.saved)
 	}
@@ -327,7 +328,7 @@ func (c Config) Status() string {
 	return s
 }
 
-// Save a zip cmmt to the file path.
+// SaveName a zip cmmt to the file path.
 // Unless the overwrite argument is set, any previous cmmt text files are skipped.
 func (c *Config) save(dat save) bool {
 	// name, cmmt string, mod time.Time, ow bool
@@ -387,7 +388,7 @@ func valid(name string) bool {
 // unique checks the destination path against an export map.
 // The map contains a unique collection of previously used destination
 // paths, to avoid creating duplicate text filenames while using the
-// Save config.
+// SaveName config.
 func (e export) unique(zipPath, dest string) string {
 	base := filepath.Base(zipPath)
 	name := strings.TrimSuffix(base, filepath.Ext(base)) + filename

lib/zipcmt_test.go

@@ -12,7 +12,7 @@ import (
 
 func TestConfig_Clean(t *testing.T) {
 	type fields struct {
-		Save      string
+		SaveName  string
 		Export    bool
 		Dupes     bool
 		Overwrite bool
@@ -28,15 +28,15 @@ func TestConfig_Clean(t *testing.T) {
 		wantErr bool
 	}{
 		{"empty", fields{}, false},
-		{"missing", fields{Save: "/no/such/directory"}, true},
-		{"file", fields{Save: "../test/test.txt"}, true},
-		{"dir", fields{Save: "../test"}, false},
-		{"home", fields{Save: "~"}, false},
+		{"missing", fields{SaveName: "/no/such/directory"}, true},
+		{"file", fields{SaveName: "../test/test.txt"}, true},
+		{"dir", fields{SaveName: "../test"}, false},
+		{"home", fields{SaveName: "~"}, false},
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
 			c := &Config{
-				Save:      tt.fields.Save,
+				SaveName:  tt.fields.SaveName,
 				Export:    tt.fields.Export,
 				Dupes:     tt.fields.Dupes,
 				Overwrite: tt.fields.Overwrite,
@@ -91,7 +91,7 @@ func Test_Read(t *testing.T) {
 
 func TestConfig_Scans(t *testing.T) {
 	type fields struct {
-		Save      string
+		SaveName  string
 		Export    bool
 		Dupes     bool
 		Overwrite bool
@@ -115,12 +115,12 @@ func TestConfig_Scans(t *testing.T) {
 		{"no root", fields{}, "", true},
 		{"bad root", fields{}, "../test/missing", true},
 		{"test dir", fields{Dupes: true}, "../test", false},
-		{"exportdir", fields{Dupes: true, Save: tmp}, "../test", false},
+		{"exportdir", fields{Dupes: true, SaveName: tmp}, "../test", false},
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
 			c := &Config{
-				Save:      tt.fields.Save,
+				SaveName:  tt.fields.SaveName,
 				Export:    tt.fields.Export,
 				Dupes:     tt.fields.Dupes,
 				Overwrite: tt.fields.Overwrite,
@@ -139,7 +139,7 @@ func TestConfig_Scans(t *testing.T) {
 
 func TestConfig_separator(t *testing.T) {
 	type fields struct {
-		Save      string
+		SaveName  string
 		Export    bool
 		Dupes     bool
 		Overwrite bool
@@ -162,7 +162,7 @@ func TestConfig_separator(t *testing.T) {
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
 			c := Config{
-				Save:      tt.fields.Save,
+				SaveName:  tt.fields.SaveName,
 				Export:    tt.fields.Export,
 				Dupes:     tt.fields.Dupes,
 				Overwrite: tt.fields.Overwrite,
@@ -182,7 +182,7 @@ func TestConfig_separator(t *testing.T) {
 func TestConfig_Status(t *testing.T) {
 	color.Enable = false
 	type fields struct {
-		Save      string
+		SaveName  string
 		Export    bool
 		Dupes     bool
 		Overwrite bool
@@ -204,7 +204,7 @@ func TestConfig_Status(t *testing.T) {
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
 			c := Config{
-				Save:      tt.fields.Save,
+				SaveName:  tt.fields.SaveName,
 				Export:    tt.fields.Export,
 				Dupes:     tt.fields.Dupes,
 				Overwrite: tt.fields.Overwrite,

main.go

@@ -42,7 +42,7 @@ func main() {
 	flag.BoolVar(&c.Overwrite, "overwrite", false, "overwrite any previously exported comment text files")
 	flag.BoolVar(&c.Quiet, "quiet", false, "suppress zipcmt feedback except for errors")
 	flag.BoolVar(&c.Raw, "raw", false, "use the original comment text encoding (CP437, ISO-8859"+ellipsis+") instead of Unicode")
-	flag.StringVar(&c.Save, "save", "", "save the comments to uniquely named textfiles in this directory")
+	flag.StringVar(&c.SaveName, "save", "", "save the comments to uniquely named textfiles in this directory")
 	ver := flag.Bool("version", false, "version and information for this program")
 	a := flag.Bool("a", false, "alias for all")
 	o := flag.Bool("o", false, "alias for overwrite")
@@ -66,7 +66,7 @@ func main() {
 		c.Print = true
 	}
 	if *s != "" {
-		c.Save = *s
+		c.SaveName = *s
 	}
 	if *o {
 		c.Overwrite = true