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/gleich/statuser/v2

📚 Documentation

Here is some basic usage:

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

ErrorMsg()

Output an error to the user with just a message

Parameters

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

Example

Outputs the following in red text:

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

message
exit status 1

Warning()

Output a warning 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()

Output a warning the user

Parameters

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

Example

Outputs the following text in green:

✅ message

Contributors

1. Matthew Gleich (@gleich)

👥 Contributors

• @gleich

• @dependabot-preview[bot]

Documentation

Index

• Variables
• func Error(message string, err error, exitCode int)
• func ErrorMsg(message string, exitCode int)
• func Success(msgItems ...interface{})
• func Warning(msgItems ...interface{})

Variables

var (
	// If the output should use emojis
	Emojis = true

	// Error emoji
	ErrorEmoji = emoji.PoliceCarLight
	// Error text
	ErrorText = " ERROR "
	// Error box character
	ErrorBoxChar = "░"
	// Error character if emojis are turned off
	ErrorChar = "✗"

	// Warning emoji
	WarningEmoji = emoji.Warning
	// Warning text
	WarningText = " WARNING "
	// Warning character if emojis are turned off
	WarningChar = "◈"

	// Success emoji
	SuccessEmoji = emoji.CheckMarkButton
	// Warning text
	SuccessText = " "
	// Warning character if emojis are turned off
	SuccessChar = "✔"
)

Functions

func Error

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

Output an error to the user

func ErrorMsg

func ErrorMsg(message string, exitCode int)

Output an error to the user

func Success

func Success(msgItems ...interface{})

Output a success to the user

func Warning

func Warning(msgItems ...interface{})

Output a warning to the user