ShellUtils/utils/utils_stdout_with_colors.sh at main · kevingrillet/ShellUtils · GitHub

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
#!/bin/bash
# ##############################################################################
# Script Name   : utils_stdout_with_colors.sh
# Description   : Common print functions for shell projects
# Author        : Kevin GRILLET
# GitHub        : https://github.com/kevingrillet/ShellUtils
# License       : GNU GPL-3
# Require       : utils_stdout_colors.sh
# ##############################################################################
[ -n "${UTILS_STDOUT_WITH_COLORS}" ] && return; UTILS_STDOUT_WITH_COLORS=0; #pragma once

# ##############################################################################
# Function Name : printDebug
# Description   : Print debug message
# Args          : <MESSAGE>
# Output        : stdout [DEBUG] <MESSAGE>
# ##############################################################################
printDebug() {
    if [ "$#" -ne 1 ] ; then echo "Usage: printDebug <MESSAGE>" >&2; return 1; fi
    echo -e "${On_Blue}[DEBUG]\t\t$1${Color_Off}" >&1
}

# ##############################################################################
# Function Name : printError
# Description   : Print error message
# Args          : <MESSAGE>
# Output        : stderr [ERROR] <MESSAGE>
# ##############################################################################
printError() {
    if [ "$#" -ne 1 ] ; then echo "Usage: printError <MESSAGE>" >&2; return 1; fi
    echo -e "${Red}[ERROR]${Color_Off}\t\t$1" >&2
}

# ##############################################################################
# Function Name : printInfo
# Description   : Print info message
# Args          : <MESSAGE>
# Output        : stdout [INFORMATION] <MESSAGE>
# ##############################################################################
printInfo() {
    if [ "$#" -ne 1 ] ; then echo "Usage: printInfo <MESSAGE>" >&2; return 1; fi
    echo -e "${Cyan}[INFORMATION]${Color_Off}\t$1" >&1
}

# ##############################################################################
# Function Name : printSuccess
# Description   : Print success message
# Args          : <MESSAGE>
# Output        : stdout [SUCCESS] <MESSAGE>
# ##############################################################################
printSuccess() {
    if [ "$#" -ne 1 ] ; then echo "Usage: printSuccess <MESSAGE>" >&2; return 1; fi
    echo -e "${Green}[SUCCESS]${Color_Off}\t$1" >&1
}

# ##############################################################################
# Function Name : printTask
# Description   : Print task message
# Args          : <MESSAGE>
# Output        : stdout [TASK] <MESSAGE>
# ##############################################################################
printTask() {
    if [ "$#" -ne 1 ] ; then echo "Usage: printTask <MESSAGE>" >&2; return 1; fi
    echo -e "${Blue}[TASK]${Color_Off}\t\t$1" >&1
}

# ##############################################################################
# Function Name : printTip
# Description   : Print tip message
# Args          : <MESSAGE>
# Output        : stdout [TIP] <MESSAGE>
# ##############################################################################
printTip() {
    if [ "$#" -ne 1 ] ; then echo "Usage: printTip <MESSAGE>" >&2; return 1; fi
    echo -e "${Purple}[TIP]${Color_Off}\t\t$1" >&1
}

# ##############################################################################
# Function Name : printWarn
# Description   : Print warning message
# Args          : <MESSAGE>
# Output        : stderr [WARN] <MESSAGE>
# ##############################################################################
printWarn() {
    if [ "$#" -ne 1 ] ; then echo "Usage: printWarn <MESSAGE>" >&2; return 1; fi
    echo -e "${Yellow}[WARNING]${Color_Off}\t$1" >&2
}