use FlagError

adonovan · adonovan · commit 721552212370 · 2021-10-21T10:06:11.000-04:00
diff --git a/pkg/cmd/codespace/ssh.go b/pkg/cmd/codespace/ssh.go
@@ -13,6 +13,7 @@ import (
 	"strings"
 
 	"github.com/cli/cli/v2/internal/codespaces"
+	"github.com/cli/cli/v2/pkg/cmdutil"
 	"github.com/cli/cli/v2/pkg/liveshare"
 	"github.com/spf13/cobra"
 )
@@ -228,7 +229,7 @@ func (a *App) Copy(ctx context.Context, args []string, opts cpOptions) error {
 		opts.scpArgs = append(opts.scpArgs, arg)
 	}
 	if !hasRemote {
-		return fmt.Errorf("cp: no argument is a 'remote:' filename")
+		return &cmdutil.FlagError{Err: fmt.Errorf("at least one argument must have a 'remote:' prefix")}
 	}
 	return a.SSH(ctx, nil, opts.sshOptions)
 }
diff --git a/pkg/cmd/repo/fork/fork.go b/pkg/cmd/repo/fork/fork.go
@@ -61,7 +61,7 @@ func NewCmdFork(f *cmdutil.Factory, runF func(*ForkOptions) error) *cobra.Comman
 		Use: "fork [<repository>] [-- <gitflags>...]",
 		Args: func(cmd *cobra.Command, args []string) error {
 			if cmd.ArgsLenAtDash() == 0 && len(args[1:]) > 0 {
-				return cmdutil.FlagError{Err: fmt.Errorf("repository argument required when passing 'git clone' flags")}
+				return &cmdutil.FlagError{Err: fmt.Errorf("repository argument required when passing 'git clone' flags")}
 			}
 			return nil
 		},
diff --git a/pkg/cmd/workflow/run/run.go b/pkg/cmd/workflow/run/run.go
@@ -78,7 +78,7 @@ func NewCmdRun(f *cmdutil.Factory, runF func(*RunOptions) error) *cobra.Command
 		`),
 		Args: func(cmd *cobra.Command, args []string) error {
 			if len(opts.MagicFields)+len(opts.RawFields) > 0 && len(args) == 0 {
-				return cmdutil.FlagError{Err: fmt.Errorf("workflow argument required when passing -f or -F")}
+				return &cmdutil.FlagError{Err: fmt.Errorf("workflow argument required when passing -f or -F")}
 			}
 			return nil
 		},
@@ -103,7 +103,7 @@ func NewCmdRun(f *cmdutil.Factory, runF func(*RunOptions) error) *cobra.Command
 				}
 				opts.JSONInput = string(jsonIn)
 			} else if opts.JSON {
-				return cmdutil.FlagError{Err: errors.New("--json specified but nothing on STDIN")}
+				return &cmdutil.FlagError{Err: errors.New("--json specified but nothing on STDIN")}
 			}
 
 			if opts.Selector == "" {
diff --git a/pkg/cmdutil/errors.go b/pkg/cmdutil/errors.go
@@ -6,16 +6,17 @@ import (
 	"github.com/AlecAivazis/survey/v2/terminal"
 )
 
-// FlagError is the kind of error raised in flag processing
+// A *FlagError indicates an error processing command-line flags or other arguments.
+// Such errors cause the application to display the usage message.
 type FlagError struct {
 	Err error
 }
 
-func (fe FlagError) Error() string {
+func (fe *FlagError) Error() string {
 	return fe.Err.Error()
 }
 
-func (fe FlagError) Unwrap() error {
+func (fe *FlagError) Unwrap() error {
 	return fe.Err
 }
 

Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,7 @@ import (`
`13`	`13`	`"strings"`
`14`	`14`
`15`	`15`	`"github.com/cli/cli/v2/internal/codespaces"`
	`16`	`+ "github.com/cli/cli/v2/pkg/cmdutil"`
`16`	`17`	`"github.com/cli/cli/v2/pkg/liveshare"`
`17`	`18`	`"github.com/spf13/cobra"`
`18`	`19`	`)`
`@@ -228,7 +229,7 @@ func (a *App) Copy(ctx context.Context, args []string, opts cpOptions) error {`
`228`	`229`	`opts.scpArgs = append(opts.scpArgs, arg)`
`229`	`230`	`}`
`230`	`231`	`if !hasRemote {`
`231`		`- return fmt.Errorf("cp: no argument is a 'remote:' filename")`
	`232`	`+ return &cmdutil.FlagError{Err: fmt.Errorf("at least one argument must have a 'remote:' prefix")}`
`232`	`233`	`}`
`233`	`234`	`return a.SSH(ctx, nil, opts.sshOptions)`
`234`	`235`	`}`
Original file line number	Diff line number	Diff line change
`@@ -61,7 +61,7 @@ func NewCmdFork(f cmdutil.Factory, runF func(ForkOptions) error) *cobra.Comman`
`61`	`61`	`Use: "fork [<repository>] [-- <gitflags>...]",`
`62`	`62`	`Args: func(cmd *cobra.Command, args []string) error {`
`63`	`63`	`if cmd.ArgsLenAtDash() == 0 && len(args[1:]) > 0 {`
`64`		`- return cmdutil.FlagError{Err: fmt.Errorf("repository argument required when passing 'git clone' flags")}`
	`64`	`+ return &cmdutil.FlagError{Err: fmt.Errorf("repository argument required when passing 'git clone' flags")}`
`65`	`65`	`}`
`66`	`66`	`return nil`
`67`	`67`	`},`
Original file line number	Diff line number	Diff line change
`@@ -78,7 +78,7 @@ func NewCmdRun(f cmdutil.Factory, runF func(RunOptions) error) *cobra.Command`
`78`	`78`	`),
`79`	`79`	`Args: func(cmd *cobra.Command, args []string) error {`
`80`	`80`	`if len(opts.MagicFields)+len(opts.RawFields) > 0 && len(args) == 0 {`
`81`		`- return cmdutil.FlagError{Err: fmt.Errorf("workflow argument required when passing -f or -F")}`
	`81`	`+ return &cmdutil.FlagError{Err: fmt.Errorf("workflow argument required when passing -f or -F")}`
`82`	`82`	`}`
`83`	`83`	`return nil`
`84`	`84`	`},`
`@@ -103,7 +103,7 @@ func NewCmdRun(f cmdutil.Factory, runF func(RunOptions) error) *cobra.Command`
`103`	`103`	`}`
`104`	`104`	`opts.JSONInput = string(jsonIn)`
`105`	`105`	`} else if opts.JSON {`
`106`		`- return cmdutil.FlagError{Err: errors.New("--json specified but nothing on STDIN")}`
	`106`	`+ return &cmdutil.FlagError{Err: errors.New("--json specified but nothing on STDIN")}`
`107`	`107`	`}`
`108`	`108`
`109`	`109`	`if opts.Selector == "" {`
Original file line number	Diff line number	Diff line change
`@@ -6,16 +6,17 @@ import (`
`6`	`6`	`"github.com/AlecAivazis/survey/v2/terminal"`
`7`	`7`	`)`
`8`	`8`
`9`		`-// FlagError is the kind of error raised in flag processing`
	`9`	`+// A *FlagError indicates an error processing command-line flags or other arguments.`
	`10`	`+// Such errors cause the application to display the usage message.`
`10`	`11`	`type FlagError struct {`
`11`	`12`	`Err error`
`12`	`13`	`}`
`13`	`14`
`14`		`-func (fe FlagError) Error() string {`
	`15`	`+func (fe *FlagError) Error() string {`
`15`	`16`	`return fe.Err.Error()`
`16`	`17`	`}`
`17`	`18`
`18`		`-func (fe FlagError) Unwrap() error {`
	`19`	`+func (fe *FlagError) Unwrap() error {`
`19`	`20`	`return fe.Err`
`20`	`21`	`}`
`21`	`22`