chore(cli): rename Cmd to Command

I think Command is cleaner and my original decision to use "Cmd" a mistake. Plus this creates better parity with cobra.
coder · ammario · Mar 17, 2024 · Mar 15, 2024 · Mar 15, 2024 · Mar 15, 2024
commit 39cde0dd1de3feea8096a77c9ec6866dfee7faec
diff --git a/cli/agent.go b/cli/agent.go
@@ -34,7 +34,7 @@ import (
 	"github.com/coder/serpent"
 )
 
-func (r *RootCmd) workspaceAgent() *serpent.Cmd {
+func (r *RootCmd) workspaceAgent() *serpent.Command {
 	var (
 		auth                string
 		logDir              string
@@ -49,7 +49,7 @@ func (r *RootCmd) workspaceAgent() *serpent.Cmd {
 		slogJSONPath        string
 		slogStackdriverPath string
 	)
-	cmd := &serpent.Cmd{
+	cmd := &serpent.Command{
 		Use:   "agent",
 		Short: `Starts the Coder workspace agent.`,
 		// This command isn't useful to manually execute.

diff --git a/cli/autoupdate.go b/cli/autoupdate.go
@@ -11,9 +11,9 @@ import (
 	"github.com/coder/serpent"
 )
 
-func (r *RootCmd) autoupdate() *serpent.Cmd {
+func (r *RootCmd) autoupdate() *serpent.Command {
 	client := new(codersdk.Client)
-	cmd := &serpent.Cmd{
+	cmd := &serpent.Command{
 		Annotations: workspaceCommand,
 		Use:         "autoupdate <workspace> <always|never>",
 		Short:       "Toggle auto-update policy for a workspace",

diff --git a/cli/clilog/clilog_test.go b/cli/clilog/clilog_test.go
@@ -23,7 +23,7 @@ func TestBuilder(t *testing.T) {
 	t.Run("NoConfiguration", func(t *testing.T) {
 		t.Parallel()
 
-		cmd := &serpent.Cmd{
+		cmd := &serpent.Command{
 			Use:     "test",
 			Handler: testHandler(t),
 		}
@@ -35,7 +35,7 @@ func TestBuilder(t *testing.T) {
 		t.Parallel()
 
 		tempFile := filepath.Join(t.TempDir(), "test.log")
-		cmd := &serpent.Cmd{
+		cmd := &serpent.Command{
 			Use: "test",
 			Handler: testHandler(t,
 				clilog.WithHuman(tempFile),
@@ -51,7 +51,7 @@ func TestBuilder(t *testing.T) {
 		t.Parallel()
 
 		tempFile := filepath.Join(t.TempDir(), "test.log")
-		cmd := &serpent.Cmd{
+		cmd := &serpent.Command{
 			Use: "test",
 			Handler: testHandler(t,
 				clilog.WithHuman(tempFile),
@@ -68,7 +68,7 @@ func TestBuilder(t *testing.T) {
 		t.Parallel()
 
 		tempFile := filepath.Join(t.TempDir(), "test.log")
-		cmd := &serpent.Cmd{
+		cmd := &serpent.Command{
 			Use:     "test",
 			Handler: testHandler(t, clilog.WithHuman(tempFile)),
 		}
@@ -81,7 +81,7 @@ func TestBuilder(t *testing.T) {
 		t.Parallel()
 
 		tempFile := filepath.Join(t.TempDir(), "test.log")
-		cmd := &serpent.Cmd{
+		cmd := &serpent.Command{
 			Use:     "test",
 			Handler: testHandler(t, clilog.WithJSON(tempFile), clilog.WithVerbose()),
 		}
@@ -107,7 +107,7 @@ func TestBuilder(t *testing.T) {
 
 			// Use the default deployment values.
 			dv := coderdtest.DeploymentValues(t)
-			cmd := &serpent.Cmd{
+			cmd := &serpent.Command{
 				Use:     "test",
 				Handler: testHandler(t, clilog.FromDeploymentValues(dv)),
 			}
@@ -135,7 +135,7 @@ func TestBuilder(t *testing.T) {
 					Enable: true,
 				},
 			}
-			cmd := &serpent.Cmd{
+			cmd := &serpent.Command{
 				Use:     "test",
 				Handler: testHandler(t, clilog.FromDeploymentValues(dv)),
 			}
@@ -150,7 +150,7 @@ func TestBuilder(t *testing.T) {
 		t.Parallel()
 
 		tempFile := filepath.Join(t.TempDir(), "doesnotexist", "test.log")
-		cmd := &serpent.Cmd{
+		cmd := &serpent.Command{
 			Use: "test",
 			Handler: func(inv *serpent.Invocation) error {
 				logger, closeLog, err := clilog.New(

diff --git a/cli/clitest/clitest.go b/cli/clitest/clitest.go
@@ -56,7 +56,7 @@ func (l *logWriter) Write(p []byte) (n int, err error) {
 }
 
 func NewWithCommand(
-	t testing.TB, cmd *serpent.Cmd, args ...string,
+	t testing.TB, cmd *serpent.Command, args ...string,
 ) (*serpent.Invocation, config.Root) {
 	configDir := config.Root(t.TempDir())
 	// I really would like to fail test on error logs, but realistically, turning on by default

diff --git a/cli/clitest/golden.go b/cli/clitest/golden.go
@@ -48,7 +48,7 @@ func DefaultCases() []CommandHelpCase {
 
 // TestCommandHelp will test the help output of the given commands
 // using golden files.
-func TestCommandHelp(t *testing.T, getRoot func(t *testing.T) *serpent.Cmd, cases []CommandHelpCase) {
+func TestCommandHelp(t *testing.T, getRoot func(t *testing.T) *serpent.Command, cases []CommandHelpCase) {
 	t.Parallel()
 	rootClient, replacements := prepareTestData(t)
 
@@ -148,7 +148,7 @@ func NormalizeGoldenFile(t *testing.T, byt []byte) []byte {
 	return byt
 }
 
-func extractVisibleCommandPaths(cmdPath []string, cmds []*serpent.Cmd) [][]string {
+func extractVisibleCommandPaths(cmdPath []string, cmds []*serpent.Command) [][]string {
 	var cmdPaths [][]string
 	for _, c := range cmds {
 		if c.Hidden {

diff --git a/cli/clitest/handlers.go b/cli/clitest/handlers.go
@@ -11,8 +11,8 @@ import (
 // non-root commands (like 'groups' or 'users'), a handler is required.
 // These handlers are likely just the 'help' handler, but this must be
 // explicitly set.
-func HandlersOK(t *testing.T, cmd *serpent.Cmd) {
-	cmd.Walk(func(cmd *serpent.Cmd) {
+func HandlersOK(t *testing.T, cmd *serpent.Command) {
+	cmd.Walk(func(cmd *serpent.Command) {
 		if cmd.Handler == nil {
 			// If you see this error, make the Handler a helper invoker.
 			//   Handler: func(inv *serpent.Invocation) error {

diff --git a/cli/cliui/agent_test.go b/cli/cliui/agent_test.go
@@ -382,7 +382,7 @@ func TestAgent(t *testing.T) {
 			output := make(chan string, 100) // Buffered to avoid blocking, overflow is discarded.
 			logs := make(chan []codersdk.WorkspaceAgentLog, 1)
 
-			cmd := &serpent.Cmd{
+			cmd := &serpent.Command{
 				Handler: func(inv *serpent.Invocation) error {
 					tc.opts.Fetch = func(_ context.Context, _ uuid.UUID) (codersdk.WorkspaceAgent, error) {
 						t.Log("iter", len(tc.iter))
@@ -450,7 +450,7 @@ func TestAgent(t *testing.T) {
 		t.Parallel()
 		var fetchCalled uint64
 
-		cmd := &serpent.Cmd{
+		cmd := &serpent.Command{
 			Handler: func(inv *serpent.Invocation) error {
 				buf := bytes.Buffer{}
 				err := cliui.Agent(inv.Context(), &buf, uuid.Nil, cliui.AgentOptions{

diff --git a/cli/cliui/externalauth_test.go b/cli/cliui/externalauth_test.go
@@ -22,7 +22,7 @@ func TestExternalAuth(t *testing.T) {
 	defer cancel()
 
 	ptty := ptytest.New(t)
-	cmd := &serpent.Cmd{
+	cmd := &serpent.Command{
 		Handler: func(inv *serpent.Invocation) error {
 			var fetched atomic.Bool
 			return cliui.ExternalAuth(inv.Context(), inv.Stdout, cliui.ExternalAuthOptions{

diff --git a/cli/cliui/filter.go b/cli/cliui/filter.go
@@ -11,12 +11,12 @@ var defaultQuery = "owner:me"
 // and allows easy integration to a CLI command.
 // Example usage:
 //
-//	func (r *RootCmd) MyCmd() *serpent.Cmd {
+//	func (r *RootCmd) MyCmd() *serpent.Command {
 //	  var (
 //	    filter cliui.WorkspaceFilter
 //	    ...
 //	  )
-//	  cmd := &serpent.Cmd{
+//	  cmd := &serpent.Command{
 //	    ...
 //	  }
 //	  filter.AttachOptions(&cmd.Options)

diff --git a/cli/cliui/output_test.go b/cli/cliui/output_test.go
@@ -101,7 +101,7 @@ func Test_OutputFormatter(t *testing.T) {
 			},
 		)
 
-		cmd := &serpent.Cmd{}
+		cmd := &serpent.Command{}
 		f.AttachOptions(&cmd.Options)
 
 		fs := cmd.Options.FlagSet()

diff --git a/cli/cliui/prompt_test.go b/cli/cliui/prompt_test.go
@@ -147,7 +147,7 @@ func TestPrompt(t *testing.T) {
 
 func newPrompt(ptty *ptytest.PTY, opts cliui.PromptOptions, invOpt func(inv *serpent.Invocation)) (string, error) {
 	value := ""
-	cmd := &serpent.Cmd{
+	cmd := &serpent.Command{
 		Handler: func(inv *serpent.Invocation) error {
 			var err error
 			value, err = cliui.Prompt(inv, opts)
@@ -210,7 +210,7 @@ func TestPasswordTerminalState(t *testing.T) {
 
 // nolint:unused
 func passwordHelper() {
-	cmd := &serpent.Cmd{
+	cmd := &serpent.Command{
 		Handler: func(inv *serpent.Invocation) error {
 			cliui.Prompt(inv, cliui.PromptOptions{
 				Text:   "Password:",

diff --git a/cli/cliui/provisionerjob_test.go b/cli/cliui/provisionerjob_test.go
@@ -127,7 +127,7 @@ func newProvisionerJob(t *testing.T) provisionerJobTest {
 	}
 	jobLock := sync.Mutex{}
 	logs := make(chan codersdk.ProvisionerJobLog, 1)
-	cmd := &serpent.Cmd{
+	cmd := &serpent.Command{
 		Handler: func(inv *serpent.Invocation) error {
 			return cliui.ProvisionerJob(inv.Context(), inv.Stdout, cliui.ProvisionerJobOptions{
 				FetchInterval: time.Millisecond,

diff --git a/cli/cliui/select_test.go b/cli/cliui/select_test.go
@@ -31,7 +31,7 @@ func TestSelect(t *testing.T) {
 
 func newSelect(ptty *ptytest.PTY, opts cliui.SelectOptions) (string, error) {
 	value := ""
-	cmd := &serpent.Cmd{
+	cmd := &serpent.Command{
 		Handler: func(inv *serpent.Invocation) error {
 			var err error
 			value, err = cliui.Select(inv, opts)
@@ -72,7 +72,7 @@ func TestRichSelect(t *testing.T) {
 
 func newRichSelect(ptty *ptytest.PTY, opts cliui.RichSelectOptions) (string, error) {
 	value := ""
-	cmd := &serpent.Cmd{
+	cmd := &serpent.Command{
 		Handler: func(inv *serpent.Invocation) error {
 			richOption, err := cliui.RichSelect(inv, opts)
 			if err == nil {
@@ -105,7 +105,7 @@ func TestMultiSelect(t *testing.T) {
 
 func newMultiSelect(ptty *ptytest.PTY, items []string) ([]string, error) {
 	var values []string
-	cmd := &serpent.Cmd{
+	cmd := &serpent.Command{
 		Handler: func(inv *serpent.Invocation) error {
 			selectedItems, err := cliui.MultiSelect(inv, items)
 			if err == nil {

diff --git a/cli/configssh.go b/cli/configssh.go
@@ -215,7 +215,7 @@ func sshPrepareWorkspaceConfigs(ctx context.Context, client *codersdk.Client) (r
 	}
 }
 
-func (r *RootCmd) configSSH() *serpent.Cmd {
+func (r *RootCmd) configSSH() *serpent.Command {
 	var (
 		sshConfigFile       string
 		sshConfigOpts       sshConfigOptions
@@ -226,7 +226,7 @@ func (r *RootCmd) configSSH() *serpent.Cmd {
 		coderCliPath        string
 	)
 	client := new(codersdk.Client)
-	cmd := &serpent.Cmd{
+	cmd := &serpent.Command{
 		Annotations: workspaceCommand,
 		Use:         "config-ssh",
 		Short:       "Add an SSH Host entry for your workspaces \"ssh coder.workspace\"",

diff --git a/cli/create.go b/cli/create.go
@@ -19,7 +19,7 @@ import (
 	"github.com/coder/serpent"
 )
 
-func (r *RootCmd) create() *serpent.Cmd {
+func (r *RootCmd) create() *serpent.Command {
 	var (
 		templateName  string
 		startAt       string
@@ -31,7 +31,7 @@ func (r *RootCmd) create() *serpent.Cmd {
 		copyParametersFrom string
 	)
 	client := new(codersdk.Client)
-	cmd := &serpent.Cmd{
+	cmd := &serpent.Command{
 		Annotations: workspaceCommand,
 		Use:         "create [name]",
 		Short:       "Create a workspace",

diff --git a/cli/delete.go b/cli/delete.go
@@ -10,10 +10,10 @@ import (
 )
 
 // nolint
-func (r *RootCmd) deleteWorkspace() *serpent.Cmd {
+func (r *RootCmd) deleteWorkspace() *serpent.Command {
 	var orphan bool
 	client := new(codersdk.Client)
-	cmd := &serpent.Cmd{
+	cmd := &serpent.Command{
 		Annotations: workspaceCommand,
 		Use:         "delete <workspace>",
 		Short:       "Delete a workspace",

diff --git a/cli/dotfiles.go b/cli/dotfiles.go
@@ -19,12 +19,12 @@ import (
 	"github.com/coder/serpent"
 )
 
-func (r *RootCmd) dotfiles() *serpent.Cmd {
+func (r *RootCmd) dotfiles() *serpent.Command {
 	var symlinkDir string
 	var gitbranch string
 	var dotfilesRepoDir string
 
-	cmd := &serpent.Cmd{
+	cmd := &serpent.Command{
 		Use:        "dotfiles <git_repo_url>",
 		Middleware: serpent.RequireNArgs(1),
 		Short:      "Personalize your workspace by applying a canonical dotfiles repository",

diff --git a/cli/errors.go b/cli/errors.go
@@ -13,9 +13,9 @@ import (
 	"github.com/coder/serpent"
 )
 
-func (RootCmd) errorExample() *serpent.Cmd {
-	errorCmd := func(use string, err error) *serpent.Cmd {
-		return &serpent.Cmd{
+func (RootCmd) errorExample() *serpent.Command {
+	errorCmd := func(use string, err error) *serpent.Command {
+		return &serpent.Command{
 			Use: use,
 			Handler: func(inv *serpent.Invocation) error {
 				return err
@@ -52,7 +52,7 @@ func (RootCmd) errorExample() *serpent.Cmd {
 	// Some flags
 	var magicWord serpent.String
 
-	cmd := &serpent.Cmd{
+	cmd := &serpent.Command{
 		Use:   "example-error",
 		Short: "Shows what different error messages look like",
 		Long: "This command is pretty pointless, but without it testing errors is" +
@@ -61,7 +61,7 @@ func (RootCmd) errorExample() *serpent.Cmd {
 		Handler: func(inv *serpent.Invocation) error {
 			return inv.Command.HelpHandler(inv)
 		},
-		Children: []*serpent.Cmd{
+		Children: []*serpent.Command{
 			// Typical codersdk api error
 			errorCmd("api", apiError),
 

diff --git a/cli/exp.go b/cli/exp.go
@@ -2,15 +2,15 @@ package cli
 
 import "github.com/coder/serpent"
 
-func (r *RootCmd) expCmd() *serpent.Cmd {
-	cmd := &serpent.Cmd{
+func (r *RootCmd) expCmd() *serpent.Command {
+	cmd := &serpent.Command{
 		Use:   "exp",
 		Short: "Internal commands for testing and experimentation. These are prone to breaking changes with no notice.",
 		Handler: func(i *serpent.Invocation) error {
 			return i.Command.HelpHandler(i)
 		},
 		Hidden: true,
-		Children: []*serpent.Cmd{
+		Children: []*serpent.Command{
 			r.scaletestCmd(),
 			r.errorExample(),
 		},