Add back the "list" command

#180 (comment)

Author: arp242

README.md

@@ -231,13 +231,8 @@ directory. The easiest way to copy the correct files is to use `copy`:
     % toml-test copy -toml 1.1.0 ./tests
 
 Alternatively, the [tests/files-toml-1.0.0] and [tests/files-toml-1.1.0] files
-contain a list of files you should run for that TOML version. You can use them
-with something like:
-
-    <files-toml-1.0.0 while read l; do
-        mkdir -p ~/my-test/"$(dirname "$l")"
-        cp -r "$l" ~/my-test/"$l"
-    done
+contain a list of files that should be run for that TOML version. This list is
+generated from the `toml-test list` output.
 
 [tests/files-toml-1.0.0]: tests/files-toml-1.0.0
 [tests/files-toml-1.1.0]: tests/files-toml-1.1.0

cmd/toml-test/copy.go

@@ -5,8 +5,6 @@ import (
 	"io"
 	"os"
 	"path/filepath"
-	"sort"
-	"strings"
 
 	tomltest "github.com/toml-lang/toml-test/v2"
 	"zgo.at/zli"
@@ -61,22 +59,3 @@ date   = %s
 `[1:], v, c, t.Format("2006-01-02"))), 0o0644)
 	zli.F(err)
 }
-
-func getList(r tomltest.Runner) []string {
-	l, err := r.List()
-	zli.F(err)
-
-	sort.Strings(l)
-	n := make([]string, 0, len(l)*2)
-	for _, ll := range l {
-		if strings.HasPrefix(ll, "encoder/") {
-			continue
-		}
-
-		if strings.HasPrefix(ll, "valid/") {
-			n = append(n, ll+".json")
-		}
-		n = append(n, ll+".toml")
-	}
-	return n
-}

cmd/toml-test/list.go

@@ -0,0 +1,46 @@
+package main
+
+import (
+	"fmt"
+	"sort"
+	"strings"
+
+	tomltest "github.com/toml-lang/toml-test/v2"
+	"zgo.at/zli"
+)
+
+func cmdList(f zli.Flags) {
+	var (
+		tomlVersion = f.String(tomltest.DefaultVersion, "toml")
+		asJSON      = f.Bool(false, "json")
+	)
+	zli.F(f.Parse())
+
+	l := getList(tomltest.NewRunner(tomltest.Runner{Version: tomlVersion.String()}))
+	if asJSON.Bool() {
+		newEnc().Encode(l)
+	} else {
+		for _, ll := range l {
+			fmt.Println(ll)
+		}
+	}
+}
+
+func getList(r tomltest.Runner) []string {
+	l, err := r.List()
+	zli.F(err)
+
+	sort.Strings(l)
+	n := make([]string, 0, len(l)*2)
+	for _, ll := range l {
+		if strings.HasPrefix(ll, "encoder/") {
+			continue
+		}
+
+		if strings.HasPrefix(ll, "valid/") {
+			n = append(n, ll+".json")
+		}
+		n = append(n, ll+".toml")
+	}
+	return n
+}

cmd/toml-test/main.go

@@ -27,7 +27,7 @@ func main() {
 	f := zli.NewFlags(os.Args)
 	helpFlag := f.Bool(false, "h", "help")
 	zli.F(f.Parse(zli.AllowUnknown()))
-	cmd, err := f.ShiftCommand("help", "version", "test", "copy", "cp")
+	cmd, err := f.ShiftCommand("help", "version", "test", "list", "ls", "copy", "cp")
 	if errors.Is(err, zli.ErrCommandNoneGiven{}) {
 		fmt.Print(usage)
 		return
@@ -54,6 +54,8 @@ func main() {
 		v := f.Bool(false, "v")
 		zli.F(f.Parse())
 		zli.PrintVersion(v.Bool())
+	case "list", "ls":
+		cmdList(f)
 	case "copy", "cp":
 		cmdCopy(f)
 	case "test":

cmd/toml-test/usage.go

@@ -5,6 +5,8 @@ import "strings"
 var helpTopics = map[string]string{
 	"":        usage,
 	"test":    usageTest,
+	"list":    usageList,
+	"ls":      usageList,
 	"copy":    usageCopy,
 	"cp":      usageCopy,
 	"version": usageVersion,
@@ -22,6 +24,7 @@ Commands:
     help      Show help and exit.
     test      Run tests. See "help test" for details.
     copy      Write all test files to disk.
+    list      List test filenames.
     version   Show version and exit.
 `[1:]
 
@@ -227,6 +230,17 @@ updates.
     -toml          TOML version to copy tests for (1.0, 1.1, or latest).
 `
 
+var usageList = `
+The "list" command lists all testfiles.
+
+This is mainly intended to generate the tests/files-toml-* files, which can
+make it more convenient to use the test cases without running toml-test.
+
+\x1b[1mFlags:\x1b[0m
+
+    -toml          TOML version to list tests for (1.0, 1.1, or latest).
+`
+
 var usageVersion = `
 Show version and exit.
 

gen.py

@@ -27,6 +27,12 @@ def gen_multi():
             if '/valid/' in f:  # TODO: version?
                 run_decoder('1.0.0', path, path[:-5] + '.json')
 
+def gen_list():
+    with open('tests/files-toml-1.0.0', 'w+') as fp:
+        subprocess.run(['go', 'run', './cmd/toml-test', 'list', '-toml=1.0.0'], stdout=fp)
+    with open('tests/files-toml-1.1.0', 'w+') as fp:
+        subprocess.run(['go', 'run', './cmd/toml-test', 'list', '-toml=1.1.0'], stdout=fp)
+
 def gen_spec(version, file):
     try:
         shutil.rmtree(f"{VALID_ROOT}-{version}")
@@ -165,3 +171,4 @@ def has_active_invalid(block):
         gen_multi()
         gen_spec('1.0.0', 'specs/v1.0.0.md')
         gen_spec('1.1.0', 'specs/v1.1.0.md')
+        gen_list()