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
|
/* eslint-disable @typescript-eslint/no-explicit-any */
/* eslint-disable @typescript-eslint/explicit-module-boundary-types */
import chalk from 'chalk';
import { MessageEmbed } from 'discord.js';
import { inspect } from 'util';
import { BushClient, BushSendMessageType } from '../extensions/discord-akairo/BushClient';
export class BushLogger {
private client: BushClient;
public constructor(client: BushClient) {
this.client = client;
}
private parseFormatting(
content: any,
color: 'blueBright' | 'blackBright' | 'redBright' | 'yellowBright' | 'greenBright' | '',
discordFormat = false
): string | typeof content {
if (typeof content !== 'string') return content;
const newContent: Array<string> = content.split(/<<|>>/);
const tempParsedArray: Array<string> = [];
newContent.forEach((value, index) => {
if (index % 2 !== 0) {
tempParsedArray.push(discordFormat ? `**${value}**` : chalk[color](value));
} else {
tempParsedArray.push(value);
}
});
return tempParsedArray.join('');
}
private inspectContent(content: any, depth = 2, colors = true): string {
if (typeof content !== 'string') {
return inspect(content, { depth, colors });
}
return content;
}
private stripColor(text: string): string {
return text.replace(
// eslint-disable-next-line no-control-regex
/[\u001b\u009b][[()#;?]*(?:[0-9]{1,4}(?:;[0-9]{0,4})*)?[0-9A-ORZcf-nqry=><]/g,
''
);
}
private getTimeStamp(): string {
const now = new Date();
const hours = now.getHours();
const minute = now.getMinutes();
let hour = hours;
let amOrPm: 'AM' | 'PM' = 'AM';
if (hour > 12) {
amOrPm = 'PM';
hour = hour - 12;
}
return `${hour >= 10 ? hour : `0${hour}`}:${minute >= 10 ? minute : `0${minute}`} ${amOrPm}`;
}
/**
* Logs information. Highlight information by surrounding it in `<<>>`.
* @param header - The header displayed before the content, displayed in cyan.
* @param content - The content to log, highlights displayed in bright blue.
* @param sendChannel - Should this also be logged to discord? Defaults to false.
* @param depth - The depth the content will inspected. Defaults to 0.
*/
public get log() {
return this.info;
}
/** Sends a message to the log channel */
public async channelLog(message: BushSendMessageType): Promise<void> {
const channel = await util.getConfigChannel('log');
await channel.send(message).catch(() => {});
}
/** Sends a message to the error channel */
public async channelError(message: BushSendMessageType): Promise<void> {
const channel = await util.getConfigChannel('error');
await channel.send(message).catch(() => {});
}
/**
* Logs debug information. Only works in dev is enabled in the config.
* @param content - The content to log.
* @param depth - The depth the content will inspected. Defaults to 0.
*/
public debug(content: any, depth = 0): void {
if (!client.config.isDevelopment) return;
const newContent = this.inspectContent(content, depth, true);
console.log(`${chalk.bgMagenta(this.getTimeStamp())} ${chalk.magenta('[Debug]')}`, newContent);
}
/**
* Logs raw debug information. Only works in dev is enabled in the config.
* @param content - The content to log.
*/
public debugRaw(...content: any): void {
if (!client.config.isDevelopment) return;
console.log(`${chalk.bgMagenta(this.getTimeStamp())} ${chalk.magenta('[Debug]')}`, ...content);
}
/**
* Logs verbose information. Highlight information by surrounding it in `<<>>`.
* @param header - The header printed before the content, displayed in grey.
* @param content - The content to log, highlights displayed in bright black.
* @param sendChannel - Should this also be logged to discord? Defaults to false.
* @param depth - The depth the content will inspected. Defaults to 0.
*/
public async verbose(header: string, content: any, sendChannel = false, depth = 0): Promise<void> {
if (!client.config.logging.verbose) return;
const newContent = this.inspectContent(content, depth, true);
console.info(
`${chalk.bgGrey(this.getTimeStamp())} ${chalk.grey(`[${header}]`)} ` + this.parseFormatting(newContent, 'blackBright')
);
if (!sendChannel) return;
const embed = new MessageEmbed()
.setDescription(`**[${header}]** ${this.parseFormatting(this.stripColor(newContent), '', true)}`)
.setColor(util.colors.gray)
.setTimestamp();
await this.channelLog({ embeds: [embed] });
}
/**
* Logs information. Highlight information by surrounding it in `<<>>`.
* @param header - The header displayed before the content, displayed in cyan.
* @param content - The content to log, highlights displayed in bright blue.
* @param sendChannel - Should this also be logged to discord? Defaults to false.
* @param depth - The depth the content will inspected. Defaults to 0.
*/
public async info(header: string, content: any, sendChannel = true, depth = 0): Promise<void> {
if (!client.config.logging.info) return;
const newContent = this.inspectContent(content, depth, true);
console.info(
`${chalk.bgCyan(this.getTimeStamp())} ${chalk.cyan(`[${header}]`)} ` + this.parseFormatting(newContent, 'blueBright')
);
if (!sendChannel) return;
const embed = new MessageEmbed()
.setDescription(`**[${header}]** ${this.parseFormatting(this.stripColor(newContent), '', true)}`)
.setColor(util.colors.info)
.setTimestamp();
await this.channelLog({ embeds: [embed] });
}
/**
* Logs warnings. Highlight information by surrounding it in `<<>>`.
* @param header - The header displayed before the content, displayed in yellow.
* @param content - The content to log, highlights displayed in bright yellow.
* @param sendChannel - Should this also be logged to discord? Defaults to false.
* @param depth - The depth the content will inspected. Defaults to 0.
*/
public async warn(header: string, content: any, sendChannel = true, depth = 0): Promise<void> {
const newContent = this.inspectContent(content, depth, true);
console.warn(
`${chalk.bgYellow(this.getTimeStamp())} ${chalk.yellow(`[${header}]`)} ` +
this.parseFormatting(newContent, 'yellowBright')
);
if (!sendChannel) return;
const embed = new MessageEmbed()
.setDescription(`**[${header}]** ${this.parseFormatting(this.stripColor(newContent), '', true)}`)
.setColor(util.colors.warn)
.setTimestamp();
await this.channelLog({ embeds: [embed] });
}
/**
* Logs errors. Highlight information by surrounding it in `<<>>`.
* @param header - The header displayed before the content, displayed in bright red.
* @param content - The content to log, highlights displayed in bright red.
* @param sendChannel - Should this also be logged to discord? Defaults to false.
* @param depth - The depth the content will inspected. Defaults to 0.
*/
public async error(header: string, content: any, sendChannel = true, depth = 0): Promise<void> {
const newContent = this.inspectContent(content, depth, true);
console.error(
`${chalk.bgRedBright(this.getTimeStamp())} ${chalk.redBright(`[${header}]`)} ` +
this.parseFormatting(newContent, 'redBright')
);
if (!sendChannel) return;
const embed = new MessageEmbed()
.setDescription(`**[${header}]** ${this.parseFormatting(this.stripColor(newContent), '', true)}`)
.setColor(util.colors.error)
.setTimestamp();
await this.channelError({ embeds: [embed] });
}
/**
* Logs successes. Highlight information by surrounding it in `<<>>`.
* @param header - The header displayed before the content, displayed in green.
* @param content - The content to log, highlights displayed in bright green.
* @param sendChannel - Should this also be logged to discord? Defaults to false.
* @param depth - The depth the content will inspected. Defaults to 0.
*/
public async success(header: string, content: any, sendChannel = true, depth = 0): Promise<void> {
const newContent = this.inspectContent(content, depth, true);
console.log(
`${chalk.bgGreen(this.getTimeStamp())} ${chalk.greenBright(`[${header}]`)} ` +
this.parseFormatting(newContent, 'greenBright')
);
if (!sendChannel) return;
const embed = new MessageEmbed()
.setDescription(`**[${header}]** ${this.parseFormatting(this.stripColor(newContent), '', true)}`)
.setColor(util.colors.success)
.setTimestamp();
await this.channelLog({ embeds: [embed] }).catch(() => {});
}
}
|
