Skip to content

uynilo9/logger.go

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🌴 - A simple logger for Go

✨ Intro

A simple logger written in Go, which is used to print errors, tips, etc. messages, was born while I was working on another project github.com/uynilo9/bento.

Btw it used to be in pkg/logger under github.com/uynilo9/bento originally. So far it still exists there but will no longer get updates there (if it's supposed to get any here lol).

πŸ“¦ Installation

  1. Install the module from GitHub url:
go get github.com/uynilo9/logger.go
  1. Import the module in your Go code:
import "github.com/uynilo9/logger.go"

βš™οΈ Functionality

1. logger.Detail(a ...any)

(a) Argument(s):
  • a (...any): The detailed message(s) to be printed. You can pass any number of arguments of any type.
(b) Return:
  • n (int): The number of bytes written.
  • err (error): Any write error encountered.
(c) Example:
logger.Detail("- Time: ", time, " - Code: " code)

_, err := logger.Detail("- Time: ", time, " - Code: " code)
if err != nil {
    // ...

2. logger.Error(a ...any)

(a) Argument(s):
  • a (...any): The error message(s) to be printed. You can pass any number of arguments of any type.
(b) Return:
  • n (int): The number of bytes written.
  • err (error): Any write error encountered.
(c) Example:
logger.Error("Unexpected character on line ", line, " column ", column)

_, err := logger.Error("Unexpected character on line ", line, " column ", column)
if err != nil {
    // ...

3. logger.Fatal(a ...any)

(a) Argument(s):
  • a (...any): The fatal message(s) to be printed. You can pass any number of arguments of any type.
(b) Return:

Warning

This function returns NOTHING because it directly EXITS after printing the message(s).

(c) Example:
logger.Fatal("The required data \'", data, "\' was missing")

4. logger.Tip(a ...any)

(a) Argument(s):
  • a (...any): The tip message(s) to be printed. You can pass any number of arguments of any type.
(b) Return:
  • n (int): The number of bytes written.
  • err (error): Any write error encountered.
(c) Example:
logger.Tip("To get more info, visit ", url, "#", id)

_, err := logger.Tip("To get more info, visit ", url, "#", id)
if err != nil {
    // ...

5. logger.Warn(a ...any)

(a) Argument(s):
  • a (...any): The warning message(s) to be printed. You can pass any number of arguments of any type.
(b) Return:
  • n (int): The number of bytes written.
  • err (error): Any write error encountered.
(c) Example:
logger.Warn("New version ", version, " has been released, please update")

_, err := logger.Warn("New version ", version, " has been released, please update")
if err != nil {
    // ...

6. logger.Detailln(a ...any)

(a) Argument(s):
  • a (...any): The detailed message(s) to be printed. You can pass any number of arguments of any type. A newline is always appended.
(b) Return:
  • n (int): The number of bytes written.
  • err (error): Any write error encountered.
(c) Example:
logger.Detailln("- Time: ", time, " - Code: " code)

_, err := logger.Detailln("- Time: ", time, " - Code: " code)
if err != nil {
    // ...

7. logger.Errorln(a ...any)

(a) Argument(s):
  • a (...any): The error message(s) to be printed. You can pass any number of arguments of any type. A newline is always appended.
(b) Return:
  • n (int): The number of bytes written.
  • err (error): Any write error encountered.
(c) Example:
logger.Error("Unexpected character on line ", line, " column ", column)

_, err := logger.Errorln("Unexpected character on line ", line, " column ", column)
if err != nil {
    // ...

8. logger.Fatalln(a ...any)

(a) Argument(s):
  • a (...any): The fatal message(s) to be printed. You can pass any number of arguments of any type. A newline is always appended.
(b) Return:

Warning

This function returns NOTHING because it directly EXITS after printing the message(s).

(c) Example:
logger.Fatalln("The required data \'", data, "\' was missing")

9. logger.Tipln(a ...any)

(a) Argument(s):
  • a (...any): The tip message(s) to be printed. You can pass any number of arguments of any type. A newline is always appended.
(b) Return:
  • n (int): The number of bytes written.
  • err (error): Any write error encountered.
(c) Example:
logger.Tipln("To get more info, visit ", url, "#", id)

_, err := logger.Tipln("To get more info, visit ", url, "#", id)
if err != nil {
    // ...

10. logger.Warnln(a ...any)

(a) Argument(s):
  • a (...any): The warning message(s) to be printed. You can pass any number of arguments of any type.
(b) Return:
  • n (int): The number of bytes written.
  • err (error): Any write error encountered.
(c) Example:
logger.Warnln("New version ", version, " has been released, please update")

_, err := logger.Warnln("New version ", version, " has been released, please update")
if err != nil {
    // ...

11. logger.Detailf(format string, a ...any)

(a) Argument(s):
  • format (string): The format string for the detailed message. It follows the same syntax as fmt.Printf, allowing for formatted printing.
  • a (...any): The values to be formatted and printed according to the format string.type.
(b) Return:
  • n (int): The number of bytes written.
  • err (error): Any write error encountered.
(c) Example:
logger.Detailf("- Time: %g - Code: %d", time, code)

_, err := logger.Detailf("- Time: %g - Code: %d", time, code)
if err != nil {
    // ...

12. logger.Errorf(format string, a ...any)

(a) Argument(s):
  • format (string): The format string for the error message. It follows the same syntax as fmt.Printf, allowing for formatted printing.
  • a (...any): The values to be formatted and printed according to the format string.
(b) Return:
  • n (int): The number of bytes written.
  • err (error): Any write error encountered.
(c) Example:
logger.Errorf("Unexpected character on line %d column %d", line, column)

_, err := logger.Errorf("Unexpected character on line %d column %d", line, column)
if err != nil {
    // ...

13. logger.Fatalf(format string, a ...any)

(a) Argument(s):
  • format (string): The format string for the fatal message. It follows the same syntax as fmt.Printf, allowing for formatted printing.
  • a (...any): The values to be formatted and printed according to the format string.
(b) Return:

Warning

This function returns NOTHING because it directly EXITS after printing the message(s).

(c) Example:
logger.Fatalf("The required data \'%s\' was missing", data)

14. logger.Tipf(format string, a ...any)

(a) Argument(s):
  • format (string): The format string for the tip message. It follows the same syntax as fmt.Printf, allowing for formatted printing.
  • a (...any): The values to be formatted and printed according to the format string.
(b) Return:
  • n (int): The number of bytes written.
  • err (error): Any write error encountered.
(c) Example:
logger.Tipf("To get more info, visit %s#%d", url, id)

_, err := logger.Tipf("To get more info, visit %s#%d", url, id)
if err != nil {
    // ...

15. logger.Warnf(format string, a ...any)

(a) Argument(s):
  • format (string): The format string for the warning message. It follows the same syntax as fmt.Printf, allowing for formatted printing.
  • a (...any): The values to be formatted and printed according to the format string.
(b) Return:
  • n (int): The number of bytes written.
  • err (error): Any write error encountered.
(c) Example:
logger.Warnf("New version %s has been released, please update", version)

_, err := logger.Warnf("New version %s has been released, please update", version)
if err != nil {
    // ...

πŸ”– Version

0.0.1-dev.6

πŸ“œ License

MIT License

About

🌴 - A simple logger for Go

Resources

License

Stars

Watchers

Forks

Languages