chore: provide usage instruction for CLI argument failures (#12309)

Emyrk · web-flow · commit 97f083810f46 · 2024-02-28T12:10:17.000-06:00
* chore: add usage to # cli arg failures
diff --git a/cli/clibase/cmd.go b/cli/clibase/cmd.go
@@ -562,6 +562,16 @@ func Chain(ms ...MiddlewareFunc) MiddlewareFunc {
 	return chain(reversed...)
 }
 
+func ShowUsageOnError(next HandlerFunc) HandlerFunc {
+	return func(i *Invocation) error {
+		err := next(i)
+		if err != nil {
+			return xerrors.Errorf("Usage: %s\nError: %w", i.Command.FullUsage(), err)
+		}
+		return nil
+	}
+}
+
 func RequireNArgs(want int) MiddlewareFunc {
 	return RequireRangeArgs(want, want)
 }
@@ -574,7 +584,8 @@ func RequireRangeArgs(start, end int) MiddlewareFunc {
 		panic("start must be >= 0")
 	}
 	return func(next HandlerFunc) HandlerFunc {
-		return func(i *Invocation) error {
+		// ShowUsageOnError will add the command usage before the error message.
+		return ShowUsageOnError(func(i *Invocation) error {
 			got := len(i.Args)
 			switch {
 			case start == end && got != start:
@@ -614,7 +625,7 @@ func RequireRangeArgs(start, end int) MiddlewareFunc {
 			default:
 				return next(i)
 			}
-		}
+		})
 	}
 }
 
diff --git a/cli/errors.go b/cli/errors.go
@@ -45,7 +45,8 @@ func (RootCmd) errorExample() *clibase.Cmd {
 	apiError.(*codersdk.Error).Helper = "Have you tried turning it off and on again?"
 
 	//nolint:errorlint,forcetypeassert
-	apiErrorNoHelper := apiError.(*codersdk.Error)
+	cpy := *apiError.(*codersdk.Error)
+	apiErrorNoHelper := &cpy
 	apiErrorNoHelper.Helper = ""
 
 	// Some flags
@@ -94,7 +95,6 @@ func (RootCmd) errorExample() *clibase.Cmd {
 					)
 				},
 			},
-
 			{
 				Use: "validation",
 				Options: clibase.OptionSet{
@@ -114,6 +114,16 @@ func (RootCmd) errorExample() *clibase.Cmd {
 					return nil
 				},
 			},
+			{
+				Use: "arg-required <required>",
+				Middleware: clibase.Chain(
+					clibase.RequireNArgs(1),
+				),
+				Handler: func(i *clibase.Invocation) error {
+					_, _ = fmt.Fprint(i.Stdout, "Try running this without an argument\n")
+					return nil
+				},
+			},
 		},
 	}
 

Original file line number	Diff line number	Diff line change
`@@ -562,6 +562,16 @@ func Chain(ms ...MiddlewareFunc) MiddlewareFunc {`
`562`	`562`	`return chain(reversed...)`
`563`	`563`	`}`
`564`	`564`
	`565`	`+func ShowUsageOnError(next HandlerFunc) HandlerFunc {`
	`566`	`+ return func(i *Invocation) error {`
	`567`	`+ err := next(i)`
	`568`	`+ if err != nil {`
	`569`	`+ return xerrors.Errorf("Usage: %s\nError: %w", i.Command.FullUsage(), err)`
	`570`	`+ }`
	`571`	`+ return nil`
	`572`	`+ }`
	`573`	`+}`
	`574`	`+`
`565`	`575`	`func RequireNArgs(want int) MiddlewareFunc {`
`566`	`576`	`return RequireRangeArgs(want, want)`
`567`	`577`	`}`
`@@ -574,7 +584,8 @@ func RequireRangeArgs(start, end int) MiddlewareFunc {`
`574`	`584`	`panic("start must be >= 0")`
`575`	`585`	`}`
`576`	`586`	`return func(next HandlerFunc) HandlerFunc {`
`577`		`- return func(i *Invocation) error {`
	`587`	`+ // ShowUsageOnError will add the command usage before the error message.`
	`588`	`+ return ShowUsageOnError(func(i *Invocation) error {`
`578`	`589`	`got := len(i.Args)`
`579`	`590`	`switch {`
`580`	`591`	`case start == end && got != start:`
`@@ -614,7 +625,7 @@ func RequireRangeArgs(start, end int) MiddlewareFunc {`
`614`	`625`	`default:`
`615`	`626`	`return next(i)`
`616`	`627`	`}`
`617`		`- }`
	`628`	`+ })`
`618`	`629`	`}`
`619`	`630`	`}`
`620`	`631`