PL - Simple Pretty Logger

PL is a simple, easy to use pretty logger made in go.

• Installation
• Usage
• All Logging Functions

Installation

Use go get to install with the latest tag v0.1.2 (recommended)

go get -u github.com/fluffysnowman/prettylogger@v0.1.2

or

Go's module suppert automatically fetches all the dependencies needed when you import it in your code so go get isn't required, however for this project, the go get installation is recommended with a specified tag (see the code block above for instructions).

// Importing and setting an alias to `pl` 
import pl "github.com/fluffysnowman/prettylogger"

Usage

Initialise the pretty logger with a config (can be SIMPLE, SIMPLE2 or TIMEBASED) which is automatically used everywhere once set.

Basic example:

package main

import (
  pl "github.com/fluffysnowman/prettylogger"
)

func main() {
  pl.InitPrettyLogger("SIMPLE")       // basic 
  pl.LogInfo("Hello World")
}

Using timestamps:

package main

import (
  pl "github.com/fluffysnowman/prettylogger"
)

func main() {
  pl.InitPrettyLogger("TIMEBASED")    // shows timestamps
  pl.Log("Hello World")
}

Using the new SIMPLE2 format:

package main

import (
  pl "github.com/fluffysnowman/prettylogger"
)

func main() {
  pl.InitPrettyLogger("SIMPLE2")    // detailed and concise format (new)
  pl.Log("Hello World")
}

Important

Note that SIMPLE, SIMPLE2 and TIMEBASED cannot be used together. Changing or setting the InitPrettyLogger() multiple times may cause problems.

Multiple arguments:

pl.LogDebug("this is a debug log %v", "foo bar")

All Logging Functions

Below is a list of all the available functions.

pl.InitPrettyLogger(opts)  // Accepts "SIMPLE", "SIMPLE2" or "TIMEBASED"

pl.Log()          // green
pl.LogDebug()     // cyan 
pl.LogError()     // red
pl.LogInfo()      // cyan
pl.LogWarn()      // yellow
pl.LogFatal()     // red
pl.LogSuccess()   // green
pl.LogFailure()   // yellow
pl.LogOK()        // green
pl.LogErrorBG()   // red background, white text
pl.LogFailureBG() // yellow background, white text