500d6b04e6
If you allow a flag to be set from environment variables or files and a parse error occurs from one of them, it is very useful for the error message to mention where the value came from. Without this, it can be difficult to notice an error caused by an unexpected environment variable being set. Implements #1167.
97 lines
2.1 KiB
Go
97 lines
2.1 KiB
Go
package cli
|
|
|
|
import "flag"
|
|
|
|
type PathFlag struct {
|
|
Name string
|
|
Aliases []string
|
|
Usage string
|
|
EnvVars []string
|
|
FilePath string
|
|
Required bool
|
|
Hidden bool
|
|
TakesFile bool
|
|
Value string
|
|
DefaultText string
|
|
Destination *string
|
|
HasBeenSet bool
|
|
}
|
|
|
|
// IsSet returns whether or not the flag has been set through env or file
|
|
func (f *PathFlag) IsSet() bool {
|
|
return f.HasBeenSet
|
|
}
|
|
|
|
// String returns a readable representation of this value
|
|
// (for usage defaults)
|
|
func (f *PathFlag) String() string {
|
|
return FlagStringer(f)
|
|
}
|
|
|
|
// Names returns the names of the flag
|
|
func (f *PathFlag) Names() []string {
|
|
return flagNames(f.Name, f.Aliases)
|
|
}
|
|
|
|
// IsRequired returns whether or not the flag is required
|
|
func (f *PathFlag) IsRequired() bool {
|
|
return f.Required
|
|
}
|
|
|
|
// TakesValue returns true of the flag takes a value, otherwise false
|
|
func (f *PathFlag) TakesValue() bool {
|
|
return true
|
|
}
|
|
|
|
// GetUsage returns the usage string for the flag
|
|
func (f *PathFlag) GetUsage() string {
|
|
return f.Usage
|
|
}
|
|
|
|
// GetValue returns the flags value as string representation and an empty
|
|
// string if the flag takes no value at all.
|
|
func (f *PathFlag) GetValue() string {
|
|
return f.Value
|
|
}
|
|
|
|
// Apply populates the flag given the flag set and environment
|
|
func (f *PathFlag) Apply(set *flag.FlagSet) error {
|
|
// TODO: how to report the source of parse errors?
|
|
if val, ok, _ := flagFromEnvOrFile(f.EnvVars, f.FilePath); ok {
|
|
f.Value = val
|
|
f.HasBeenSet = true
|
|
}
|
|
|
|
for _, name := range f.Names() {
|
|
if f.Destination != nil {
|
|
set.StringVar(f.Destination, name, f.Value, f.Usage)
|
|
continue
|
|
}
|
|
set.String(name, f.Value, f.Usage)
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
// Path looks up the value of a local PathFlag, returns
|
|
// "" if not found
|
|
func (c *Context) Path(name string) string {
|
|
if fs := lookupFlagSet(name, c); fs != nil {
|
|
return lookupPath(name, fs)
|
|
}
|
|
|
|
return ""
|
|
}
|
|
|
|
func lookupPath(name string, set *flag.FlagSet) string {
|
|
f := set.Lookup(name)
|
|
if f != nil {
|
|
parsed, err := f.Value.String(), error(nil)
|
|
if err != nil {
|
|
return ""
|
|
}
|
|
return parsed
|
|
}
|
|
return ""
|
|
}
|