chore: use go generate to generate command builders

redis · Oct 5, 2023 · d2daaaa · d2daaaa
1 parent f10a1ee
commit d2daaaa
Show file tree

Hide file tree

Showing 36 changed files with 67 additions and 38 deletions.
diff --git a/README.md b/README.md
@@ -445,6 +445,14 @@ require github.com/redis/rueidis v1.0.19-go1.18
 Contributions are welcome, including [issues](https://github.com/redis/rueidis/issues), [pull requests](https://github.com/redis/rueidis/pulls), and [discussions](https://github.com/redis/rueidis/discussions).
 Contributions mean a lot to us and help us improve this library and the community!
 
+### Generate command builders
+
+Command builders are generated based on the definitions in [./hack/cmds](./hack/cmds) by running:
+
+```sh
+go generate
+```
+
 ### Testing
 
 Please use the [./dockertest.sh](./dockertest.sh) script for running test cases locally.

diff --git a/hack/cmds/gen.go b/hack/cmds/gen.go
@@ -331,11 +331,30 @@ func (n *node) Walk(fn func(node *node)) {
 	}
 }
 
-func main() {
+var (
+	inputglob = "*.json"
+	outputdir = "../../internal/cmds"
+)
 
+// Usages:
+// 1) cd hack/cmds && go run gen.go
+// 2) go run hack/cmds/gen.go internal/cmds hack/cmds/*.json
+func main() {
+	var err error
+	var defs []string
 	var structs = map[string]map[string]goStruct{}
 
-	defs, err := filepath.Glob("*.json")
+	if len(os.Args) > 1 {
+		outputdir = os.Args[1]
+	}
+	if len(os.Args) > 2 {
+		defs = os.Args[2:]
+		if len(defs) == 1 {
+			defs, err = filepath.Glob(defs[0])
+		}
+	} else {
+		defs, err = filepath.Glob(inputglob)
+	}
 	if err != nil {
 		panic(err)
 	}
@@ -385,8 +404,8 @@ func main() {
 	}
 
 	for g, structs := range structs {
-		gfname := "../../internal/cmds/gen_" + g + ".go"
-		tfname := "../../internal/cmds/gen_" + g + "_test.go"
+		gfname := filepath.Join(outputdir, "gen_"+g+".go")
+		tfname := filepath.Join(outputdir, "gen_"+g+"_test.go")
 		gf, err := os.Create(gfname)
 		if err != nil {
 			panic(err)
@@ -439,7 +458,7 @@ func tests(f io.Writer, structs map[string]goStruct, prefix string) {
 		pathes = makePath(s, nil, pathes)
 	}
 
-	fmt.Fprintf(f, "// Code generated DO NOT EDIT\n\npackage cmds\n\n")
+	fmt.Fprintf(f, "// Code generated by go generate; DO NOT EDIT\n\npackage cmds\n\n")
 
 	fmt.Fprintf(f, "import \"testing\"\n\n")
 

diff --git a/internal/cmds/gen_bf_test.go b/internal/cmds/gen_bf_test.go
diff --git a/internal/cmds/gen_bitmap_test.go b/internal/cmds/gen_bitmap_test.go
diff --git a/internal/cmds/gen_cf_test.go b/internal/cmds/gen_cf_test.go
diff --git a/internal/cmds/gen_cluster_test.go b/internal/cmds/gen_cluster_test.go
diff --git a/internal/cmds/gen_cms_test.go b/internal/cmds/gen_cms_test.go
diff --git a/internal/cmds/gen_connection_test.go b/internal/cmds/gen_connection_test.go
diff --git a/internal/cmds/gen_gears_test.go b/internal/cmds/gen_gears_test.go
diff --git a/internal/cmds/gen_generic_test.go b/internal/cmds/gen_generic_test.go
diff --git a/internal/cmds/gen_geo_test.go b/internal/cmds/gen_geo_test.go
diff --git a/internal/cmds/gen_graph_test.go b/internal/cmds/gen_graph_test.go
diff --git a/internal/cmds/gen_hash_test.go b/internal/cmds/gen_hash_test.go
diff --git a/internal/cmds/gen_hyperloglog_test.go b/internal/cmds/gen_hyperloglog_test.go
diff --git a/internal/cmds/gen_inference_test.go b/internal/cmds/gen_inference_test.go
diff --git a/internal/cmds/gen_json_test.go b/internal/cmds/gen_json_test.go
diff --git a/internal/cmds/gen_list_test.go b/internal/cmds/gen_list_test.go
diff --git a/internal/cmds/gen_model_test.go b/internal/cmds/gen_model_test.go
diff --git a/internal/cmds/gen_pubsub_test.go b/internal/cmds/gen_pubsub_test.go
diff --git a/internal/cmds/gen_script_test.go b/internal/cmds/gen_script_test.go
diff --git a/internal/cmds/gen_scripting_test.go b/internal/cmds/gen_scripting_test.go
diff --git a/internal/cmds/gen_search_test.go b/internal/cmds/gen_search_test.go
diff --git a/internal/cmds/gen_sentinel_test.go b/internal/cmds/gen_sentinel_test.go
diff --git a/internal/cmds/gen_server_test.go b/internal/cmds/gen_server_test.go
diff --git a/internal/cmds/gen_set_test.go b/internal/cmds/gen_set_test.go
diff --git a/internal/cmds/gen_sorted_set_test.go b/internal/cmds/gen_sorted_set_test.go
diff --git a/internal/cmds/gen_stream_test.go b/internal/cmds/gen_stream_test.go
diff --git a/internal/cmds/gen_string_test.go b/internal/cmds/gen_string_test.go
diff --git a/internal/cmds/gen_suggestion_test.go b/internal/cmds/gen_suggestion_test.go
diff --git a/internal/cmds/gen_tdigest_test.go b/internal/cmds/gen_tdigest_test.go
diff --git a/internal/cmds/gen_tensor_test.go b/internal/cmds/gen_tensor_test.go
diff --git a/internal/cmds/gen_timeseries_test.go b/internal/cmds/gen_timeseries_test.go
diff --git a/internal/cmds/gen_topk_test.go b/internal/cmds/gen_topk_test.go
diff --git a/internal/cmds/gen_transactions_test.go b/internal/cmds/gen_transactions_test.go
diff --git a/internal/cmds/gen_triggers_and_functions_test.go b/internal/cmds/gen_triggers_and_functions_test.go
diff --git a/rueidis.go b/rueidis.go
@@ -1,6 +1,8 @@
 // Package rueidis is a fast Golang Redis RESP3 client that does auto pipelining and supports client side caching.
 package rueidis
 
+//go:generate go run hack/cmds/gen.go internal/cmds hack/cmds/*.json
+
 import (
 	"context"
 	"crypto/tls"