Categorygithub.com/toxyl/glog

modulepackage

1.0.0-alpha.15

Repository: https://github.com/toxyl/glog.git

Documentation: pkg.go.dev

# README

glog

Colorful Golang logger for use with CLI projects

Usage Example

go run example/main.go

Output Example

Example Output

Notes

Please be aware that this package bears no relation whatsoever to Golang's glog package or Google's glog package.

# Packages

example

No description provided by the author

# Functions

Addr

No description provided by the author

AddrIPv4Port

No description provided by the author

Auto

Auto will automatically choose a highlighter based on the type of the given `interface{}`s.

Bold

No description provided by the author

Bool

Bool colors the given booleans.

ClearToEOL

No description provided by the author

Color

No description provided by the author

ConnLocal

No description provided by the author

ConnRemote

No description provided by the author

Date

Date parses the date portion of `t`, formats it (2006-01-02).

DateTime

DateTime parses `t`, formats it (2006-01-02 15:04:05).

DateTime12hr

DateTime12hr parses `t`, formats it as AM/PM (2006-01-02 03:04:05pm).

Duration

Duration explodes the result of (time.Duration).String() into its segments and colors them.

DurationMilliseconds

DurationMilliseconds explodes the result of (time.Duration).String() into its segments and colors them.

DurationShort

DurationShort colors the same way as Float() does but will make `n` human-readable using time suffixes.

Error

Error colors `err.Error()` according to the config, or returns "nil" if no error was present.

File

File colors `file` according to the config using the `os.PathSeparator`.

Float

Float formats `n` with the given `precision` and colors the result.

GetFloat

No description provided by the author

GetRandomInt

No description provided by the author

Highlight

Highlight colorizes each given string (identical strings always get the same color).

HighlightDebug

HighlightDebug colorizes the `message`.

HighlightError

HighlightError colorizes the `message`.

HighlightInfo

HighlightInfo colorizes the `message`.

HighlightNotOK

HighlightNotOK colorizes the `message`.

HighlightOK

HighlightOK colorizes the `message`.

HighlightQuestion

HighlightQuestion colorizes the `message`.

HighlightSuccess

HighlightSuccess colorizes the `message`.

HighlightTrace

HighlightTrace colorizes the `message`.

HighlightWarning

HighlightWarning colorizes the `message`.

HumanReadableBytesIEC

HumanReadableBytesIEC colors the same way as Float() does but will make `bytes` human-readable using IEC-prefixes (base1024).

HumanReadableBytesSI

HumanReadableBytesSI colors the same way as Float() does but will make `bytes` human-readable using SI-prefixes (base1000).

HumanReadableIEC

HumanReadableIEC colors the same way as Float() does but will make `n` human-readable using IEC-prefixes (base1024).

HumanReadableLong

HumanReadableLong colors the same way as Float() does but will make `n` human-readable using long scale suffixes (base1000).

HumanReadableRateBytesIEC

HumanReadableRateBytesIEC colors the same way as Float() does but will make `bytes` human-readable using IEC-prefixes (base1024).

HumanReadableRateBytesSI

HumanReadableRateBytesSI colors the same way as Float() does but will make `bytes` human-readable using SI-prefixes (base1000).

HumanReadableRateIEC

HumanReadableRateIEC colors the same way as Float() does but will make `n` human-readable using IEC-prefixes (base1024).

HumanReadableRateSI

HumanReadableRateIEC colors the same way as Float() does but will make `n` human-readable using IEC-prefixes (base1024).

HumanReadableShort

HumanReadableShort colors the same way as Float() does but will make `n` human-readable using short scale suffixes (base1000).

HumanReadableSI

HumanReadableSI colors the same way as Float() does but will make `n` human-readable using SI-prefixes (base1000).

Int

Int colors the given ints.

IntAmount

IntAmount colors `n` as int and appends either the given singular (`n` == 1) or plural (`n` > 1 || `n` == 0).

IPs

No description provided by the author

IsFile

No description provided by the author

IsURL

No description provided by the author

IsValidPath

No description provided by the author

Italic

No description provided by the author

MapColor

MapColor translates `index` from glog's color table to the corresponding ANSI color index.

Max

No description provided by the author

Min

No description provided by the author

NewDefaultConfig

No description provided by the author

NewGError

No description provided by the author

NewGErrorRegistry

No description provided by the author

NewIndicator

No description provided by the author

NewLogger

NewLogger creates a new Logger instance with the given ID and settings.

NewLoggerSimple

NewLoggerSimple creates a new Logger instance with the given ID, automatically chosen color, and without debug mode or message handler.

NewStackTracer

No description provided by the author

NewTable

No description provided by the author

NewTableColumn

Related config setting(s): - `LoggerConfig.TablePadChar`.

NewTableColumnCenter

No description provided by the author

NewTableColumnCenterCustom

No description provided by the author

NewTableColumnCustom

No description provided by the author

NewTableColumnLeft

No description provided by the author

NewTableColumnLeftCustom

No description provided by the author

NewTableColumnRight

No description provided by the author

NewTableColumnRightCustom

No description provided by the author

NewTraceLine

No description provided by the author

PadCenter

No description provided by the author

PadLeft

No description provided by the author

PadRight

No description provided by the author

Password

Password colors `password` according to the config.

Percentage

Percentage assumes `n` to be normalized (0..1), multiplies it with 100, formats it with the given `precision` and colors the result.

PlaintextString

No description provided by the author

PlaintextStringLength

No description provided by the author

Port

No description provided by the author

ProgressBar

No description provided by the author

RandomSleep

No description provided by the author

Reason

Reason colors `reason` according to the config.

RemoveNonPrintable

No description provided by the author

ReplaceEmojis

No description provided by the author

ReplaceRunes

No description provided by the author

Reset

No description provided by the author

RestoreCursor

No description provided by the author

ReverseDNS

No description provided by the author

Runtime

Runtime determines the number of seconds passed since program start.

RuntimeMilliseconds

RuntimeMilliseconds determines the number of milliseconds passed since program start.

SplitHostPort

SplitHostPort takes a "IP:Port" formatted string and returns the port as integer and the ip portion as string.

StoreCursor

No description provided by the author

StrikeThrough

No description provided by the author

StripANSI

No description provided by the author

Time

Time parses the time portion of `t`, formats it (15:04:05).

Time12hr

Time12hr parses the time portion of `t`, formats it as AM/PM (03:04:05pm).

TimeCustom

TimeCustom formats `t` according to the given format.

Timestamp

Timestamp uses the current time, formats it as Unix timestamp (seconds).

Uint

Uint colors the given uints.

Underline

No description provided by the author

URL

URL colorizes a URL and, if enabled, marks dead ones (based on a DNS check).

Wrap

No description provided by the author

WrapBlue

No description provided by the author

WrapBrightYellow

No description provided by the author

WrapCyan

No description provided by the author

WrapDarkBlue

No description provided by the author

WrapDarkGray

No description provided by the author

WrapDarkGreen

No description provided by the author

WrapDarkOrange

No description provided by the author

WrapDarkRed

No description provided by the author

WrapDarkYellow

No description provided by the author

WrapGray

No description provided by the author

WrapGreen

No description provided by the author

WrapLightBlue

No description provided by the author

WrapLime

No description provided by the author

WrapMediumGray

No description provided by the author

WrapOliveGreen

No description provided by the author

WrapOrange

No description provided by the author

WrapPink

No description provided by the author

WrapPurple

No description provided by the author

WrapRed

No description provided by the author

WrapWhite

No description provided by the author

WrapYellow

No description provided by the author

# Constants

Blue

No description provided by the author

BrightYellow

No description provided by the author

Cyan

No description provided by the author

DarkBlue

No description provided by the author

DarkGray

No description provided by the author

DarkGreen

No description provided by the author

DarkOrange

No description provided by the author

DarkRed

No description provided by the author

DarkYellow

No description provided by the author

DAY

No description provided by the author

DURATION_SCALE_AVERAGE

No description provided by the author

DURATION_SCALE_COMMON

No description provided by the author

DURATION_SCALE_LEAP

No description provided by the author

FILE_PATH

No description provided by the author

Gray

No description provided by the author

Green

No description provided by the author

HOUR

No description provided by the author

INVALID_PATH

No description provided by the author

LightBlue

No description provided by the author

Lime

No description provided by the author

MediumGray

No description provided by the author

MINUTE

No description provided by the author

MONTH_AVERAGE

No description provided by the author

MONTH_COMMON

No description provided by the author

MONTH_LEAP

No description provided by the author

OliveGreen

No description provided by the author

Orange

No description provided by the author

PAD_CENTER

No description provided by the author

PAD_LEFT

No description provided by the author

PAD_RIGHT

No description provided by the author

Pink

No description provided by the author

Purple

No description provided by the author

Red

No description provided by the author

SECOND

No description provided by the author

STACK_TRACER_BASE_DEPTH

this controls how many frames to skip, so we can avoid to expose ourselves in every stack trace.

URL_PATH

No description provided by the author

WEEK

No description provided by the author

White

No description provided by the author

YEAR_AVERAGE

No description provided by the author

YEAR_COMMON

No description provided by the author

YEAR_LEAP

No description provided by the author

Yellow

No description provided by the author

# Variables

LoggerConfig

No description provided by the author

# Structs

Config

No description provided by the author

GError

No description provided by the author

GErrorRegistry

No description provided by the author

GErrorTrace

No description provided by the author

Indicator

No description provided by the author

Logger

No description provided by the author

StackTraceFrame

No description provided by the author

StackTracer

No description provided by the author

StringColorCache

No description provided by the author

Table

No description provided by the author

TableColumn

No description provided by the author

TraceLine

No description provided by the author

# Interfaces

Durations

No description provided by the author

FloatOrInterface

No description provided by the author

Floats

No description provided by the author

IntOrInterface

No description provided by the author

IntOrUint

No description provided by the author

Ints

No description provided by the author

Number

No description provided by the author

NumberOrInterface

No description provided by the author

UintOrInterface

No description provided by the author

Uints

No description provided by the author

# Type aliases

DurationScale

No description provided by the author

PathType

No description provided by the author