statuser

README

statuser

📣 A user friendly status outputting library for go

🚀 Installing

Simply run the command below in the root of your go project:

go get -u github.com/Matt-Gleich/statuser

📚 Documentation

Emojis

By default emojis are turned on. If you wish to disable them then just do emojis = false in your go code.

Error()

Output an error to the user

Parameters

1. message
   • Type: string
   • Description: A human readable message to help the user
2. err
   • Type: err
   • Description: The golang error
3. exitCode
   • Type: int
   • Description: Exit code used to exit the program

Example

Outputs the following in red text:

░░░░░░░░░░░░░
░🚨 ERROR 🚨░
░░░░░░░░░░░░░

message

GOLANG ERROR (SHOW DEVELOPER):
err
exit status 1

Warning()

Output a warning the the user

Parameters

1. message
   • Type: string
   • Description: The warning message to display to the user

Example

Outputs the following text in yellow:

⚠️ WARNING ⚠️
message

Success()

Parameters

1. message
   • Type: string
   • Description: The success message to display to the user

Example

Outputs the following text in green:

✅ SUCCESS ✅
message

Contributors

1. Matthew Gleich (@Matt-Gleich)

Documentation

Index

• Variables
• func Error(message string, err error, exitCode int)
• func Success(message string)
• func Warning(message string)

Variables

var Emojis = true

Emojis ... If the output should use emojis

Functions

func Error

func Error(message string, err error, exitCode int)

Error ... Output an error to the user

func Success

func Success(message string)

Success ... Output a success to the user

func Warning

func Warning(message string)

Warning ... Output a warning to the user