aboutsummaryrefslogtreecommitdiff
path: root/lib/utils/BushLogger.ts
diff options
context:
space:
mode:
authorIRONM00N <64110067+IRONM00N@users.noreply.github.com>2022-08-18 22:42:12 -0400
committerIRONM00N <64110067+IRONM00N@users.noreply.github.com>2022-08-18 22:42:12 -0400
commit2356d2c44736fb83021dacb551625852111c8ce6 (patch)
tree10408d22fdd7a358d2f5c5917c3b59e55aa4c19d /lib/utils/BushLogger.ts
parent8aed6f93f7740c592cbc0e2f9fd3269c05286077 (diff)
downloadtanzanite-2356d2c44736fb83021dacb551625852111c8ce6.tar.gz
tanzanite-2356d2c44736fb83021dacb551625852111c8ce6.tar.bz2
tanzanite-2356d2c44736fb83021dacb551625852111c8ce6.zip
restructure, experimental presence and member automod, fixed bugs probably made some more bugs
Diffstat (limited to 'lib/utils/BushLogger.ts')
-rw-r--r--lib/utils/BushLogger.ts315
1 files changed, 315 insertions, 0 deletions
diff --git a/lib/utils/BushLogger.ts b/lib/utils/BushLogger.ts
new file mode 100644
index 0000000..4acda69
--- /dev/null
+++ b/lib/utils/BushLogger.ts
@@ -0,0 +1,315 @@
+import chalk from 'chalk';
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+import { bold, Client, EmbedBuilder, escapeMarkdown, PartialTextBasedChannelFields, type Message } from 'discord.js';
+import { stripVTControlCharacters as stripColor } from 'node:util';
+import repl, { REPLServer, REPL_MODE_STRICT } from 'repl';
+import { WriteStream } from 'tty';
+import { type SendMessageType } from '../extensions/discord-akairo/BushClient.js';
+import { colors } from './BushConstants.js';
+import { inspect } from './BushUtils.js';
+
+let REPL: REPLServer;
+let replGone = false;
+
+export function init() {
+ const kFormatForStdout = Object.getOwnPropertySymbols(console).find((sym) => sym.toString() === 'Symbol(kFormatForStdout)')!;
+ const kFormatForStderr = Object.getOwnPropertySymbols(console).find((sym) => sym.toString() === 'Symbol(kFormatForStderr)')!;
+
+ REPL = repl.start({
+ useColors: true,
+ terminal: true,
+ useGlobal: true,
+ replMode: REPL_MODE_STRICT,
+ breakEvalOnSigint: true,
+ ignoreUndefined: true
+ });
+
+ const apply = (stream: WriteStream, symbol: symbol): ProxyHandler<typeof console['log']>['apply'] =>
+ function apply(target, thisArg, args) {
+ if (stream.isTTY) {
+ stream.moveCursor(0, -1);
+ stream.write('\n');
+ stream.clearLine(0);
+ }
+
+ const ret = target(...args);
+
+ if (stream.isTTY) {
+ const formatted = (console as any)[symbol](args) as string;
+
+ stream.moveCursor(0, formatted.split('\n').length);
+ if (!replGone) {
+ REPL.displayPrompt(true);
+ }
+ }
+
+ return ret;
+ };
+
+ global.console.log = new Proxy(console.log, {
+ apply: apply(process.stdout, kFormatForStdout)
+ });
+
+ global.console.warn = new Proxy(console.warn, {
+ apply: apply(process.stderr, kFormatForStderr)
+ });
+
+ REPL.on('exit', () => {
+ replGone = true;
+ process.exit(0);
+ });
+}
+
+/**
+ * Parses the content surrounding by `<<>>` and emphasizes it with the given color or by making it bold.
+ * @param content The content to parse.
+ * @param color The color to emphasize the content with.
+ * @param discordFormat Whether or not to format the content for discord.
+ * @returns The formatted content.
+ */
+function parseFormatting(
+ content: any,
+ color: 'blueBright' | 'blackBright' | 'redBright' | 'yellowBright' | 'greenBright' | '',
+ discordFormat = false
+): string | typeof content {
+ if (typeof content !== 'string') return content;
+ return content
+ .split(/<<|>>/)
+ .map((value, index) => {
+ if (discordFormat) {
+ return index % 2 === 0 ? escapeMarkdown(value) : bold(escapeMarkdown(value));
+ } else {
+ return index % 2 === 0 || !color ? value : chalk[color](value);
+ }
+ })
+ .join('');
+}
+
+/**
+ * Inspects the content and returns a string.
+ * @param content The content to inspect.
+ * @param depth The depth the content will inspected. Defaults to `2`.
+ * @param colors Whether or not to use colors in the output. Defaults to `true`.
+ * @returns The inspected content.
+ */
+function inspectContent(content: any, depth = 2, colors = true): string {
+ if (typeof content !== 'string') {
+ return inspect(content, { depth, colors });
+ }
+ return content;
+}
+
+/**
+ * Generates a formatted timestamp for logging.
+ * @returns The formatted timestamp.
+ */
+function getTimeStamp(): string {
+ const now = new Date();
+ const minute = pad(now.getMinutes());
+ const hour = pad(now.getHours());
+ const date = `${pad(now.getMonth() + 1)}/${pad(now.getDate())}`;
+ return `${date} ${hour}:${minute}`;
+}
+
+/**
+ * Pad a two-digit number.
+ */
+function pad(num: number) {
+ return num.toString().padStart(2, '0');
+}
+
+/**
+ * Custom logging utility for the bot.
+ */
+export class BushLogger {
+ /**
+ * @param client The client.
+ */
+ public constructor(public client: Client) {}
+
+ /**
+ * 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.
+ * @param message The parameter to pass to {@link PartialTextBasedChannelFields.send}.
+ * @returns The message sent.
+ */
+ public async channelLog(message: SendMessageType): Promise<Message | null> {
+ const channel = await this.client.utils.getConfigChannel('log');
+ if (channel === null) return null;
+ return await channel.send(message).catch(() => null);
+ }
+
+ /**
+ * Sends a message to the error channel.
+ * @param message The parameter to pass to {@link PartialTextBasedChannelFields.send}.
+ * @returns The message sent.
+ */
+ public async channelError(message: SendMessageType): Promise<Message | null> {
+ const channel = await this.client.utils.getConfigChannel('error');
+ if (!channel) {
+ void this.error(
+ 'BushLogger',
+ `Could not find error channel, was originally going to send: \n${inspect(message, {
+ colors: true
+ })}\n${new Error().stack?.substring(8)}`,
+ false
+ );
+ return null;
+ }
+ return await channel.send(message);
+ }
+
+ /**
+ * 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 (!this.client.config.isDevelopment) return;
+ const newContent = inspectContent(content, depth, true);
+ console.log(`${chalk.bgMagenta(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 (!this.client.config.isDevelopment) return;
+ console.log(`${chalk.bgMagenta(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 (!this.client.config.logging.verbose) return;
+ const newContent = inspectContent(content, depth, true);
+ console.log(`${chalk.bgGrey(getTimeStamp())} ${chalk.grey(`[${header}]`)} ${parseFormatting(newContent, 'blackBright')}`);
+ if (!sendChannel) return;
+ const embed = new EmbedBuilder()
+ .setDescription(`**[${header}]** ${parseFormatting(stripColor(newContent), '', true)}`)
+ .setColor(colors.gray)
+ .setTimestamp();
+ await this.channelLog({ embeds: [embed] });
+ }
+
+ /**
+ * Logs very verbose information. Highlight information by surrounding it in `<<>>`.
+ * @param header The header printed before the content, displayed in purple.
+ * @param content The content to log, highlights displayed in bright black.
+ * @param depth The depth the content will inspected. Defaults to `0`.
+ */
+ public async superVerbose(header: string, content: any, depth = 0): Promise<void> {
+ if (!this.client.config.logging.verbose) return;
+ const newContent = inspectContent(content, depth, true);
+ console.log(
+ `${chalk.bgHex('#949494')(getTimeStamp())} ${chalk.hex('#949494')(`[${header}]`)} ${chalk.hex('#b3b3b3')(newContent)}`
+ );
+ }
+
+ /**
+ * Logs raw very verbose information.
+ * @param header The header printed before the content, displayed in purple.
+ * @param content The content to log.
+ */
+ public async superVerboseRaw(header: string, ...content: any[]): Promise<void> {
+ if (!this.client.config.logging.verbose) return;
+ console.log(`${chalk.bgHex('#a3a3a3')(getTimeStamp())} ${chalk.hex('#a3a3a3')(`[${header}]`)}`, ...content);
+ }
+
+ /**
+ * 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 (!this.client.config.logging.info) return;
+ const newContent = inspectContent(content, depth, true);
+ console.log(`${chalk.bgCyan(getTimeStamp())} ${chalk.cyan(`[${header}]`)} ${parseFormatting(newContent, 'blueBright')}`);
+ if (!sendChannel) return;
+ const embed = new EmbedBuilder()
+ .setDescription(`**[${header}]** ${parseFormatting(stripColor(newContent), '', true)}`)
+ .setColor(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 = inspectContent(content, depth, true);
+ console.warn(
+ `${chalk.bgYellow(getTimeStamp())} ${chalk.yellow(`[${header}]`)} ${parseFormatting(newContent, 'yellowBright')}`
+ );
+
+ if (!sendChannel) return;
+ const embed = new EmbedBuilder()
+ .setDescription(`**[${header}]** ${parseFormatting(stripColor(newContent), '', true)}`)
+ .setColor(colors.warn)
+ .setTimestamp();
+ await this.channelError({ 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 = inspectContent(content, depth, true);
+ console.warn(
+ `${chalk.bgRedBright(getTimeStamp())} ${chalk.redBright(`[${header}]`)} ${parseFormatting(newContent, 'redBright')}`
+ );
+ if (!sendChannel) return;
+ const embed = new EmbedBuilder()
+ .setDescription(`**[${header}]** ${parseFormatting(stripColor(newContent), '', true)}`)
+ .setColor(colors.error)
+ .setTimestamp();
+ await this.channelError({ embeds: [embed] });
+ return;
+ }
+
+ /**
+ * 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 = inspectContent(content, depth, true);
+ console.log(
+ `${chalk.bgGreen(getTimeStamp())} ${chalk.greenBright(`[${header}]`)} ${parseFormatting(newContent, 'greenBright')}`
+ );
+ if (!sendChannel) return;
+ const embed = new EmbedBuilder()
+ .setDescription(`**[${header}]** ${parseFormatting(stripColor(newContent), '', true)}`)
+ .setColor(colors.success)
+ .setTimestamp();
+ await this.channelLog({ embeds: [embed] }).catch(() => {});
+ }
+}