-
Notifications
You must be signed in to change notification settings - Fork 0
/
verbose.go
136 lines (119 loc) · 4.59 KB
/
verbose.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
// Copyright 2022 by lolorenzo77. All rights reserved.
// Use of this source code is governed by MIT licence that can be found in the LICENSE file.
/*
verbose package generates formatted output only when verbose mode is turned on.
MessageType defines the header of the message and its color
- INFO: `>>info:` in cyan before the message
- TRACKER: `>>tracker:` in green before the messsage
- WARNING: `>>warning:` in orange before the messsage
- ALERT: `>>alert:` in red before the messsage
# Usage
verbose.Println(verbose.INFO, "everything is ok")
verbose.Printf(verbose.WARNING, "value should be greater than %v", value)
*/
package verbose
import (
"fmt"
"time"
)
// Set this flag to generate verbose output
var IsOn bool = false
var IsDebugging bool = false
// Type of verbose message, defines the header of the message and its color
// - INFO: `>>info:` in cyan before the message
// - TRACK: `>>track:` in red before the messsage
// - WARNING: `>>warn:` in orange before the messsage
// - ALERT: `>>alert:` in red before the messsage
type MessageType int
const (
INFO MessageType = 0 // will output ">>info:" in cyan before the messsage
WARNING MessageType = 1 // will output ">>warning:" in orange before the messsage
ALERT MessageType = 2 // will output ">>alert:" in red before the messsage
TRACK MessageType = 3 // will output ">>track: {timestamp}" in green before the messsage
DEBUG MessageType = 4 // will output ">>debug: in yellow before the messsage
)
var messageTypeStrings []string = []string{
"\x1b[0;36m>>info :\x1b[0m",
"\x1b[38;5;208m>>warning:\x1b[0m",
"\x1b[0;31m>>alert :\x1b[0m",
"\033[1;32m>>track :\033[0m",
"\x1b[0;33m>>debug :\x1b[0m",
}
// Println formats using the default formats for its operands and writes to standard output.
// Spaces are always added between operands and a newline is appended.
func Println(msgtype MessageType, params ...interface{}) {
if !IsOn && !(IsDebugging && msgtype == DEBUG) {
return
}
var xparams []interface{}
xparams = append(xparams, messageTypeStrings[msgtype])
if msgtype == TRACK {
xparams = append(xparams, time.Now().Format("20060102 15:04:05 "))
}
xparams = append(xparams, params...)
fmt.Println(xparams...)
}
// Print formats and calls Output to print to the standard stream.
// Arguments are handled in the manner of fmt.Print.
func Print(msgtype MessageType, params ...interface{}) {
if !IsOn && !(IsDebugging && msgtype == DEBUG) {
return
}
var xparams []interface{}
xparams = append(xparams, messageTypeStrings[msgtype])
if msgtype == TRACK {
xparams = append(xparams, time.Now().Format("20060102 15:04:05 "))
}
xparams = append(xparams, params...)
fmt.Print(xparams...)
}
// Printf formats and calls Output to print to the standard stream.
// Arguments are handled in the manner of fmt.Printf.
func Printf(msgtype MessageType, format string, params ...interface{}) {
if !IsOn && !(IsDebugging && msgtype == DEBUG) {
return
}
var strtrack string
if msgtype == TRACK {
strtrack = time.Now().Format("20060102 15:04:05 ")
}
fmt.Printf(fmt.Sprintf("%s %s%s", messageTypeStrings[msgtype], strtrack, format), params...)
}
// PrintfIf formats and calls Output to print to the standard stream.
// Print out only if verbose IsOn and ok is true.
// Arguments are handled in the manner of fmt.Printf.
func PrintfIf(ok bool, msgtype MessageType, format string, params ...interface{}) {
if !ok || (!IsOn && !(IsDebugging && msgtype == DEBUG)) {
return
}
Printf(msgtype, format, params...)
}
// Error formats and calls Output to print to the standard stream,
// like Println with the messageType ALERT and only if err is not nil.
func Error(context string, err error) error {
if IsOn && err != nil {
fmt.Printf("%s [%s] %s\n", messageTypeStrings[ALERT], context, err.Error())
}
return err
}
// Assert panics with a formated message if not ok, whatever IsOn and IsDebugging.
func Assert(ok bool, format string, params ...interface{}) {
if !ok {
str := fmt.Sprintf(messageTypeStrings[ALERT]+" "+format, params...)
panic(str)
}
}
// Track generate output a time tracker and a message if verbose IsOn, otherwise does nothing.
func Track(start time.Time, format string, params ...interface{}) {
if !IsOn {
return
}
fmt.Printf(fmt.Sprintf("%s %s \033[1;32m<< %s\033[0m\n", messageTypeStrings[TRACK], format, time.Since(start)), params...)
}
// Debug prints a formated string to the standard stream only if versbode IsDebugging is true, otherwise does nothing.
func Debug(format string, params ...interface{}) {
if !IsDebugging {
return
}
fmt.Printf(fmt.Sprintf("%s %s\n", messageTypeStrings[DEBUG], format), params...)
}