helper

Documentation

Index

• Constants
• func Download(url, saveDir string, rename ...string) error
• func GetTerminalSize(refresh ...bool) (w int, h int)
• func IsGoodCmdId(name string) bool
• func IsGoodCmdName(name string) bool
• func IsGoodName(name string) bool
• func Panicf(format string, v ...any)
• func RenderText(input string, data any, fns template.FuncMap, isFile ...bool) string
• func SimpleDownload(url, saveAs string) (err error)
• type Downloader
  • func (d *Downloader) Download() error
• type HelpVars
  • func (hv *HelpVars) AddVar(name, value string)
  • func (hv *HelpVars) AddVars(vars map[string]string)
  • func (hv *HelpVars) GetVar(name string) string
  • func (hv *HelpVars) GetVars() map[string]string
  • func (hv *HelpVars) ReplaceVars(input string) string

Constants

const (
	// RegGoodName match a good option, argument name
	RegGoodName = `^[a-zA-Z][\w-]*$`
	// RegGoodCmdName match a good command name
	RegGoodCmdName = `^[a-zA-Z][\w-]*$`
	// RegGoodCmdId match command id. eg: "self:init"
	RegGoodCmdId = `^[a-zA-Z][\w:-]*$`
)

const HelpVarFormat = "{$%s}"

HelpVarFormat allow var replace on render help info.

Default support:

"{$binName}" "{$cmd}" "{$fullCmd}" "{$workDir}"

Functions

func Download

func Download(url, saveDir string, rename ...string) error

Download file from remote URL. from https://gist.github.com/albulescu/e61979cc852e4ee8f49c

func GetTerminalSize

func GetTerminalSize(refresh ...bool) (w int, h int)

GetTerminalSize for current console terminal.

func IsGoodCmdId

func IsGoodCmdId(name string) bool

IsGoodCmdId check

func IsGoodCmdName

func IsGoodCmdName(name string) bool

IsGoodCmdName check

func IsGoodName

func IsGoodName(name string) bool

IsGoodName check

func Panicf

func Panicf(format string, v ...any)

Panicf message

func RenderText

func RenderText(input string, data any, fns template.FuncMap, isFile ...bool) string

RenderText render text template with data. TODO use strutil.RenderText()

func SimpleDownload

func SimpleDownload(url, saveAs string) (err error)

SimpleDownload simple download

Types

type Downloader

type Downloader struct {
	FileURL  string
	SaveDir  string
	Filename string // save file name.
	Progress bool   // display progress info
	// contains filtered or unexported fields
}

Downloader struct definition. refer: https://gist.github.com/albulescu/e61979cc852e4ee8f49c

func (*Downloader) Download

func (d *Downloader) Download() error

Download begin

type HelpVars

type HelpVars struct {
	VarOpen, VarClose string

	// Vars you can add some vars map for render help info. TODO rename replaces/pairs
	Vars map[string]string
}

HelpVars struct. provide string var function for render help template.

func (*HelpVars) AddVar

func (hv *HelpVars) AddVar(name, value string)

AddVar get command name

func (*HelpVars) AddVars

func (hv *HelpVars) AddVars(vars map[string]string)

AddVars add multi tpl vars

func (*HelpVars) GetVar

func (hv *HelpVars) GetVar(name string) string

GetVar get a help var by name

func (*HelpVars) GetVars

func (hv *HelpVars) GetVars() map[string]string

GetVars get all tpl vars

func (*HelpVars) ReplaceVars

func (hv *HelpVars) ReplaceVars(input string) string

ReplaceVars replace vars in the input string.