README
¶
flagswrap
Some convenience wrapping around go-flags, mostly for error handling
The intent of this project is to provide a band-aide until the go-flags project has a chance to address the following issues:
- https://github.com/jessevdk/go-flags/issues/306
- https://github.com/jessevdk/go-flags/issues/361
- https://github.com/jessevdk/go-flags/issues/377
One possible use for this library is to change the (currently broken) example error handling here from this:
func main() {
if _, err := parser.Parse(); err != nil {
switch flagsErr := err.(type) {
case flags.ErrorType:
if flagsErr == flags.ErrHelp {
os.Exit(0)
}
os.Exit(1)
default:
os.Exit(1)
}
}
}
to this:
func main() {
if _, err := parser.Parse(); err != nil {
wrappedErr := flagswrap.WrapError(err)
switch {
case wrappedErr.IsHelp():
os.Exit(0)
// Self-documenting go-flags errors:
case wrappedErr.IsVerbose():
os.Exit(1)
// go-flags errors that need more context:
case wrappedErr.IsSilent():
// TODO: if you see duplicate error messages here, then
// you just need to move the error in question from the
// goFlagsSilentErrors to the goFlagsVerboseErrors map
// in ./errors.go -- and then submit a PR!
fmt.Printf("Error: %v\n", wrappedErr)
os.Exit(1)
default:
// TODO: anything here might justify a PR ...
fmt.Printf("ERROR (unexpected): %+v\n", wrappedErr)
os.Exit(1)
}
}
}
You can give this a shot with:
make
./bin/simple -h
./bin/simple
./bin/simple --bloop
./bin/version --version
./bin/dupe
Btw, this doesn't feel super Go-idiomatic -- any PRs making such improvements would be gladly reviewed and (ideally) accepted :-)
Documentation
¶
Overview ¶
Note: the documentation / examples for error handling in the go-flags library is currently a combination of lacking and wrong: * https://github.com/jessevdk/go-flags/issues/306 * https://github.com/jessevdk/go-flags/issues/361 * https://github.com/jessevdk/go-flags/issues/377
This package attempts to make working with CLI errors easier (and easier to maintain).
Index ¶
Constants ¶
This section is empty.
Variables ¶
var (
ErrGoFlagsErrorWrapper = errors.New("couldn't wrap go-flags error")
)
Source Files
Directories