1
0
mirror of https://github.com/ipfs/kubo.git synced 2025-06-19 09:52:03 +08:00

commands: Added 'Description' fields to Command, Argument, Option

This commit is contained in:
Matt Bell
2014-11-07 20:56:06 -08:00
committed by Juan Batiz-Benet
parent 538dac153b
commit 351ed9589a
3 changed files with 12 additions and 7 deletions

View File

@ -8,8 +8,9 @@ const (
)
type Argument struct {
Name string
Type ArgumentType
Required bool
Variadic bool
Name string
Type ArgumentType
Required bool
Variadic bool
Description string
}

View File

@ -28,7 +28,9 @@ type Marshaller func(Response) ([]byte, error)
// Command is a runnable command, with input arguments and options (flags).
// It can also have Subcommands, to group units of work into sets.
type Command struct {
Description string
Help string
Options []Option
Arguments []Argument
Run Function

View File

@ -14,8 +14,9 @@ const (
// Option is used to specify a field that will be provided by a consumer
type Option struct {
Names []string // a list of unique names to
Type reflect.Kind // value must be this type
Names []string // a list of unique names to
Type reflect.Kind // value must be this type
Description string // a short string to describe this option
// TODO: add more features(?):
//Default interface{} // the default value (ignored if `Required` is true)
@ -30,7 +31,8 @@ const (
// options that are used by this package
var globalOptions = []Option{
Option{[]string{EncShort, EncLong}, String},
Option{[]string{EncShort, EncLong}, String,
"The encoding type the output should be encoded with (json, xml, or text)"},
}
// the above array of Options, wrapped in a Command