-
Notifications
You must be signed in to change notification settings - Fork 692
/
loggers.ts
278 lines (247 loc) · 6.71 KB
/
loggers.ts
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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
import * as ts from "typescript";
import { url } from "inspector";
import { resolve } from "path";
const isDebugging = () => !!url();
/**
* List of known log levels. Used to specify the urgency of a log message.
*/
export enum LogLevel {
Verbose,
Info,
Warn,
Error,
}
const Colors = {
red: "\u001b[91m",
yellow: "\u001b[93m",
cyan: "\u001b[96m",
gray: "\u001b[90m",
reset: "\u001b[0m",
};
const messagePrefixes = {
[LogLevel.Error]: "Error: ",
[LogLevel.Warn]: "Warning: ",
[LogLevel.Info]: "Info: ",
[LogLevel.Verbose]: "Debug: ",
};
const coloredMessagePrefixes = {
[LogLevel.Error]: `${Colors.red}${messagePrefixes[LogLevel.Error]}${
Colors.reset
}`,
[LogLevel.Warn]: `${Colors.yellow}${messagePrefixes[LogLevel.Warn]}${
Colors.reset
}`,
[LogLevel.Info]: `${Colors.cyan}${messagePrefixes[LogLevel.Info]}${
Colors.reset
}`,
[LogLevel.Verbose]: `${Colors.gray}${messagePrefixes[LogLevel.Verbose]}${
Colors.reset
}`,
};
/**
* A logger that will not produce any output.
*
* This logger also serves as the base class of other loggers as it implements
* all the required utility functions.
*/
export class Logger {
/**
* How many error messages have been logged?
*/
errorCount = 0;
/**
* How many warning messages have been logged?
*/
warningCount = 0;
private seenErrors = new Set<string>();
private seenWarnings = new Set<string>();
/**
* The minimum logging level to print.
*/
level = LogLevel.Info;
/**
* Has an error been raised through the log method?
*/
hasErrors(): boolean {
return this.errorCount > 0;
}
/**
* Has a warning been raised through the log method?
*/
hasWarnings(): boolean {
return this.warningCount > 0;
}
/**
* Reset the error counter.
*/
resetErrors() {
this.errorCount = 0;
this.seenErrors.clear();
}
/**
* Reset the warning counter.
*/
resetWarnings() {
this.warningCount = 0;
this.seenWarnings.clear();
}
/**
* Log the given verbose message.
*
* @param text The message that should be logged.
* @param args The arguments that should be printed into the given message.
*/
verbose(text: string) {
this.log(text, LogLevel.Verbose);
}
/** Log the given info message. */
info(text: string) {
this.log(text, LogLevel.Info);
}
/**
* Log the given warning.
*
* @param text The warning that should be logged.
* @param args The arguments that should be printed into the given warning.
*/
warn(text: string) {
if (this.seenWarnings.has(text)) return;
this.seenWarnings.add(text);
this.log(text, LogLevel.Warn);
}
/**
* Log the given error.
*
* @param text The error that should be logged.
* @param args The arguments that should be printed into the given error.
*/
error(text: string) {
if (this.seenErrors.has(text)) return;
this.seenErrors.add(text);
this.log(text, LogLevel.Error);
}
/** @internal */
deprecated(text: string, addStack = true) {
if (addStack) {
const stack = new Error().stack?.split("\n");
if (stack && stack.length >= 4) {
text = text + "\n" + stack[3];
}
}
this.warn(text);
}
/**
* Print a log message.
*
* @param _message The message itself.
* @param level The urgency of the log message.
*/
log(_message: string, level: LogLevel) {
if (level === LogLevel.Error) {
this.errorCount += 1;
}
if (level === LogLevel.Warn) {
this.warningCount += 1;
}
}
/**
* Print the given TypeScript log messages.
*
* @param diagnostics The TypeScript messages that should be logged.
*/
diagnostics(diagnostics: ReadonlyArray<ts.Diagnostic>) {
diagnostics.forEach((diagnostic) => {
this.diagnostic(diagnostic);
});
}
/**
* Print the given TypeScript log message.
*
* @param diagnostic The TypeScript message that should be logged.
*/
diagnostic(diagnostic: ts.Diagnostic) {
const output = ts.formatDiagnosticsWithColorAndContext([diagnostic], {
getCanonicalFileName: resolve,
getCurrentDirectory: () => process.cwd(),
getNewLine: () => ts.sys.newLine,
});
switch (diagnostic.category) {
case ts.DiagnosticCategory.Error:
this.log(output, LogLevel.Error);
break;
case ts.DiagnosticCategory.Warning:
this.log(output, LogLevel.Warn);
break;
case ts.DiagnosticCategory.Message:
this.log(output, LogLevel.Info);
}
}
}
/**
* A logger that outputs all messages to the console.
*/
export class ConsoleLogger extends Logger {
/**
* Specifies if the logger is using color codes in its output.
*/
private hasColoredOutput: boolean;
/**
* Create a new ConsoleLogger instance.
*/
constructor() {
super();
this.hasColoredOutput = !("NO_COLOR" in process.env);
}
/**
* Print a log message.
*
* @param message The message itself.
* @param level The urgency of the log message.
*/
override log(message: string, level: LogLevel) {
super.log(message, level);
if (level < this.level && !isDebugging()) {
return;
}
const method = (
{
[LogLevel.Error]: "error",
[LogLevel.Warn]: "warn",
[LogLevel.Info]: "info",
[LogLevel.Verbose]: "log",
} as const
)[level];
const prefix = this.hasColoredOutput
? coloredMessagePrefixes[level]
: messagePrefixes[level];
console[method](prefix + message);
}
}
/**
* A logger that calls a callback function.
*/
export class CallbackLogger extends Logger {
/**
* This loggers callback function
*/
callback: Function;
/**
* Create a new CallbackLogger instance.
*
* @param callback The callback that should be used to log messages.
*/
constructor(callback: Function) {
super();
this.callback = callback;
}
/**
* Print a log message.
*
* @param message The message itself.
* @param level The urgency of the log message.
*/
override log(message: string, level: LogLevel) {
super.log(message, level);
this.callback(message, level);
}
}