chore(cli): use option source name for deprecation warnings

ethanndickson · ethanndickson · commit 486932531ca1 · 2024-11-19T03:10:54.000Z
diff --git a/cli/restart.go b/cli/restart.go
@@ -26,6 +26,7 @@ func (r *RootCmd) restart() *serpent.Command {
 		Short:       "Restart a workspace",
 		Middleware: serpent.Chain(
 			serpent.RequireNArgs(1),
+			PrintDeprecatedOptions(),
 			r.InitClient(client),
 		),
 		Options: serpent.OptionSet{cliui.SkipPromptOption()},
diff --git a/cli/root.go b/cli/root.go
@@ -1307,3 +1307,53 @@ func headerTransport(ctx context.Context, serverURL *url.URL, header []string, h
 	}
 	return transport, nil
 }
+
+// printDeprecatedOptions loops through all command options, and prints
+// a warning for usage of deprecated options.
+func PrintDeprecatedOptions() serpent.MiddlewareFunc {
+	return func(next serpent.HandlerFunc) serpent.HandlerFunc {
+		return func(inv *serpent.Invocation) error {
+			opts := inv.Command.Options
+			// Print deprecation warnings.
+			for _, opt := range opts {
+				if opt.UseInstead == nil {
+					continue
+				}
+
+				if opt.ValueSource == serpent.ValueSourceNone || opt.ValueSource == serpent.ValueSourceDefault {
+					continue
+				}
+
+				warnStr := translateSource(opt.ValueSource, opt) + " is deprecated, please use "
+				for i, use := range opt.UseInstead {
+					warnStr += translateSource(opt.ValueSource, use) + " "
+					if i != len(opt.UseInstead)-1 {
+						warnStr += "and "
+					}
+				}
+				warnStr += "instead.\n"
+
+				cliui.Warn(inv.Stderr,
+					warnStr,
+				)
+			}
+
+			return next(inv)
+		}
+	}
+}
+
+// translateSource provides the name of the source of the option, depending on the
+// supplied target ValueSource.
+func translateSource(target serpent.ValueSource, opt serpent.Option) string {
+	switch target {
+	case serpent.ValueSourceFlag:
+		return fmt.Sprintf("`--%s`", opt.Flag)
+	case serpent.ValueSourceEnv:
+		return fmt.Sprintf("`%s`", opt.Env)
+	case serpent.ValueSourceYAML:
+		return fmt.Sprintf("`%s`", opt.YAML)
+	default:
+		return opt.Name
+	}
+}
diff --git a/cli/server.go b/cli/server.go
@@ -1240,41 +1240,6 @@ func templateHelpers(options *coderd.Options) map[string]any {
 	}
 }
 
-// printDeprecatedOptions loops through all command options, and prints
-// a warning for usage of deprecated options.
-func PrintDeprecatedOptions() serpent.MiddlewareFunc {
-	return func(next serpent.HandlerFunc) serpent.HandlerFunc {
-		return func(inv *serpent.Invocation) error {
-			opts := inv.Command.Options
-			// Print deprecation warnings.
-			for _, opt := range opts {
-				if opt.UseInstead == nil {
-					continue
-				}
-
-				if opt.ValueSource == serpent.ValueSourceNone || opt.ValueSource == serpent.ValueSourceDefault {
-					continue
-				}
-
-				warnStr := opt.Name + " is deprecated, please use "
-				for i, use := range opt.UseInstead {
-					warnStr += use.Name + " "
-					if i != len(opt.UseInstead)-1 {
-						warnStr += "and "
-					}
-				}
-				warnStr += "instead.\n"
-
-				cliui.Warn(inv.Stderr,
-					warnStr,
-				)
-			}
-
-			return next(inv)
-		}
-	}
-}
-
 // writeConfigMW will prevent the main command from running if the write-config
 // flag is set. Instead, it will marshal the command options to YAML and write
 // them to stdout.
diff --git a/cli/ssh.go b/cli/ssh.go
@@ -77,6 +77,7 @@ func (r *RootCmd) ssh() *serpent.Command {
 		Middleware: serpent.Chain(
 			serpent.RequireNArgs(1),
 			r.InitClient(client),
+			PrintDeprecatedOptions(),
 			initAppearance(client, &appearanceConfig),
 		),
 		Handler: func(inv *serpent.Invocation) (retErr error) {
diff --git a/cli/start.go b/cli/start.go
@@ -25,6 +25,7 @@ func (r *RootCmd) start() *serpent.Command {
 		Short:       "Start a workspace",
 		Middleware: serpent.Chain(
 			serpent.RequireNArgs(1),
+			PrintDeprecatedOptions(),
 			r.InitClient(client),
 		),
 		Options: serpent.OptionSet{cliui.SkipPromptOption()},
diff --git a/cli/update.go b/cli/update.go
@@ -22,6 +22,7 @@ func (r *RootCmd) update() *serpent.Command {
 		Long:        "Use --always-prompt to change the parameter values of the workspace.",
 		Middleware: serpent.Chain(
 			serpent.RequireNArgs(1),
+			PrintDeprecatedOptions(),
 			r.InitClient(client),
 		),
 		Handler: func(inv *serpent.Invocation) error {
diff --git a/enterprise/cli/provisionerdaemonstart.go b/enterprise/cli/provisionerdaemonstart.go
@@ -58,6 +58,7 @@ func (r *RootCmd) provisionerDaemonStart() *serpent.Command {
 		Use:   "start",
 		Short: "Run a provisioner daemon",
 		Middleware: serpent.Chain(
+			agpl.PrintDeprecatedOptions(),
 			// disable checks and warnings because this command starts a daemon; it is
 			// not meant for humans typing commands.  Furthermore, the checks are
 			// incompatible with PSK auth that this command uses
