Commitb6470ab

committed

feat: add a field on command to deprecate

1 parent09f1207 commitb6470abCopy full SHA for b6470ab

File tree

+49

-9

lines changed

+49

-9

lines changed

Lines changed: 12 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -43,6 +43,11 @@ type Command struct {`
`43`	`43`	`// Hidden determines whether the command should be hidden from help.`
`44`	`44`	`Hiddenbool`
`45`	`45`
	`46`	`+// Deprecated indicates whether this command is deprecated.`
	`47`	`+// If empty, the command is not deprecated.`
	`48`	`+// If set, the value is used as the deprecation message.`
	`49`	+Deprecatedstring`json:"deprecated,omitempty"`
	`50`	`+`
`46`	`51`	`// RawArgs determines whether the command should receive unparsed arguments.`
`47`	`52`	`// No flags are parsed when set, and the command is responsible for parsing`
`48`	`53`	`// its own flags.`
`@@ -316,6 +321,13 @@ func (inv *Invocation) CurWords() (prev string, cur string) {`
`316`	`321`	`// allArgs is wired through the stack so that global flags can be accepted`
`317`	`322`	`// anywhere in the command invocation.`
`318`	`323`	`func (invInvocation)run(staterunState)error {`
	`324`	`+ifinv.Command.Deprecated!="" {`
	`325`	`+fmt.Fprintf(inv.Stderr,"%s %q is deprecated!. %s\n",`
	`326`	`+prettyHeader("warning"),`
	`327`	`+inv.Command.FullName(),`
	`328`	`+inv.Command.Deprecated,`
	`329`	`+)`
	`330`	`+}`
`319`	`331`	`err:=inv.Command.Options.ParseEnv(inv.Environ)`
`320`	`332`	`iferr!=nil {`
`321`	`333`	`returnxerrors.Errorf("parsing env: %w",err)`

Lines changed: 21 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -376,6 +376,27 @@ func TestCommand(t *testing.T) {`
`376`	`376`	`err:=i.Run()`
`377`	`377`	`require.NoError(t,err,fio.Stdout.String())`
`378`	`378`	`})`
	`379`	`+`
	`380`	`+t.Run("DeprecatedCommand",func(t*testing.T) {`
	`381`	`+t.Parallel()`
	`382`	`+`
	`383`	`+deprecatedCmd:=&serpent.Command{`
	`384`	`+Use:"deprecated-cmd",`
	`385`	`+Deprecated:"This command is deprecated and will be removed in the future.",`
	`386`	`+Handler:func(i*serpent.Invocation)error {`
	`387`	`+_,_=i.Stdout.Write([]byte("Running deprecated command"))`
	`388`	`+returnnil`
	`389`	`+},`
	`390`	`+}`
	`391`	`+`
	`392`	`+i:=deprecatedCmd.Invoke()`
	`393`	`+io:=fakeIO(i)`
	`394`	`+err:=i.Run()`
	`395`	`+require.NoError(t,err)`
	`396`	`+expectedWarning:=fmt.Sprintf("WARNING: %q is deprecated!. %s\n",deprecatedCmd.Use,deprecatedCmd.Deprecated)`
	`397`	`+require.Equal(t,io.Stderr.String(),expectedWarning)`
	`398`	`+require.Contains(t,io.Stdout.String(),"Running deprecated command")`
	`399`	`+})`
`379`	`400`	`}`
`380`	`401`
`381`	`402`	`funcTestCommand_DeepNest(t*testing.T) {`

Lines changed: 11 additions & 9 deletions

Original file line number	Diff line number	Diff line change
`@@ -62,14 +62,21 @@ func helpColor(s string) termenv.Color {`
`62`	`62`	`returnhelpColorProfile.Color(s)`
`63`	`63`	`}`
`64`	`64`
	`65`	`+// prettyHeader formats a header string with consistent styling.`
	`66`	`+// It uppercases the text, adds a colon, and applies the header color.`
	`67`	`+funcprettyHeader(sstring)string {`
	`68`	`+headerFg:=pretty.FgColor(helpColor("#337CA0"))`
	`69`	`+s=strings.ToUpper(s)`
	`70`	`+txt:=pretty.String(s,":")`
	`71`	`+headerFg.Format(txt)`
	`72`	`+returntxt.String()`
	`73`	`+}`
	`74`	`+`
`65`	`75`	`vardefaultHelpTemplate=func()*template.Template {`
`66`	`76`	`var (`
`67`	`77`	`optionFg=pretty.FgColor(`
`68`	`78`	`helpColor("#04A777"),`
`69`	`79`	`)`
`70`		`-headerFg=pretty.FgColor(`
`71`		`-helpColor("#337CA0"),`
`72`		`-)`
`73`	`80`	`)`
`74`	`81`	`returntemplate.Must(`
`75`	`82`	`template.New("usage").Funcs(`
`@@ -85,12 +92,7 @@ var defaultHelpTemplate = func() *template.Template {`
`85`	`92`	`optionFg.Format(txt)`
`86`	`93`	`returntxt.String()`
`87`	`94`	`},`
`88`		`-"prettyHeader":func(sstring)string {`
`89`		`-s=strings.ToUpper(s)`
`90`		`-txt:=pretty.String(s,":")`
`91`		`-headerFg.Format(txt)`
`92`		`-returntxt.String()`
`93`		`-},`
	`95`	`+"prettyHeader":prettyHeader,`
`94`	`96`	`"typeHelper":func(opt*Option)string {`
`95`	`97`	`switchv:=opt.Value.(type) {`
`96`	`98`	`case*Enum:`

Lines changed: 5 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,11 @@`
`8`	`8`	`{{"\n"}}`
`9`	`9`	`{{- end}}`
`10`	`10`
	`11`	`+{{- with .Deprecated}}`
	`12`	`+{{- indent (printf"DEPRECATED: %s" .) 2 \| wrapTTY}}`
	`13`	`+{{"\n"}}`
	`14`	`+{{- end}}`
	`15`	`+`
`11`	`16`	`{{ with .Aliases}}`
`12`	`17`	`{{" Aliases:"}}{{- joinStrings .}}`
`13`	`18`	`{{- end}}`

Comments

(0)