/
index.js
139 lines (125 loc) · 4.43 KB
/
index.js
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
137
138
139
const ColorCodeDictionary = {
Reset: '\x1b[0m',
Bright: '\x1b[1m',
Dim: '\x1b[2m',
Underscore: '\x1b[4m',
Blink: '\x1b[5m',
Reverse: '\x1b[7m',
Hidden: '\x1b[8m',
FgBlack: '\x1b[30m',
FgRed: '\x1b[31m',
FgGreen: '\x1b[32m',
FgYellow: '\x1b[33m',
FgBlue: '\x1b[34m',
FgMagenta: '\x1b[35m',
FgCyan: '\x1b[36m',
FgWhite: '\x1b[37m',
BgBlack: '\x1b[40m',
BgRed: '\x1b[41m',
BgGreen: '\x1b[42m',
BgYellow: '\x1b[43m',
BgBlue: '\x1b[44m',
BgMagenta: '\x1b[45m',
BgCyan: '\x1b[46m',
BgWhite: '\x1b[47m'
};
/**
* @typedef {
* color?: "black" | "green" | "yellow" | "magenta" | "blue" | "cyan" | "white",
* colour? "black" | "green" | "yellow" | "magenta" | "blue" | "cyan" | "white",
* bgColor?: "black" | "green" | "yellow" | "magenta" | "blue" | "cyan" | "white",
* bgColour?: "black" | "green" | "yellow" | "magenta" | "blue" | "cyan" | "white",
* dimness?: "dim" | "bright",
* hidden?: boolean,
* blink?: boolean,
* reverse?: boolean
* } settingsObj
*/
/**
* Changes the text's appearance to match the settings
* @param {string} text
* @param {settingsObj} settings
*/
function setText(text, settings) {
const textTransformList = [];
/**
* Pushes the text transform to textTransformList
* @param {keyof thc} key
*/
function inThcPush(key) {
if (ColorCodeDictionary[key]) {
textTransformList.push(ColorCodeDictionary[key]);
}
}
if (settings.color) {
const key = `Fg${settings.color[0].toUpperCase()}${settings.color.slice(1, settings.color.length)}`;
inThcPush(key);
}
if (settings.colour) {
const key = `Fg${settings.colour[0].toUpperCase()}${settings.colour.slice(1, settings.colour.length)}`;
inThcPush(key);
}
if (settings.bgColor) {
const key = `Bg${settings.bgColor[0].toUpperCase()}${settings.bgColor.slice(1, settings.bgColor.length)}`;
inThcPush(key);
}
if (settings.bgColour) {
const key = `Bg${settings.bgColour[0].toUpperCase()}${settings.bgColour.slice(1, settings.bgColour.length)}`;
inThcPush(key);
}
if (settings.dimness) {
const key = settings.dimness === "dim" ? "Dim" : "Bright";
inThcPush(key);
}
if (settings.hidden) {
inThcPush("Hidden");
}
if (settings.reverse) {
inThcPush("Reverse");
}
if (settings.blink) {
inThcPush("Blink");
}
return `${textTransformList.join("")}${text}${ColorCodeDictionary.Reset}`;
}
const logTags = {
success: `${setText("✔", { colour: "green" })} ${setText(" SUCCESS ", { bgColour: "green", colour: "black" })}`,
fail: `${setText("✘", { colour: "red" })} ${setText(" FAIL ", { bgColour: "red", colour: "white" })}`,
building: `${setText("⚒", { color: "yellow" })} ${setText(" BUILDING ", { bgColour: "yellow", colour: "white" })}`,
compiling: `${setText("⚒", { color: "yellow" })} ${setText(" COMPILING ", { bgColour: "yellow", colour: "white" })}`,
executing: `${setText("⚡", { color: "yellow" })} ${setText(" EXECUTING ", { bgColour: "yellow", colour: "white" })}`,
building_executing: `${setText("⚡", { color: "yellow" })} ${setText(" BUILDING & EXECUTING ", { bgColor: "yellow", color: "white" })}`,
testing: `${setText("🧪", { colour: "blue" })} ${setText(" TESTING ", { bgColour: "blue", colour: "white" })}`
}
/**
* Returns the string representing the logtag
* @param {string} symbol
* @param {string} text
* @param {"black" | "green" | "yellow" | "magenta" | "blue" | "cyan" | "white"} accentColour
*/
function createLogTag(symbol, text, accentColour, textColour = null) {
let tag = `${setText(symbol, { colour: accentColour })} ${setText(" " + text + " ", { bgColour: accentColour })}`;
if (textColour) {
tag = `${setText(symbol, { colour: accentColour })} ${setText(" " + text + " ", { bgColour: accentColour, colour: textColour })}`
};
return tag;
}
/**
*
* @param {any} value
* @param {string | null} logtag
*/
function log(value, logtag) {
console.log(`${logtag ? logtag + " " : ""}${value}`)
}
/**
* Scrolls away in the console by spamming new lines
* @param {number} scrollAmount
*/
function emptyConsole(scrollAmount) {
let scroll = scrollAmount ? scrollAmount : 120;
for (let i = 0; i < scroll; i++) {
console.log("\n");
}
}
module.exports = { setText, logTags, createLogTag, log, emptyConsole };