feat: Add confirm prompts to some cli actions

Emyrk · Emyrk · commit a44b1fc55735 · 2022-05-19T10:28:05.000-05:00
- Workspace start/stop
- Add optional -y skip. Standardize -y flag across commands
diff --git a/cli/cliui/prompt.go b/cli/cliui/prompt.go
@@ -24,8 +24,21 @@ type PromptOptions struct {
 	Validate  func(string) error
 }
 
+func AllowSkipPrompt(cmd *cobra.Command) {
+	cmd.Flags().BoolP("yes", "y", false, "Bypass prompts")
+}
+
 // Prompt asks the user for input.
 func Prompt(cmd *cobra.Command, opts PromptOptions) (string, error) {
+	// If the cmd has a "yes" flag for skipping confirm prompts, honor it.
+	// If it's not a "Confirm" prompt, then don't skip. As the default value of
+	// "yes" makes no sense.
+	if opts.IsConfirm && cmd.Flags().Lookup("yes") != nil {
+		if skip, _ := cmd.Flags().GetBool("yes"); skip {
+			return "yes", nil
+		}
+	}
+
 	_, _ = fmt.Fprint(cmd.OutOrStdout(), Styles.FocusedPrompt.String()+opts.Text+" ")
 	if opts.IsConfirm {
 		opts.Default = "yes"
diff --git a/cli/create.go b/cli/create.go
@@ -194,6 +194,7 @@ func create() *cobra.Command {
 		},
 	}
 
+	cliui.AllowSkipPrompt(cmd)
 	cliflag.StringVarP(cmd.Flags(), &templateName, "template", "t", "CODER_TEMPLATE_NAME", "", "Specify a template name.")
 	return cmd
 }
diff --git a/cli/start.go b/cli/start.go
@@ -11,12 +11,20 @@ import (
 )
 
 func start() *cobra.Command {
-	return &cobra.Command{
+	cmd := &cobra.Command{
 		Annotations: workspaceCommand,
 		Use:         "start <workspace>",
 		Short:       "Build a workspace with the start state",
 		Args:        cobra.ExactArgs(1),
 		RunE: func(cmd *cobra.Command, args []string) error {
+			_, err := cliui.Prompt(cmd, cliui.PromptOptions{
+				Text:      "Confirm start workspace?",
+				IsConfirm: true,
+			})
+			if err != nil {
+				return err
+			}
+
 			client, err := createClient(cmd)
 			if err != nil {
 				return err
@@ -39,4 +47,6 @@ func start() *cobra.Command {
 			return cliui.WorkspaceBuild(cmd.Context(), cmd.OutOrStdout(), client, build.ID, before)
 		},
 	}
+	cliui.AllowSkipPrompt(cmd)
+	return cmd
 }
diff --git a/cli/stop.go b/cli/stop.go
@@ -11,12 +11,20 @@ import (
 )
 
 func stop() *cobra.Command {
-	return &cobra.Command{
+	cmd := &cobra.Command{
 		Annotations: workspaceCommand,
 		Use:         "stop <workspace>",
 		Short:       "Build a workspace with the stop state",
 		Args:        cobra.ExactArgs(1),
 		RunE: func(cmd *cobra.Command, args []string) error {
+			_, err := cliui.Prompt(cmd, cliui.PromptOptions{
+				Text:      "Confirm stop workspace?",
+				IsConfirm: true,
+			})
+			if err != nil {
+				return err
+			}
+
 			client, err := createClient(cmd)
 			if err != nil {
 				return err
@@ -39,4 +47,6 @@ func stop() *cobra.Command {
 			return cliui.WorkspaceBuild(cmd.Context(), cmd.OutOrStdout(), client, build.ID, before)
 		},
 	}
+	cliui.AllowSkipPrompt(cmd)
+	return cmd
 }
diff --git a/cli/templatecreate.go b/cli/templatecreate.go
@@ -21,7 +21,6 @@ import (
 
 func templateCreate() *cobra.Command {
 	var (
-		yes         bool
 		directory   string
 		provisioner string
 	)
@@ -84,14 +83,12 @@ func templateCreate() *cobra.Command {
 				return err
 			}
 
-			if !yes {
-				_, err = cliui.Prompt(cmd, cliui.PromptOptions{
-					Text:      "Confirm create?",
-					IsConfirm: true,
-				})
-				if err != nil {
-					return err
-				}
+			_, err = cliui.Prompt(cmd, cliui.PromptOptions{
+				Text:      "Confirm create?",
+				IsConfirm: true,
+			})
+			if err != nil {
+				return err
 			}
 
 			_, err = client.CreateTemplate(cmd.Context(), organization.ID, codersdk.CreateTemplateRequest{
@@ -121,7 +118,7 @@ func templateCreate() *cobra.Command {
 	if err != nil {
 		panic(err)
 	}
-	cmd.Flags().BoolVarP(&yes, "yes", "y", false, "Bypass prompts")
+	cliui.AllowSkipPrompt(cmd)
 	return cmd
 }
 

Original file line number	Diff line number	Diff line change
`@@ -194,6 +194,7 @@ func create() *cobra.Command {`
`194`	`194`	`},`
`195`	`195`	`}`
`196`	`196`
	`197`	`+ cliui.AllowSkipPrompt(cmd)`
`197`	`198`	`cliflag.StringVarP(cmd.Flags(), &templateName, "template", "t", "CODER_TEMPLATE_NAME", "", "Specify a template name.")`
`198`	`199`	`return cmd`
`199`	`200`	`}`