params

Documentation

Overview

Package params provides implementation of Go API for argument parser

Package params provides implementation of Go API for argument parser

Index

• type Data
• type Option
  • func WithConfigFileDescription(desc string) Option
  • func WithConfigFilePathDefault(path string) Option
  • func WithConfigFilePathKeys(keys ...string) Option
  • func WithVersionDescription(desc string) Option
  • func WithVersionFlagDefault(flag bool) Option
  • func WithVersionKeys(keys ...string) Option
• type Parser
  • func New(opts ...Option) Parser

Types

type Data

type Data interface {
	ConfigFilePath() string
	ShowVersion() bool
}

Data is an interface to get the configuration path and flag.

type Option

type Option func(*parser)

func WithConfigFileDescription

func WithConfigFileDescription(desc string) Option

WithConfigFileDescription returns Option that sets filePath.description.

func WithConfigFilePathDefault

func WithConfigFilePathDefault(path string) Option

WithConfigFilePathDefault returns Option that sets filePath.defaultPath.

func WithConfigFilePathKeys

func WithConfigFilePathKeys(keys ...string) Option

WithConfigFilePathKeys returns Option that sets filePath.keys.

func WithVersionDescription

func WithVersionDescription(desc string) Option

WithVersionDescription returns Option that sets version.description.

func WithVersionFlagDefault

func WithVersionFlagDefault(flag bool) Option

WithVersionFlagDefault returns Option that sets version.defaultFlag.

func WithVersionKeys

func WithVersionKeys(keys ...string) Option

WithVersionKeys returns Option that sets version.keys.

type Parser

type Parser interface {
	Parse() (Data, bool, error)
}

Parser is an interface to parse commnad-line argument.

func New

func New(opts ...Option) Parser

New returns parser object.