clibase

package
v0.23.5 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 19, 2023 License: AGPL-3.0 Imports: 22 Imported by: 0

Documentation

Overview

Package clibase offers an all-in-one solution for a highly configurable CLI application. Within Coder, we use it for all of our subcommands, which demands more functionality than cobra/viber offers.

The Command interface is loosely based on the chi middleware pattern and http.Handler/HandlerFunc.

Index

Constants

This section is empty.

Variables

View Source 
var DiscardValue discardValue

DiscardValue does nothing but implements the pflag.Value interface. It's useful in cases where you want to accept an option, but access the underlying value directly instead of through the Option methods.

Functions

This section is empty.

Types

type Annotations 

type Annotations map[string]string

Annotations is an arbitrary key-mapping used to extend the Option and Command types. Its methods won't panic if the map is nil.

func (Annotations) Get 

func (a Annotations) Get(key string) (string, bool)

Get retrieves a key from the map, returning false if the key is not found or the map is nil.

func (Annotations) IsSet 

func (a Annotations) IsSet(key string) bool

IsSet returns true if the key is set in the annotations map.

func (Annotations) Mark 

func (a Annotations) Mark(key string, value string) Annotations

Mark sets a value on the annotations map, creating one if it doesn't exist. Mark does not mutate the original and returns a copy. It is suitable for chaining.

type Bool 

type Bool bool

func BoolOf added in v0.20.0 

func BoolOf(b *bool) *Bool

func (*Bool) NoOptDefValue 

func (*Bool) NoOptDefValue() string

func (*Bool) Set 

func (b *Bool) Set(s string) error

func (Bool) String 

func (b Bool) String() string

func (Bool) Type 

func (Bool) Type() string

func (Bool) Value 

func (b Bool) Value() bool

type Cmd 

type Cmd struct {
	// Parent is the direct parent of the command.
	Parent *Cmd
	// Children is a list of direct descendants.
	Children []*Cmd
	// Use is provided in form "command [flags] [args...]".
	Use string

	// Aliases is a list of alternative names for the command.
	Aliases []string

	// Short is a one-line description of the command.
	Short string

	// Hidden determines whether the command should be hidden from help.
	Hidden bool

	// RawArgs determines whether the command should receive unparsed arguments.
	// No flags are parsed when set, and the command is responsible for parsing
	// its own flags.
	RawArgs bool

	// Long is a detailed description of the command,
	// presented on its help page. It may contain examples.
	Long        string
	Options     OptionSet
	Annotations Annotations

	// Middleware is called before the Handler.
	// Use Chain() to combine multiple middlewares.
	Middleware  MiddlewareFunc
	Handler     HandlerFunc
	HelpHandler HandlerFunc
}

Cmd describes an executable command.

func (*Cmd) AddSubcommands added in v0.21.0 

func (c *Cmd) AddSubcommands(cmds ...*Cmd)

AddSubcommands adds the given subcommands, setting their Parent field automatically.

func (*Cmd) FullName 

func (c *Cmd) FullName() string

FullName returns the full invocation name of the command, as seen on the command line.

func (*Cmd) FullUsage 

func (c *Cmd) FullUsage() string

FullName returns usage of the command, preceded by the usage of its parents.

func (*Cmd) Invoke added in v0.20.0 

func (c *Cmd) Invoke(args ...string) *Invocation

Invoke creates a new invocation of the command, with stdio discarded.

The returned invocation is not live until Run() is called.

func (*Cmd) Name 

func (c *Cmd) Name() string

Name returns the first word in the Use string.

func (*Cmd) PrepareAll added in v0.21.0 

func (c *Cmd) PrepareAll() error

PrepareAll performs initialization and linting on the command and all its children.

func (*Cmd) Walk added in v0.20.0 

func (c *Cmd) Walk(fn func(*Cmd))

Walk calls fn for the command and all its children.

type Duration 

type Duration time.Duration

func DurationOf added in v0.20.0 

func DurationOf(d *time.Duration) *Duration

func (*Duration) MarshalYAML added in v0.22.1 

func (d *Duration) MarshalYAML() (interface{}, error)

func (*Duration) Set 

func (d *Duration) Set(v string) error

func (*Duration) String 

func (d *Duration) String() string

func (Duration) Type 

func (Duration) Type() string

func (*Duration) UnmarshalYAML added in v0.22.1 

func (d *Duration) UnmarshalYAML(n *yaml.Node) error

func (*Duration) Value 

func (d *Duration) Value() time.Duration

type Enum added in v0.21.0 

type Enum struct {
	Choices []string
	Value   *string
}

func EnumOf added in v0.21.0 

func EnumOf(v *string, choices ...string) *Enum

func (*Enum) Set added in v0.21.0 

func (e *Enum) Set(v string) error

func (*Enum) String added in v0.21.0 

func (e *Enum) String() string

func (*Enum) Type added in v0.21.0 

func (e *Enum) Type() string

type EnvVar 

type EnvVar struct {
	Name  string
	Value string
}

Var represents a single environment variable of form NAME=VALUE.

type Environ added in v0.20.0 

type Environ []EnvVar

func ParseEnviron added in v0.20.0 

func ParseEnviron(environ []string, prefix string) Environ

ParseEnviron returns all environment variables starting with prefix without said prefix.

func (Environ) Get added in v0.21.0 

func (e Environ) Get(name string) string

func (Environ) Lookup added in v0.20.0 

func (e Environ) Lookup(name string) (string, bool)

func (*Environ) Set added in v0.20.0 

func (e *Environ) Set(name, value string)

func (Environ) ToOS added in v0.20.0 

func (e Environ) ToOS() []string

type Group 

type Group struct {
	Parent      *Group `json:"parent,omitempty"`
	Name        string `json:"name,omitempty"`
	YAML        string `json:"yaml,omitempty"`
	Description string `json:"description,omitempty"`
}

Group describes a hierarchy of groups that an option or command belongs to.

func (*Group) Ancestry 

func (g *Group) Ancestry() []Group

Ancestry returns the group and all of its parents, in order.

func (*Group) FullName 

func (g *Group) FullName() string

type HandlerFunc added in v0.20.0 

type HandlerFunc func(i *Invocation) error

HandlerFunc handles an Invocation of a command.

type HostPort 

type HostPort struct {
	Host string
	Port string
}

HostPort is a host:port pair.

func (*HostPort) MarshalJSON 

func (hp *HostPort) MarshalJSON() ([]byte, error)

func (*HostPort) MarshalYAML added in v0.22.1 

func (hp *HostPort) MarshalYAML() (interface{}, error)

func (*HostPort) Set 

func (hp *HostPort) Set(v string) error

func (*HostPort) String 

func (hp *HostPort) String() string

func (*HostPort) Type 

func (*HostPort) Type() string

func (*HostPort) UnmarshalJSON 

func (hp *HostPort) UnmarshalJSON(b []byte) error

func (*HostPort) UnmarshalYAML added in v0.22.1 

func (hp *HostPort) UnmarshalYAML(n *yaml.Node) error

type Int64 

type Int64 int64

func Int64Of added in v0.20.0 

func Int64Of(i *int64) *Int64

func (*Int64) Set 

func (i *Int64) Set(s string) error

func (Int64) String 

func (i Int64) String() string

func (Int64) Type 

func (Int64) Type() string

func (Int64) Value 

func (i Int64) Value() int64

type Invocation added in v0.20.0 

type Invocation struct {
	Command *Cmd

	Args []string
	// Environ is a list of environment variables. Use EnvsWithPrefix to parse
	// os.Environ.
	Environ Environ
	Stdout  io.Writer
	Stderr  io.Writer
	Stdin   io.Reader
	// contains filtered or unexported fields
}

Invocation represents an instance of a command being executed.

func (*Invocation) Context added in v0.20.0 

func (inv *Invocation) Context() context.Context

func (*Invocation) ParsedFlags added in v0.20.0 

func (inv *Invocation) ParsedFlags() *pflag.FlagSet

func (*Invocation) Run added in v0.20.0 

func (inv *Invocation) Run() (err error)

Run executes the command. If two command share a flag name, the first command wins.

func (*Invocation) WithContext added in v0.20.0 

func (inv *Invocation) WithContext(ctx context.Context) *Invocation

WithContext returns a copy of the Invocation with the given context.

func (*Invocation) WithOS added in v0.20.0 

func (inv *Invocation) WithOS() *Invocation

WithOS returns the invocation as a main package, filling in the invocation's unset fields with OS defaults.

type MiddlewareFunc added in v0.20.0 

type MiddlewareFunc func(next HandlerFunc) HandlerFunc

MiddlewareFunc returns the next handler in the chain, or nil if there are no more.

func Chain added in v0.20.0 

func Chain(ms ...MiddlewareFunc) MiddlewareFunc

Chain returns a Handler that first calls middleware in order.

func RequireNArgs added in v0.20.0 

func RequireNArgs(want int) MiddlewareFunc

func RequireRangeArgs added in v0.20.0 

func RequireRangeArgs(start, end int) MiddlewareFunc

RequireRangeArgs returns a Middleware that requires the number of arguments to be between start and end (inclusive). If end is -1, then the number of arguments must be at least start.

type NoOptDefValuer 

type NoOptDefValuer interface {
	NoOptDefValue() string
}

NoOptDefValuer describes behavior when no option is passed into the flag.

This is useful for boolean or otherwise binary flags.

type Option 

type Option struct {
	Name        string `json:"name,omitempty"`
	Description string `json:"description,omitempty"`

	// Flag is the long name of the flag used to configure this option. If unset,
	// flag configuring is disabled.
	Flag string `json:"flag,omitempty"`
	// FlagShorthand is the one-character shorthand for the flag. If unset, no
	// shorthand is used.
	FlagShorthand string `json:"flag_shorthand,omitempty"`

	// Env is the environment variable used to configure this option. If unset,
	// environment configuring is disabled.
	Env string `json:"env,omitempty"`

	// YAML is the YAML key used to configure this option. If unset, YAML
	// configuring is disabled.
	YAML string `json:"yaml,omitempty"`

	// Default is parsed into Value if set.
	Default string `json:"default,omitempty"`
	// Value includes the types listed in values.go.
	Value pflag.Value `json:"value,omitempty"`

	// Annotations enable extensions to clibase higher up in the stack. It's useful for
	// help formatting and documentation generation.
	Annotations Annotations `json:"annotations,omitempty"`

	// Group is a group hierarchy that helps organize this option in help, configs
	// and other documentation.
	Group *Group `json:"group,omitempty"`

	// UseInstead is a list of options that should be used instead of this one.
	// The field is used to generate a deprecation warning.
	UseInstead []Option `json:"use_instead,omitempty"`

	Hidden bool `json:"hidden,omitempty"`

	ValueSource ValueSource `json:"value_source,omitempty"`
}

Option is a configuration option for a CLI application.

func (Option) YAMLPath added in v0.22.1 

func (o Option) YAMLPath() string

type OptionSet 

type OptionSet []Option

OptionSet is a group of options that can be applied to a command.

func (*OptionSet) Add 

func (s *OptionSet) Add(opts ...Option)

Add adds the given Options to the OptionSet.

func (*OptionSet) ByName added in v0.22.1 

func (s *OptionSet) ByName(name string) *Option

ByName returns the Option with the given name, or nil if no such option exists.

func (OptionSet) Filter added in v0.23.0 

func (s OptionSet) Filter(filter func(opt Option) bool) OptionSet

Filter will only return options that match the given filter. (return true)

func (*OptionSet) FlagSet 

func (s *OptionSet) FlagSet() *pflag.FlagSet

FlagSet returns a pflag.FlagSet for the OptionSet.

func (*OptionSet) MarshalYAML added in v0.22.1 

func (s *OptionSet) MarshalYAML() (any, error)

MarshalYAML converts the option set to a YAML node, that can be converted into bytes via yaml.Marshal.

The node is returned to enable post-processing higher up in the stack.

It is isomorphic with FromYAML.

func (*OptionSet) ParseEnv 

func (s *OptionSet) ParseEnv(vs []EnvVar) error

ParseEnv parses the given environment variables into the OptionSet. Use EnvsWithPrefix to filter out prefixes.

func (*OptionSet) SetDefaults 

func (s *OptionSet) SetDefaults() error

SetDefaults sets the default values for each Option, skipping values that already have a value source.

func (*OptionSet) UnmarshalYAML added in v0.22.1 

func (s *OptionSet) UnmarshalYAML(rootNode *yaml.Node) error

UnmarshalYAML converts the given YAML node into the option set. It is isomorphic with ToYAML.

type RunCommandError added in v0.21.0 

type RunCommandError struct {
	Cmd *Cmd
	Err error
}

func (*RunCommandError) Error added in v0.21.0 

func (e *RunCommandError) Error() string

func (*RunCommandError) Unwrap added in v0.21.0 

func (e *RunCommandError) Unwrap() error

type String 

type String string

func StringOf added in v0.20.0 

func StringOf(s *string) *String

func (*String) NoOptDefValue 

func (*String) NoOptDefValue() string

func (*String) Set 

func (s *String) Set(v string) error

func (String) String 

func (s String) String() string

func (String) Type 

func (String) Type() string

func (String) Value 

func (s String) Value() string

type StringArray added in v0.21.0 

type StringArray []string

StringArray is a slice of strings that implements pflag.Value and pflag.SliceValue.

func StringArrayOf added in v0.21.0 

func StringArrayOf(ss *[]string) *StringArray

func (*StringArray) Append added in v0.21.0 

func (s *StringArray) Append(v string) error

func (*StringArray) GetSlice added in v0.21.0 

func (s *StringArray) GetSlice() []string

func (*StringArray) Replace added in v0.21.0 

func (s *StringArray) Replace(vals []string) error

func (*StringArray) Set added in v0.21.0 

func (s *StringArray) Set(v string) error

func (StringArray) String added in v0.21.0 

func (s StringArray) String() string

func (StringArray) Type added in v0.21.0 

func (StringArray) Type() string

func (StringArray) Value added in v0.21.0 

func (s StringArray) Value() []string

type Struct 

type Struct[T any] struct {
	Value T
}

Struct is a special value type that encodes an arbitrary struct. It implements the flag.Value interface, but in general these values should only be accepted via config for ergonomics.

The string encoding type is YAML.

func (*Struct[T]) MarshalJSON 

func (s *Struct[T]) MarshalJSON() ([]byte, error)

func (*Struct[T]) MarshalYAML 

func (s *Struct[T]) MarshalYAML() (interface{}, error)

func (*Struct[T]) Set 

func (s *Struct[T]) Set(v string) error

func (*Struct[T]) String 

func (s *Struct[T]) String() string

func (*Struct[T]) Type 

func (s *Struct[T]) Type() string

func (*Struct[T]) UnmarshalJSON 

func (s *Struct[T]) UnmarshalJSON(b []byte) error

func (*Struct[T]) UnmarshalYAML 

func (s *Struct[T]) UnmarshalYAML(n *yaml.Node) error

type URL 

type URL url.URL

func URLOf added in v0.20.0 

func URLOf(u *url.URL) *URL

func (*URL) MarshalJSON 

func (u *URL) MarshalJSON() ([]byte, error)

func (*URL) MarshalYAML added in v0.22.1 

func (u *URL) MarshalYAML() (interface{}, error)

func (*URL) Set 

func (u *URL) Set(v string) error

func (*URL) String 

func (u *URL) String() string

func (*URL) Type 

func (*URL) Type() string

func (*URL) UnmarshalJSON 

func (u *URL) UnmarshalJSON(b []byte) error

func (*URL) UnmarshalYAML added in v0.22.1 

func (u *URL) UnmarshalYAML(n *yaml.Node) error

func (*URL) Value 

func (u *URL) Value() *url.URL

type ValueSource added in v0.22.1 

type ValueSource string
const (
	ValueSourceNone    ValueSource = ""
	ValueSourceFlag    ValueSource = "flag"
	ValueSourceEnv     ValueSource = "env"
	ValueSourceYAML    ValueSource = "yaml"
	ValueSourceDefault ValueSource = "default"
)

type YAMLConfigPath added in v0.22.1 

type YAMLConfigPath string

YAMLConfigPath is a special value type that encodes a path to a YAML configuration file where options are read from.

func (*YAMLConfigPath) Set added in v0.22.1 

func (p *YAMLConfigPath) Set(v string) error

func (*YAMLConfigPath) String added in v0.22.1 

func (p *YAMLConfigPath) String() string

func (*YAMLConfigPath) Type added in v0.22.1 

func (*YAMLConfigPath) Type() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.