cmd/txtar-savedir: add -a flag and rename to txtar-c (#62)

I could never remember the txtar-savedir name and `txtar-c` seems more
reminiscent of the `tar` original.

Also it's sometimes useful to be able to create txtar files containing
dot files (particularly `.gomodproxy` directories) so allow that too.

Author: rogpeppe

cmd/txtar-savedir/savedir.go renamed to cmd/txtar-c/savedir.go

@@ -2,11 +2,11 @@
 // Use of this source code is governed by a BSD-style
 // license that can be found in the LICENSE file.
 
-// The txtar-savedir command archives a directory tree as a txtar archive printed to standard output.
+// The txtar-c command archives a directory tree as a txtar archive printed to standard output.
 //
 // Usage:
 //
-//	txtar-savedir /path/to/dir >saved.txt
+//	txtar-c /path/to/dir >saved.txt
 //
 // See https://godoc.org/github.com/rogpeppe/go-internal/txtar for details of the format
 // and how to parse a txtar file.
@@ -30,11 +30,14 @@ import (
 var flag = stdflag.NewFlagSet(os.Args[0], stdflag.ContinueOnError)
 
 func usage() {
-	fmt.Fprintf(os.Stderr, "usage: savedir dir >saved.txt\n")
+	fmt.Fprintf(os.Stderr, "usage: txtar-c dir >saved.txt\n")
 	flag.PrintDefaults()
 }
 
-var quoteFlag = flag.Bool("quote", false, "quote files that contain txtar file markers instead of failing")
+var (
+	quoteFlag = flag.Bool("quote", false, "quote files that contain txtar file markers instead of failing")
+	allFlag   = flag.Bool("a", false, "include dot files too")
+)
 
 func main() {
 	os.Exit(main1())
@@ -50,7 +53,7 @@ func main1() int {
 		return 2
 	}
 
-	log.SetPrefix("txtar-savedir: ")
+	log.SetPrefix("txtar-c: ")
 	log.SetFlags(0)
 
 	dir := flag.Arg(0)
@@ -62,7 +65,7 @@ func main1() int {
 			return nil
 		}
 		name := info.Name()
-		if strings.HasPrefix(name, ".") {
+		if strings.HasPrefix(name, ".") && !*allFlag {
 			if info.IsDir() {
 				return filepath.SkipDir
 			}
@@ -76,7 +79,7 @@ func main1() int {
 			log.Fatal(err)
 		}
 		if !utf8.Valid(data) {
-			log.Printf("%s: ignoring invalid UTF-8 data", path)
+			log.Printf("%s: ignoring file with invalid UTF-8 data", path)
 			return nil
 		}
 		if len(data) > 0 && !bytes.HasSuffix(data, []byte("\n")) {
@@ -97,7 +100,7 @@ func main1() int {
 			a.Comment = append(a.Comment, []byte("unquote "+filename+"\n")...)
 		}
 		a.Files = append(a.Files, txtar.File{
-			Name: filename,
+			Name: filepath.ToSlash(filename),
 			Data: data,
 		})
 		return nil

cmd/txtar-savedir/script_test.go renamed to cmd/txtar-c/script_test.go

@@ -13,7 +13,7 @@ import (
 
 func TestMain(m *testing.M) {
 	os.Exit(testscript.RunMain(m, map[string]func() int{
-		"txtar-savedir": main1,
+		"txtar-c": main1,
 	}))
 }
 

cmd/txtar-c/testdata/all.txt

@@ -0,0 +1,56 @@
+unquote expect-all
+unquote expect-no-all
+
+# Without the -a flag, it should ignore . files.
+txtar-c blah
+! stderr .+
+cmp stdout expect-no-all
+
+# With the -a flag, it should include them.
+txtar-c -a blah
+! stderr .+
+cmp stdout expect-all
+
+-- blah/.foo/foo --
+foo
+-- blah/.other --
+other
+-- blah/go.mod --
+module example.com/blah
+
+-- blah/main.go --
+package main
+
+import "fmt"
+
+func main() {
+  fmt.Println("Hello, world!")
+}
+-- expect-all --
+>-- .foo/foo --
+>foo
+>-- .other --
+>other
+>-- go.mod --
+>module example.com/blah
+>
+>-- main.go --
+>package main
+>
+>import "fmt"
+>
+>func main() {
+>  fmt.Println("Hello, world!")
+>}
+-- expect-no-all --
+>-- go.mod --
+>module example.com/blah
+>
+>-- main.go --
+>package main
+>
+>import "fmt"
+>
+>func main() {
+>  fmt.Println("Hello, world!")
+>}

cmd/txtar-savedir/testdata/needquote.txt renamed to cmd/txtar-c/testdata/needquote.txt

@@ -1,7 +1,7 @@
 unquote blah/withsep
 unquote expect
-txtar-savedir blah
-stderr 'txtar-savedir: blah.withsep: ignoring file with txtar marker in'
+txtar-c blah
+stderr 'txtar-c: blah.withsep: ignoring file with txtar marker in'
 cmp stdout expect
 
 -- blah/withsep --

cmd/txtar-savedir/testdata/quote.txt renamed to cmd/txtar-c/testdata/quote.txt

@@ -1,6 +1,6 @@
 unquote blah/withsep
 unquote expect
-txtar-savedir -quote blah
+txtar-c -quote blah
 ! stderr .+
 cmp stdout expect
 

cmd/txtar-savedir/testdata/txtar-savedir-self.txt renamed to cmd/txtar-c/testdata/txtar-savedir-self.txt

@@ -1,9 +1,5 @@
-# Because of https://github.com/rogpeppe/go-internal/issues/11 we cannot
-# define a txtar archive-generated file that is the golden output from txtar-savedir
-# So we can't actually test the output for now, instead we just rely on a simple
-# stdout check
 unquote expect
-txtar-savedir blah
+txtar-c blah
 ! stderr .+
 cmp stdout expect
 
@@ -18,6 +14,8 @@ import "fmt"
 func main() {
   fmt.Println("Hello, world!")
 }
+-- blah/subdir/x --
+x contents
 -- expect --
 >-- go.mod --
 >module example.com/blah
@@ -30,3 +28,5 @@ func main() {
 >func main() {
 >  fmt.Println("Hello, world!")
 >}
+>-- subdir/x --
+>x contents

goproxytest/proxy.go

@@ -16,7 +16,7 @@ content of the module zip file.  The path@vers prefix required of files in the
 zip file is added automatically by the proxy: the files in the archive have
 names without the prefix, like plain "go.mod", "x.go", and so on.
 
-See ../cmd/txtar-addmod and ../cmd/txtar-savedir for tools generate txtar
+See ../cmd/txtar-addmod and ../cmd/txtar-c for tools generate txtar
 files, although it's fine to write them by hand.
 */
 package goproxytest