checkpoint: additional fields

cmd/enbas-cli-generators/main.go

@@ -1,7 +1,6 @@
 package main
 
 import (
-	"encoding/json"
 	"flag"
 	"fmt"
 	"os"
@@ -20,7 +19,7 @@ func main() {
 	flag.StringVar(&executorsFilePath, "path-to-enbas-executors", "", "The path to the executors Go file")
 	flag.Parse()
 
-	schema, err := readSchemaFile(enbasCLISchemaFilepath)
+	schema, err := newEnbasCLISchemaFromFile(enbasCLISchemaFilepath)
 	if err != nil {
 		fmt.Printf("ERROR: Unable to read the schema file: %v.\n", err)
 	}
@@ -34,22 +33,6 @@ func main() {
 	}
 }
 
-func readSchemaFile(path string) (enbasCLISchema, error) {
-	file, err := os.Open(path)
-	if err != nil {
-		return enbasCLISchema{}, fmt.Errorf("unable to open the schema file: %w", err)
-	}
-	defer file.Close()
-
-	var schema enbasCLISchema
-
-	if err := json.NewDecoder(file).Decode(&schema); err != nil {
-		return enbasCLISchema{}, fmt.Errorf("unable to decode the JSON data: %w", err)
-	}
-
-	return schema, nil
-}
-
 func generateExecutors(schema enbasCLISchema, output string) error {
 	funcMap := template.FuncMap{
 		"capitalise":         capitalise,

cmd/enbas-cli-generators/schema.go

@@ -53,13 +53,19 @@ func (e enbasCLISchemaFlagMap) getDescription(name string) string {
 }
 
 type enbasCLISchemaCommand struct {
-	AddPrinter bool                          `json:"addPrinter"`
+	AdditionalFields []enbasCLISchemaAdditionalFields `json:"additionalFields"`
-	AddConfig  bool                          `json:"addConfig"`
+	Flags            []enbasCLISchemaFlagReference    `json:"flags"`
-	Flags      []enbasCLISchemaFlagReference `json:"flags"`
+	Summary          string                           `json:"summary"`
-	Summary    string                        `json:"summary"`
+	UseConfig        bool                             `json:"useConfig"`
+	UsePrinter       bool                             `json:"usePrinter"`
 }
 
 type enbasCLISchemaFlagReference struct {
 	Flag    string `json:"flag"`
 	Default string `json:"default"`
 }
+
+type enbasCLISchemaAdditionalFields struct {
+	Name string `json:"name"`
+	Type string `json:"type"`
+}

cmd/enbas-cli-generators/templates.go

@@ -8,19 +8,52 @@ var executorsFileTemplate = `package executor
 // {{ $struct_name }} is the executor for the {{ $name }} command.
 type {{ $struct_name }} struct {
 	*flag.FlagSet
+	{{- if $command.UsePrinter }}
+	printer *printer.Printer
+	{{- end }}
+	{{- if $command.UseConfig }}
+	config *config.Config
+	{{- end }}
 	{{- range $flag := $command.Flags -}}
 	{{ print "" }}
 	{{ $flag.Flag }} {{ getFlagType $flag.Flag }}
 	{{- end -}}
+	{{- range $field := $command.AdditionalFields -}}
+	{{ print "" }}
+	{{ $field.Name }} {{ $field.Type }}
+	{{- end -}}
 	{{ print "" }}
 }
 
-func {{ $new_executor_function_name }}() *{{ $struct_name }} {
+func {{ $new_executor_function_name }}(
+	{{- if $command.UsePrinter }}
+	printer *printer.Printer,
+	{{- end }}
+	{{- if $command.UseConfig }}
+	config *config.Config,
+	{{- end }}
+	{{- range $field := $command.AdditionalFields -}}
+	{{ print "" }}
+	{{ $field.Name }} {{ $field.Type }},
+	{{- end -}}
+	{{ print "" }}
+) *{{ $struct_name }} {
 	exe := {{ $struct_name }}{
 		FlagSet: flag.NewFlagSet({{ printf "%q" $name }}, flag.ExitOnError),
+		{{- if $command.UsePrinter }}
+		printer: printer,
+		{{- end }}
+		{{- if $command.UseConfig }}
+		config: config,
+		{{- end }}
+		{{- range $field := $command.AdditionalFields -}}
+		{{ print "" }}
+		{{ $field.Name }}: {{ $field.Name }},
+		{{- end -}}
+		{{ print "" }}
 	}
 	{{ print "" }}
-	exe.Usage = commandUsageFunc({{ printf "%q" $name }}, {{ printf "%q" $command.Summary }}, showExe.FlagSet)
+	exe.Usage = commandUsageFunc({{ printf "%q" $name }}, {{ printf "%q" $command.Summary }}, exe.FlagSet)
 	{{ print "" }}
 	{{- range $flag := $command.Flags -}}
 	{{- if eq (getFlagType $flag.Flag) "string" -}}

schema/enbas_cli_schema.json

@@ -12,20 +12,32 @@
 
   "commands": {
     "login": {
-      "addPrinter": true,
-      "addConfig": true,
       "flags": [
         { "flag": "instance", "default": "" }
       ],
-      "summary": "Login to an account on GoToSocial"
+      "summary": "Log into an account on GoToSocial",
+      "useConfig": true,
+      "usePrinter": true
     },
     "version": {
-      "addPrinter": true,
+      "additionalFields": [
-      "addConfig": false,
+        { "name": "binaryVersion", "type": "string"},
-      "summary": "Prints the application's version and build information",
+        { "name": "buildTime",     "type": "string"},
+        { "name": "goVersion",     "type": "string"},
+        { "name": "gitCommit",     "type": "string"}
+      ],
       "flags": [
         { "flag": "full", "default": "false" }
-      ]
+      ],
+      "summary": "Prints the application's version and build information",
+      "useConfig": false,
+      "usePrinter": true
+    },
+    "whoami": {
+      "flags": [],
+      "summary": "Prints the account that you are currently logged into",
+      "useConfig": true,
+      "usePrinter": true
     }
   }
 }