command.go

package cli

// Root returns the Root command.
func (cmd *Command) Root() *Command {
	if cmd.Parent == nil {
		return cmd
	}
	return cmd.Parent.Root()
}

// OptMap returns a mapping of options by their
// names and aliases for this command.
func (cmd *Command) OptMap() map[string]*Opt {
	res := map[string]*Opt{}
	cmd.PutMap(res)
	return res
}

func (cmd *Command) PutMap(m map[string]*Opt) map[string]*Opt {
	for i := range cmd.Opts {
		o := cmd.Opts[i]
		m[o.Name] = o
		for _, al := range o.Aliases {
			m[al] = o
		}
	}
	return m
}

// Path returns the path in the command tree to this command.
func (cmd *Command) Path() []*Command {
	if cmd.Parent == nil {
		return []*Command{cmd}
	}
	return append(cmd.Parent.Path(), cmd)
}

// PutOptsAll places the options for all commands in the [Command.Path]
// of cmd, filtering out invalidated options along the way.
func (cmd *Command) PutOptsAll(dst map[string]*Opt) map[string]*Opt {
	res := map[string]*Opt{}
	for _, o := range cmd.Path() {
		res = o.PutMap(res)
		for k := range o.InvalidOpts {
			io := res[k]
			if io == nil {
				continue
			}
			for _, al := range io.Aliases {
				delete(res, al)
			}
			delete(res, k)
		}
	}
	return res
}

// AllOpts returns all options available when cmd
// is [Command.Run], keyed by name and alias.
func (cmd *Command) AllOpts() map[string]*Opt {
	return cmd.PutOptsAll(map[string]*Opt{})
}