Add Optin to ignore post terminator args

- Add *Command.IgnorePostTerminatorArgs field for optin
- Add method PostTerminatorArgs to get args after arg terminator "--"
- Remove PostTerminatorArgs from args when IgnorePostTerminatorArgs=true
This commit is contained in:
malko 2023-03-30 01:40:46 +02:00
parent 4dd4b25de3
commit b073425b8a

View file

@ -86,6 +86,9 @@ type Command struct {
// Expected arguments // Expected arguments
Args PositionalArgs Args PositionalArgs
// wether to include or not arguments after the -- arg terminator in args
IgnorePostTerminatorArgs bool
// ArgAliases is List of aliases for ValidArgs. // ArgAliases is List of aliases for ValidArgs.
// These are not suggested to the user in the shell completion, // These are not suggested to the user in the shell completion,
// but accepted if entered manually. // but accepted if entered manually.
@ -142,6 +145,8 @@ type Command struct {
// args is actual args parsed from flags. // args is actual args parsed from flags.
args []string args []string
// postTerminatorArgs is args after "--" terminator on the command line
postTerminatorArgs []string
// flagErrorBuf contains all error messages from pflag. // flagErrorBuf contains all error messages from pflag.
flagErrorBuf *bytes.Buffer flagErrorBuf *bytes.Buffer
// flags is full set of flags. // flags is full set of flags.
@ -653,6 +658,22 @@ Loop:
return commands return commands
} }
func splitPostTerminatorArgs(args []string) ([]string, []string) {
additionalArgsIndex := -1
var additionalArgs []string
for k, v := range args {
if v == "--" {
additionalArgsIndex = k
break
}
}
if additionalArgsIndex >= 0 {
additionalArgs = args[additionalArgsIndex+1:]
args = args[0 : len(args)-len(additionalArgs)-1]
}
return args, additionalArgs
}
// argsMinusFirstX removes only the first x from args. Otherwise, commands that look like // argsMinusFirstX removes only the first x from args. Otherwise, commands that look like
// openshift admin policy add-role-to-user admin my-user, lose the admin argument (arg[4]). // openshift admin policy add-role-to-user admin my-user, lose the admin argument (arg[4]).
// Special care needs to be taken not to remove a flag value. // Special care needs to be taken not to remove a flag value.
@ -844,6 +865,19 @@ func (c *Command) ArgsLenAtDash() int {
return c.Flags().ArgsLenAtDash() return c.Flags().ArgsLenAtDash()
} }
// check IgnorePostTerminatorArgs is set in the command chain
func (c *Command) shouldIgnorePostTerminatorArgs() bool {
if !c.IgnorePostTerminatorArgs && c.HasParent() {
return c.parent.shouldIgnorePostTerminatorArgs()
}
return c.IgnorePostTerminatorArgs
}
// return args that are placed after terminator "--"
func (c *Command) PostTerminatorArgs() []string {
return c.postTerminatorArgs
}
func (c *Command) execute(a []string) (err error) { func (c *Command) execute(a []string) (err error) {
if c == nil { if c == nil {
return fmt.Errorf("Called Execute() on a nil Command") return fmt.Errorf("Called Execute() on a nil Command")
@ -1065,6 +1099,12 @@ func (c *Command) ExecuteC() (cmd *Command, err error) {
cmd.ctx = c.ctx cmd.ctx = c.ctx
} }
if cmd.shouldIgnorePostTerminatorArgs() {
flags, cmd.postTerminatorArgs = splitPostTerminatorArgs(flags)
} else {
_, cmd.postTerminatorArgs = splitPostTerminatorArgs(flags)
}
err = cmd.execute(flags) err = cmd.execute(flags)
if err != nil { if err != nil {
// Always show help if requested, even if SilenceErrors is in // Always show help if requested, even if SilenceErrors is in