Commit97e4d51

authored

fix(cli/clibase): don't error on required flags with--help (#12181)

1 parentfbd436c commit97e4d51Copy full SHA for 97e4d51

File tree

+18

-1

lines changed

+18

-1

lines changed

Lines changed: 2 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -383,7 +383,8 @@ func (inv Invocation) run(state runState) error {`
`383`	`383`	`missing=append(missing,opt.Flag)`
`384`	`384`	`}`
`385`	`385`	`}`
`386`		`-iflen(missing)>0 {`
	`386`	+// Don't error for missing flags if `--help` was supplied.
	`387`	`+iflen(missing)>0&&!errors.Is(state.flagParseErr,pflag.ErrHelp) {`
`387`	`388`	`returnxerrors.Errorf("Missing values for the required flags: %s",strings.Join(missing,", "))`
`388`	`389`	`}`
`389`	`390`

Lines changed: 16 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -79,6 +79,10 @@ func TestCommand(t *testing.T) {`
`79`	`79`	`Required:true,`
`80`	`80`	`},`
`81`	`81`	`},`
	`82`	`+HelpHandler:func(i*clibase.Invocation)error {`
	`83`	`+_,_=i.Stdout.Write([]byte("help text.png"))`
	`84`	`+returnnil`
	`85`	`+},`
`82`	`86`	`Handler:func(i*clibase.Invocation)error {`
`83`	`87`	`_,_=i.Stdout.Write([]byte(fmt.Sprintf("%s-%t",reqStr,reqBool)))`
`84`	`88`	`returnnil`
`@@ -255,6 +259,18 @@ func TestCommand(t *testing.T) {`
`255`	`259`	`require.ErrorContains(t,err,"Missing values")`
`256`	`260`	`})`
`257`	`261`
	`262`	`+t.Run("RequiredFlagsMissingWithHelp",func(t*testing.T) {`
	`263`	`+t.Parallel()`
	`264`	`+i:=cmd().Invoke(`
	`265`	`+"required-flag",`
	`266`	`+"--help",`
	`267`	`+)`
	`268`	`+fio:=fakeIO(i)`
	`269`	`+err:=i.Run()`
	`270`	`+require.NoError(t,err)`
	`271`	`+require.Contains(t,fio.Stdout.String(),"help text.png")`
	`272`	`+})`
	`273`	`+`
`258`	`274`	`t.Run("RequiredFlagsMissingBool",func(t*testing.T) {`
`259`	`275`	`t.Parallel()`
`260`	`276`	`i:=cmd().Invoke(`

Comments

(0)