tap

README

tap

Terminal Argument Parsing.

Documentation

Index

• Constants
• type HandlerFuncType
• type Parser
  • func NewParser(cli_name string, about string, help_commands []string, config ParserConfig) *Parser
  • func (p *Parser) AddCommand(name string, handler HandlerFuncType, docs string, required_args []string, ...)
  • func (p *Parser) Main() error
  • func (p *Parser) Print(flag string, format string, args ...any)
• type ParserConfig
  • func NewParserConfig(help_command_block_fmt string, help_args_header_block_fmt string, ...) ParserConfig

Constants

const Version = "0.6.1"

Types

type HandlerFuncType

type HandlerFuncType func(*Parser, []string) error

Type of handler for command.

type Parser

type Parser struct {
	Flags map[string]string
	// contains filtered or unexported fields
}

Tap - Terminal Argument Parsing

This parser - main object in tap.

Main methods:

- AddCommand(name string, handler HandlerFuncType)

- Main() - start parser

func NewParser

func NewParser(cli_name string, about string, help_commands []string, config ParserConfig) *Parser

Create Parser object.

func (*Parser) AddCommand

func (p *Parser) AddCommand(
	name string,
	handler HandlerFuncType,
	docs string,
	required_args []string,
	optional_args []string,
	unlimited_max_args bool,
)

Add command to parser.

func (*Parser) Main

func (p *Parser) Main() error

Main function of Parser.

func (*Parser) Print

func (p *Parser) Print(flag string, format string, args ...any)

Print info if flag parser flag is true

type ParserConfig

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

Configuration of Parser

func NewParserConfig

func NewParserConfig(
	help_command_block_fmt string,
	help_args_header_block_fmt string,
	help_args_data_block_fmt string,
	help_docs_header_block_fmt string,
	help_docs_data_block_fmt string,
	help_end_block_fmt string,
) ParserConfig

Create config for parser