pflagwrapper

README

PFlag Wrapper

A spf13/pflag wrapper to help in adding and chaining flags and flag-sets for convenience.

Install

go get -u github.com/Bhargav-InfraCloud/pflag-wrapper@latest

Usage

Documentation

Index

• Variables
• func NewFlag[T FlagType](target *T, name, shorthand, description string, defaultVal T) *flag[T]
• type FlagDetails
• type FlagSet
  • func NewFlagSet(name string) *FlagSet
• type FlagType
• type Manager
  • func NewManager(flagSetName string) *Manager
  • func (m *Manager) AddFlagSet(fs *FlagSet, flags ...FlagDetails) *Manager
  • func (m *Manager) Parse(args []string) error

Variables

var ErrHelp = pflag.ErrHelp

Functions

func NewFlag

func NewFlag[T FlagType](target *T, name, shorthand, description string, defaultVal T) *flag[T]

Types

type FlagDetails

type FlagDetails interface {
	// contains filtered or unexported methods
}

type FlagSet

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

func NewFlagSet

func NewFlagSet(name string) *FlagSet

type FlagType

type FlagType interface {
	string | bool | int | time.Duration
}

type Manager

type Manager struct {
	BaseFlagSet *pflag.FlagSet
	Usage       []string
	// contains filtered or unexported fields
}

func NewManager

func NewManager(flagSetName string) *Manager

func (*Manager) AddFlagSet

func (m *Manager) AddFlagSet(fs *FlagSet, flags ...FlagDetails) *Manager

func (*Manager) Parse

func (m *Manager) Parse(args []string) error