go-arg/example_test.go

334 lines
8.9 KiB
Go
Raw Normal View History

2015-11-01 13:34:22 -06:00
package arg
import (
"fmt"
"os"
2019-05-03 14:56:41 -05:00
"strings"
2015-11-01 13:34:22 -06:00
)
2019-05-03 14:56:41 -05:00
func split(s string) []string {
return strings.Split(s, " ")
}
2015-11-01 13:34:22 -06:00
// This example demonstrates basic usage
2016-07-31 11:14:44 -05:00
func Example() {
2015-11-01 13:34:22 -06:00
// These are the args you would pass in on the command line
2019-05-03 14:56:41 -05:00
os.Args = split("./example --foo=hello --bar")
2015-11-01 13:34:22 -06:00
var args struct {
Foo string
Bar bool
}
2015-11-01 15:36:14 -06:00
MustParse(&args)
2015-11-01 13:34:22 -06:00
fmt.Println(args.Foo, args.Bar)
2019-05-03 14:56:41 -05:00
// output: hello true
2015-11-01 13:34:22 -06:00
}
// This example demonstrates arguments that have default values
2016-07-31 11:14:44 -05:00
func Example_defaultValues() {
2015-11-01 13:34:22 -06:00
// These are the args you would pass in on the command line
2019-05-03 14:56:41 -05:00
os.Args = split("./example")
2015-11-01 13:34:22 -06:00
var args struct {
Foo string `default:"abc"`
2015-11-01 13:34:22 -06:00
}
2015-11-01 15:36:14 -06:00
MustParse(&args)
2019-05-03 14:56:41 -05:00
fmt.Println(args.Foo)
// output: abc
2015-11-01 13:34:22 -06:00
}
// This example demonstrates arguments that are required
2016-07-31 11:14:44 -05:00
func Example_requiredArguments() {
2015-11-01 13:34:22 -06:00
// These are the args you would pass in on the command line
2019-05-03 14:56:41 -05:00
os.Args = split("./example --foo=abc --bar")
2015-11-01 13:34:22 -06:00
var args struct {
Foo string `arg:"required"`
Bar bool
}
2015-11-01 15:36:14 -06:00
MustParse(&args)
2019-05-03 14:56:41 -05:00
fmt.Println(args.Foo, args.Bar)
// output: abc true
2015-11-01 13:34:22 -06:00
}
// This example demonstrates positional arguments
2016-07-31 11:14:44 -05:00
func Example_positionalArguments() {
2015-11-01 13:34:22 -06:00
// These are the args you would pass in on the command line
2019-05-03 14:56:41 -05:00
os.Args = split("./example in out1 out2 out3")
2015-11-01 13:34:22 -06:00
var args struct {
Input string `arg:"positional"`
Output []string `arg:"positional"`
}
2015-11-01 15:36:14 -06:00
MustParse(&args)
2019-05-03 14:56:41 -05:00
fmt.Println("In:", args.Input)
fmt.Println("Out:", args.Output)
// output:
// In: in
// Out: [out1 out2 out3]
2015-11-01 13:34:22 -06:00
}
// This example demonstrates arguments that have multiple values
2016-07-31 11:14:44 -05:00
func Example_multipleValues() {
2015-11-01 13:34:22 -06:00
// The args you would pass in on the command line
2019-05-03 14:56:41 -05:00
os.Args = split("./example --database localhost --ids 1 2 3")
2015-11-01 13:34:22 -06:00
var args struct {
Database string
IDs []int64
}
2015-11-01 15:36:14 -06:00
MustParse(&args)
2019-05-03 14:56:41 -05:00
fmt.Printf("Fetching the following IDs from %s: %v", args.Database, args.IDs)
// output: Fetching the following IDs from localhost: [1 2 3]
2015-11-01 13:34:22 -06:00
}
// This eample demonstrates multiple value arguments that can be mixed with
// other arguments.
func Example_multipleMixed() {
2019-05-03 14:56:41 -05:00
os.Args = split("./example -c cmd1 db1 -f file1 db2 -c cmd2 -f file2 -f file3 db3 -c cmd3")
var args struct {
Commands []string `arg:"-c,separate"`
Files []string `arg:"-f,separate"`
Databases []string `arg:"positional"`
}
MustParse(&args)
fmt.Println("Commands:", args.Commands)
2019-05-03 14:56:41 -05:00
fmt.Println("Files:", args.Files)
fmt.Println("Databases:", args.Databases)
// output:
// Commands: [cmd1 cmd2 cmd3]
// Files: [file1 file2 file3]
// Databases: [db1 db2 db3]
}
2015-11-01 13:34:22 -06:00
// This example shows the usage string generated by go-arg
func Example_helpText() {
2015-11-01 13:34:22 -06:00
// These are the args you would pass in on the command line
2019-05-03 14:56:41 -05:00
os.Args = split("./example --help")
2015-11-01 13:34:22 -06:00
var args struct {
Input string `arg:"positional"`
Output []string `arg:"positional"`
2019-05-03 14:56:41 -05:00
Verbose bool `arg:"-v" help:"verbosity level"`
Dataset string `help:"dataset to use"`
Optimize int `arg:"-O,--optim" help:"optimization level"`
2015-11-01 13:34:22 -06:00
}
2019-05-03 15:07:12 -05:00
// This is only necessary when running inside golang's runnable example harness
osExit = func(int) {}
2015-11-01 15:36:14 -06:00
MustParse(&args)
2019-05-03 15:07:12 -05:00
// output:
// Usage: example [--verbose] [--dataset DATASET] [--optim OPTIM] INPUT [OUTPUT [OUTPUT ...]]
2019-05-03 15:07:12 -05:00
//
// Positional arguments:
// INPUT
// OUTPUT
//
// Options:
// --verbose, -v verbosity level
// --dataset DATASET dataset to use
// --optim OPTIM, -O OPTIM
2019-05-03 15:07:12 -05:00
// optimization level
// --help, -h display this help and exit
2015-11-01 13:34:22 -06:00
}
2019-05-03 17:02:10 -05:00
2019-11-29 15:22:21 -06:00
// This example shows the usage string generated by go-arg with customized placeholders
2019-11-30 13:31:08 -06:00
func Example_helpPlaceholder() {
2019-11-29 13:33:16 -06:00
// These are the args you would pass in on the command line
os.Args = split("./example --help")
var args struct {
2019-11-29 15:22:21 -06:00
Input string `arg:"positional" placeholder:"SRC"`
Output []string `arg:"positional" placeholder:"DST"`
Optimize int `arg:"-O" help:"optimization level" placeholder:"LEVEL"`
MaxJobs int `arg:"-j" help:"maximum number of simultaneous jobs" placeholder:"N"`
2019-11-29 13:33:16 -06:00
}
// This is only necessary when running inside golang's runnable example harness
osExit = func(int) {}
MustParse(&args)
// output:
2019-11-29 15:22:21 -06:00
// Usage: example [--optimize LEVEL] [--maxjobs N] SRC [DST [DST ...]]
2019-11-29 13:33:16 -06:00
// Positional arguments:
2019-11-29 15:22:21 -06:00
// SRC
// DST
2019-11-29 13:33:16 -06:00
// Options:
// --optimize LEVEL, -O LEVEL
// optimization level
2019-11-29 15:22:21 -06:00
// --maxjobs N, -j N maximum number of simultaneous jobs
2019-11-29 13:33:16 -06:00
// --help, -h display this help and exit
}
// This example shows the usage string generated by go-arg when using subcommands
func Example_helpTextWithSubcommand() {
2019-05-03 17:02:10 -05:00
// These are the args you would pass in on the command line
os.Args = split("./example --help")
type getCmd struct {
Item string `arg:"positional" help:"item to fetch"`
}
type listCmd struct {
Format string `help:"output format"`
Limit int
}
var args struct {
Verbose bool
Get *getCmd `arg:"subcommand" help:"fetch an item and print it"`
List *listCmd `arg:"subcommand" help:"list available items"`
}
// This is only necessary when running inside golang's runnable example harness
osExit = func(int) {}
MustParse(&args)
// output:
// Usage: example [--verbose] <command> [<args>]
2019-05-03 17:02:10 -05:00
//
// Options:
// --verbose
// --help, -h display this help and exit
//
// Commands:
// get fetch an item and print it
// list list available items
}
// This example shows the usage string generated by go-arg when using subcommands
func Example_helpTextForSubcommand() {
// These are the args you would pass in on the command line
os.Args = split("./example get --help")
type getCmd struct {
Item string `arg:"positional" help:"item to fetch"`
}
type listCmd struct {
Format string `help:"output format"`
Limit int
}
var args struct {
Verbose bool
Get *getCmd `arg:"subcommand" help:"fetch an item and print it"`
List *listCmd `arg:"subcommand" help:"list available items"`
}
// This is only necessary when running inside golang's runnable example harness
osExit = func(int) {}
MustParse(&args)
// output:
// Usage: example get ITEM
//
// Positional arguments:
// ITEM item to fetch
//
// Global options:
// --verbose
// --help, -h display this help and exit
}
// This example shows the error string generated by go-arg when an invalid option is provided
func Example_errorText() {
// These are the args you would pass in on the command line
os.Args = split("./example --optimize INVALID")
var args struct {
Input string `arg:"positional"`
Output []string `arg:"positional"`
Verbose bool `arg:"-v" help:"verbosity level"`
Dataset string `help:"dataset to use"`
Optimize int `arg:"-O,help:optimization level"`
}
// This is only necessary when running inside golang's runnable example harness
osExit = func(int) {}
stderr = os.Stdout
MustParse(&args)
// output:
// Usage: example [--verbose] [--dataset DATASET] [--optimize OPTIMIZE] INPUT [OUTPUT [OUTPUT ...]]
// error: error processing --optimize: strconv.ParseInt: parsing "INVALID": invalid syntax
}
// This example shows the error string generated by go-arg when an invalid option is provided
func Example_errorTextForSubcommand() {
// These are the args you would pass in on the command line
os.Args = split("./example get --count INVALID")
type getCmd struct {
Count int
}
var args struct {
Get *getCmd `arg:"subcommand"`
}
// This is only necessary when running inside golang's runnable example harness
osExit = func(int) {}
stderr = os.Stdout
MustParse(&args)
// output:
// Usage: example get [--count COUNT]
// error: error processing --count: strconv.ParseInt: parsing "INVALID": invalid syntax
}
2019-08-06 18:41:50 -05:00
// This example demonstrates use of subcommands
func Example_subcommand() {
// These are the args you would pass in on the command line
os.Args = split("./example commit -a -m what-this-commit-is-about")
type CheckoutCmd struct {
Branch string `arg:"positional"`
Track bool `arg:"-t"`
}
type CommitCmd struct {
All bool `arg:"-a"`
Message string `arg:"-m"`
}
type PushCmd struct {
Remote string `arg:"positional"`
Branch string `arg:"positional"`
SetUpstream bool `arg:"-u"`
}
var args struct {
Checkout *CheckoutCmd `arg:"subcommand:checkout"`
Commit *CommitCmd `arg:"subcommand:commit"`
Push *PushCmd `arg:"subcommand:push"`
Quiet bool `arg:"-q"` // this flag is global to all subcommands
}
// This is only necessary when running inside golang's runnable example harness
osExit = func(int) {}
stderr = os.Stdout
MustParse(&args)
switch {
case args.Checkout != nil:
fmt.Printf("checkout requested for branch %s\n", args.Checkout.Branch)
case args.Commit != nil:
fmt.Printf("commit requested with message \"%s\"\n", args.Commit.Message)
case args.Push != nil:
fmt.Printf("push requested from %s to %s\n", args.Push.Branch, args.Push.Remote)
}
// output:
// commit requested with message "what-this-commit-is-about"
}