rename to docsgen

Signed-off-by: Phil Prasek <[email protected]>

app/commandsgen/convert.go → app/docsgen/convert.go

@@ -1,6 +1,6 @@
-// Package commandsgen is built to read the YAML format described in
-// temporalcli/commandsgen/commands.yml and generate code from it.
-package commandsgen
+// Package docsgen is built to convert the existing
+// cli.Commands to a docs gen model and generate tcld docs from that
+package docsgen
 
 import (
 	"fmt"

app/commandsgen/docs.go → app/docsgen/docs.go

@@ -1,4 +1,6 @@
-package commandsgen
+// Package docsgen is built to convert the existing
+// cli.Commands to a docs gen model and generate tcld docs from that
+package docsgen
 
 import (
 	"bytes"

app/commandsgen/enrich.go → app/docsgen/enrich.go

@@ -1,6 +1,6 @@
-// Package commandsgen is built to read the YAML format described in
-// temporalcli/commandsgen/commands.yml and generate code from it.
-package commandsgen
+// Package docsgen is built to convert the existing
+// cli.Commands to a docs gen model and generate tcld docs from that
+package docsgen
 
 import (
 	_ "embed"

app/commandsgen/parse.go → app/docsgen/parse.go

@@ -1,6 +1,6 @@
-// Package commandsgen is built to read the YAML format described in
-// temporalcli/commandsgen/commands.yml and generate code from it.
-package commandsgen
+// Package docsgen is built to convert the existing
+// cli.Commands to a docs gen model and generate tcld docs from that
+package docsgen
 
 import (
 	_ "embed"

app/commandsgen/tcld.yml → app/docsgen/tcld.yml

@@ -1251,7 +1251,7 @@ commands:
           short: d
         - name: expiry
           type: timestamp
-          description: 'the absolute timestamp (RFC3339) when the apikey will expire, example: ''2024-10-16T15:30:07-07:00''.'
+          description: 'the absolute timestamp (RFC3339) when the apikey will expire, example: ''2024-10-16T16:48:12-07:00''.'
           short: e
         - name: name
           type: string

app/internal/cmd/gen-docs/main.go

@@ -7,7 +7,7 @@ import (
 	"path/filepath"
 	"runtime"
 
-	"github.com/temporalio/tcld/app/commandsgen"
+	"github.com/temporalio/tcld/app/docsgen"
 	"gopkg.in/yaml.v3"
 )
 
@@ -28,7 +28,7 @@ func run() error {
 	}
 
 	// Convert existing CLI commands to docs gen model
-	cmds, err := commandsgen.ConvertCommands()
+	cmds, err := docsgen.ConvertCommands()
 	if err != nil {
 		return fmt.Errorf("failed converting commands: %w", err)
 	}
@@ -40,20 +40,20 @@ func run() error {
 		fmt.Printf("Error while Marshaling. %v", err)
 	}
 
-	filePath := filepath.Join(file, "../../../../commandsgen/tcld.yml")
+	filePath := filepath.Join(file, "../../../../docsgen/tcld.yml")
 	err = os.WriteFile(filePath, yamlData, 0644)
 	if err != nil {
 		return fmt.Errorf("unable to write command yaml into %s", filePath)
 	}
 
 	// Enrich commands
-	cmds, err = commandsgen.EnrichCommands(cmds)
+	cmds, err = docsgen.EnrichCommands(cmds)
 	if err != nil {
 		return fmt.Errorf("failed enriching commands: %w", err)
 	}
 
 	// Generate docs
-	b, err := commandsgen.GenerateDocsFiles(cmds)
+	b, err := docsgen.GenerateDocsFiles(cmds)
 	if err != nil {
 		return err
 	}