common

Documentation

Index

• Constants
• Variables
• func ByteSize(i any) string
• func Config(path, table string) map[string]any
• func DefaultField(value any) zapcore.Field
• func Dos2Unix(filename string) error
• func Examples(example string, cmdName ...string) string
• func GenerateQRCode(content string, size int, dest string) error
• func HTTPRequestContent(url string, config ...HTTPConfig) ([]byte, error)
• func HTTPRequestContentGB18030(url string, body io.Reader, methods ...string) ([]byte, error)
• func HTTPRequestRedirectURL(uri string) (string, error)
• func IsCIDR(i string) bool
• func IsDarwin() bool
• func IsDomain(i any) bool
• func IsFile(f string) bool
• func IsIP(i string) bool
• func IsIPv4(i string) bool
• func IsIPv4CIDR(i string) bool
• func IsIPv6(i string) bool
• func IsIPv6CIDR(i string) bool
• func IsURL(u string) bool
• func IsWindows() bool
• func NewField(key string, value any) zapcore.Field
• func NewLogger() *zap.Logger
• func NewPrinter() *printer
• func ReadQRCode(filename string) (string, error)
• func SetLoggerLevel(level string)
• func SliceStringToInterface(s []string) []any
• func SliceStringToString(s []string, args ...string) string
• func SliceStringToStringNoSpaces(s []string, args ...string) string
• func StringRemoveSpaces(s string) string
• func Usage(s string) string
• type HTTPConfig

Constants

const (
	KiB byteSize = 1 << (10 * iota)
	MiB
	GiB
	TiB
	PiB
	EiB
	ZiB
	YiB
)

const (
	JSONFormat  = "json"
	NoneFormat  = "none"
	TableFormat = "table"
	TomlFormat  = "toml"
	YamlFormat  = "yaml"
)

const (
	RepoOwner = "linzeyan"
	RepoName  = "ops-cli"

	UserAgent = "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36"
)

Variables

var (
	ErrConfigContent = errors.New("config content is incorrect")
	ErrConfigTable   = errors.New("table not found in the config")
	ErrFailedInitial = errors.New("initial failed")
	ErrIllegalPath   = errors.New("illegal file path")
	ErrInvalidArg    = errors.New("invalid argument")
	ErrInvalidFlag   = errors.New("required flag(s) not set")
	ErrInvalidIP     = errors.New("invalid IP")
	ErrInvalidFile   = errors.New("invalid file format")
	ErrInvalidToken  = errors.New("invalid token")
	ErrInvalidURL    = errors.New("invalid URL")
	ErrResponse      = errors.New("response error")
	ErrStatusCode    = errors.New("status code is not 200")
)

var (
	Context = context.Background()
	TimeNow = time.Now().Local()
)

Functions

func ByteSize

func ByteSize(i any) string

ByteSize return byte size string from giving value.

func Config

func Config(path, table string) map[string]any

Get secret token and other settings from config.

func DefaultField

func DefaultField(value any) zapcore.Field

DefaultField calls zap.Any and gives key name "arg".

func Dos2Unix

func Dos2Unix(filename string) error

Convert crlf to lf.

func Examples

func Examples(example string, cmdName ...string) string

Return the string with yellow color and prefix from the given string.

func GenerateQRCode

func GenerateQRCode(content string, size int, dest string) error

Generate QR code by giving content.

func HTTPRequestContent

func HTTPRequestContent(url string, config ...HTTPConfig) ([]byte, error)

HttpRequestContent make a simple request to url, and return response body, default request method is get.

func HTTPRequestContentGB18030

func HTTPRequestContentGB18030(url string, body io.Reader, methods ...string) ([]byte, error)

Same as HttpRequestContent, but read content in GB18030 format.

func HTTPRequestRedirectURL

func HTTPRequestRedirectURL(uri string) (string, error)

Return redirect url.

func IsCIDR

func IsCIDR(i string) bool

func IsDarwin

func IsDarwin() bool

func IsDomain

func IsDomain(i any) bool

If i is a domain return true.

func IsFile

func IsFile(f string) bool

If f is a valid path return true.

func IsIP

func IsIP(i string) bool

If i is an IP address return true.

func IsIPv4

func IsIPv4(i string) bool

If i is an ipv4 address return true.

func IsIPv4CIDR

func IsIPv4CIDR(i string) bool

func IsIPv6

func IsIPv6(i string) bool

If i is an ipv6 address return true.

func IsIPv6CIDR

func IsIPv6CIDR(i string) bool

func IsURL

func IsURL(u string) bool

If u is a valid url return true.

func IsWindows

func IsWindows() bool

func NewField

func NewField(key string, value any) zapcore.Field

NewField calls zap.Any.

func NewLogger

func NewLogger() *zap.Logger

NewLogger return field Log of global variable stdLogger.

func NewPrinter

func NewPrinter() *printer

func ReadQRCode

func ReadQRCode(filename string) (string, error)

func SetLoggerLevel

func SetLoggerLevel(level string)

SetLoggerLevel set log level from given level.

func SliceStringToInterface

func SliceStringToInterface(s []string) []any

Return the slice interface from the given slice string.

func SliceStringToString

func SliceStringToString(s []string, args ...string) string

Return the string from the given slice.

func SliceStringToStringNoSpaces

func SliceStringToStringNoSpaces(s []string, args ...string) string

Return the string without spaces from the given slice.

func StringRemoveSpaces

func StringRemoveSpaces(s string) string

Return string without spaces from the given string.

func Usage

func Usage(s string) string

Return the string with green color from the given string.

Types

type HTTPConfig

type HTTPConfig struct {
	Method  string
	Body    string
	Verbose bool
	Headers string
}