pprnt

README

pprnt

Pretty Print for Golang (Print anything with format basically)

Get Started

Version: 1.12.1

go get github.com/n3m/pprnt

Description

Designed to Pretty Print Stuff on your Terminal, pretty basic and synchronous.

Usage

• Example Code:

package main

import "github.com/n3m/pprnt"

func main(){
  example := map[string]interface{}{"hell": map[string]interface{}{"yeah":"brother"}}

  // Print(interface) :: The function Print() expects an interface to be passed as parameters
  // So you can pass any type of variable
  pprint.Print(example)
}

• Example Output

$ go run .

{
   "hell": {
      "yeah": "brother"
   }
}

Project Reason

TL;DR: I do not like the way that current printing packages handle Terminal Printing in Golang, so I decided to make my own.

Tired of printing structs or maps in go without any identation? Tired of using json.Marshal -> []bytes -> String to print with identation? Well, I was. I was tired of having to search for the key that I was looking for in the whole mess of the print. Imagine that you have a really big struct/map and you want to visually understand whats happening to the data; this can be a really time consuming task using something like fmt.Printf or log.Printf since those packages just print directly to the terminal; so in order to erradicate this awful printing style, I decided to create a package that could print in a "NodeJS"-style out of the box. That's the reason, believe it or not. I wasted 1 day of my life with this + some hours fixing bugs and testing it.

Disclaimer

This package is designed to be ran on development environments. Beware of turning on using Pretty Printing from this package while on Production Mode, since it can generate performance issues, due to the use of recursion. This package is released "as-is" and I'm not responsible for any liabilty that could result due to the use of this package.

Documentation

Index

• Constants
• Variables
• func GetStringAdddress(arg string) *string
• func Print(arg interface{}) string
• type PrintOptions

Constants

const (
	//ColorReset ...
	ColorReset string = "\033[0m"
	//ColorRed ...
	ColorRed string = "\033[31m" //Not supported or nil
	//ColorGreen ...
	ColorGreen string = "\033[32m" //String
	//ColorYellow ...
	ColorYellow string = "\033[33m" //Keys
	//ColorBlue ...
	ColorBlue string = "\033[34m" //Bool
	//ColorPurple ...
	ColorPurple string = "\033[35m" //Int floats
	//ColorCyan ...
	ColorCyan string = "\033[36m" //Brackets or Corch
	//ColorGray ...
	ColorGray string = "\033[37m"
	//ColorWhite ...
	ColorWhite string = "\033[97m"
)

Variables

var Deprecated *deprecatedHolder = &deprecatedHolder{}

Functions

func GetStringAdddress

func GetStringAdddress(arg string) *string

func Print

func Print(arg interface{}) string

Types

type PrintOptions

type PrintOptions struct {
	EndComma bool
}