zflag

README

zflag

Convert structs into flag.FlagSet arguments using reflection.

Format

The flag tag uses the same order of arguments to define a flag using the library. Omitted values are ignored and trailing commas aren't necessary. Usage strings can also contain commas.

Everything	flag:"<name>,<default>,<usage>"
Just name	flag:"<name>"
Just name and default	flag:"<name>,<default>"
Name and usage	flag:"<name>,,<usage>"

Example

package main

import (
	"flag"
	"time"

	"github.com/wyattis/z/zflag"
)

type FileServerConfig struct {
	Addr    string        `flag:",:80,the address to use for this server"`
	Root    string        `flag:"dir,,which root directory to serve files from"`
	Timeout time.Duration `flag:",1s,how long to wait before timing out a request"`
	Tls     bool          `flag:",,start a TLS server"`
}

func main() {
	config := FileServerConfig{}
	set := flag.NewFlagSet("", flag.ExitOnError)
	if err := zflag.ReflectStruct(set, &config); err != nil {
		panic(err)
	}
	set.Usage()
}

Output

Usage:
  -addr string
        the address to use for this server (default ":80")
  -root string
        which root directory to serve files from
  -timeout duration
        how long to wait before timing out a request (default 1s)
  -tls
        start a TLS server

Documentation

Index

• func Configure(set *flag.FlagSet, config interface{}, opts *FlagOptions) error
• func Duration(name string, defaultVal ztime.Duration, description string) *ztime.Duration
• func DurationVar(v *ztime.Duration, name string, defaultVal ztime.Duration, description string)
• func Parse()
• type FlagOptions
• type MapSet
  • func (s *MapSet) Set(val string) error
  • func (s *MapSet) String() string
• type StringSliceVar
  • func StringSlice(defaults ...string) *StringSliceVar
  • func (s StringSliceVar) Len() int
  • func (s *StringSliceVar) Set(val string) error
  • func (s *StringSliceVar) SetDefault(val []string)
  • func (s StringSliceVar) String() string
  • func (s StringSliceVar) Val() []string

Functions

func Configure

func Configure(set *flag.FlagSet, config interface{}, opts *FlagOptions) error

Use reflection infer options for a flag.FlagSet based on the types and tags defined on a struct

func Duration

func Duration(name string, defaultVal ztime.Duration, description string) *ztime.Duration

func DurationVar

func DurationVar(v *ztime.Duration, name string, defaultVal ztime.Duration, description string)

func Parse

func Parse()

Types

type FlagOptions

type FlagOptions struct {
	Overwrite bool
}

type MapSet

type MapSet map[string][]string

func (*MapSet) Set

func (s *MapSet) Set(val string) error

func (*MapSet) String

func (s *MapSet) String() string

type StringSliceVar

type StringSliceVar struct {
	// contains filtered or unexported fields
}

func StringSlice

func StringSlice(defaults ...string) *StringSliceVar

func (StringSliceVar) Len

func (s StringSliceVar) Len() int

func (*StringSliceVar) Set

func (s *StringSliceVar) Set(val string) error

func (*StringSliceVar) SetDefault

func (s *StringSliceVar) SetDefault(val []string)

func (StringSliceVar) String

func (s StringSliceVar) String() string

func (StringSliceVar) Val

func (s StringSliceVar) Val() []string