feat: add logger

.env.example

@@ -1,5 +1,6 @@
 # SETUP
 DISCORD_TOKEN=
+LOGLEVEL=
 
 # DB
 REDIS_URL=

.eslintrc.yaml

@@ -21,6 +21,10 @@ settings:
   import/resolver:
 
 rules:
+  no-restricted-syntax:
+    - error
+    - selector: CallExpression[callee.object.name='console'][callee.property.name!=/^(log|warn|error|info|trace)$/]
+      message: Use logger instead of console
   import/exports-last: error
   import/first: error
   import/no-duplicates: error

src/core/createModule.ts

@@ -1,5 +1,6 @@
 import { constantCase } from 'change-case';
 import type { ClientEvents, ClientOptions } from 'discord.js';
+import type { Logger } from 'pino';
 import type { ZodTypeAny } from 'zod';
 import { z } from 'zod';
 
@@ -11,6 +12,7 @@ type InferredZodShape<Shape extends Record<string, ZodTypeAny>> = {
 
 interface Context<Env extends Record<string, ZodTypeAny>> {
   env: InferredZodShape<Env>;
+  logger: Logger;
 }
 
 type ModuleFunction<Env extends Record<string, ZodTypeAny>, ReturnType> = (
@@ -31,6 +33,7 @@ type BotModule<Env extends Record<string, ZodTypeAny>> = {
 
 interface CreatedModuleInput {
   env: unknown;
+  logger: Logger;
 }
 
 type ModuleFactory = (input: CreatedModuleInput) => Promise<CreatedModule>;

src/core/loadModules.ts

@@ -4,6 +4,7 @@ import { checkUniqueSlashCommandNames } from './checkUniqueSlashCommandNames';
 import type { CreatedModule } from './createModule';
 import { env } from './env';
 import { pushCommands, routeCommands } from './loaderCommands';
+import { coreLogger } from './logger';
 import { routeHandlers } from './routeHandlers';
 
 export const loadModules = async (
@@ -15,6 +16,7 @@ export const loadModules = async (
   const botCommands = modules.flatMap((module) => module.slashCommands ?? []);
 
   checkUniqueSlashCommandNames(botCommands);
+  coreLogger.info('Routing slashcommands to interactionCreate event.');
   routeCommands(client, botCommands);
 
   const clientId = client.application?.id;

src/core/loaderCommands.ts

@@ -8,6 +8,7 @@ import {
 
 import type { BotCommand } from '../types/bot';
 import { deleteExistingCommands } from './deleteExistingCommands';
+import { coreLogger } from './logger';
 
 interface PushCommandsOptions {
   commands: RESTPostAPIChatInputApplicationCommandsJSONBody[];
@@ -62,6 +63,7 @@ export const pushCommands = async ({
   await rest.put(Routes.applicationGuildCommands(clientId, guildId), {
     body: commands,
   });
+  coreLogger.info('All commands are pushed.');
 };
 
 export const routeCommands = (client: Client<true>, botCommands: BotCommand[]) =>

src/core/logger.ts

@@ -0,0 +1,18 @@
+import createLogger, { type LoggerOptions } from 'pino';
+
+const developmentOptionsOverride: LoggerOptions = {
+  transport: {
+    target: './pinoTransportModule',
+  },
+  level: process.env['LOGLEVEL'] ?? 'debug',
+};
+
+const defaultLogger = createLogger({
+  level: process.env['LOGLEVEL'] ?? 'info',
+  ...(process.env['NODE_ENV'] === 'production' ? {} : developmentOptionsOverride),
+});
+
+export const createLoggerForModule = (moduleName: string) =>
+  defaultLogger.child({ module: moduleName });
+
+export const coreLogger = createLoggerForModule('core');

src/core/pinoTransportModule.ts

@@ -0,0 +1,11 @@
+import { red, white } from 'colorette';
+import pretty from 'pino-pretty';
+
+export default (opts: Parameters<typeof pretty>) =>
+  pretty({
+    ...opts,
+    colorize: true,
+    messageFormat: white(`[${red('{module}')}] {msg}`),
+    hideObject: true,
+    ignore: 'pid,hostname',
+  });

src/core/routeHandlers.ts

@@ -2,6 +2,7 @@ import type { Client, ClientEvents } from 'discord.js';
 
 import type { EventHandler } from '../types/bot';
 import type { CreatedModule } from './createModule';
+import { coreLogger } from './logger';
 
 const handleEvent = async (
   eventHandlers: EventHandler[],

src/main.ts

@@ -41,4 +41,4 @@ if (!client.isReady()) {
 
 await loadModules(client, createdModules);
 
-console.log('Bot started.');
+coreLogger.info('Bot fully started.');

src/modules/recurringMessage/recurringMessage.helpers.ts

@@ -51,8 +51,7 @@ export const createRecurringMessage = (
     () => {
       const channel = client.channels.cache.get(channelId);
       if (!channel || !channel.isTextBased()) {
-        console.error(`Channel ${channelId} not found`);
-        return;
+        throw new Error(`Channel ${channelId} not found`);
       }
       void channel.send(message);
     },

src/modules/voiceOnDemand/voiceOnDemand.module.ts

@@ -52,6 +52,7 @@ export const voiceOnDemand = createModule({
           //NOTES: this is a potential race condition.
           await cache.set('lobbyIds', [...lobbyIds, id]);
 
+          logger.info(`Created voice on demand voice channel ${id}`);
           await interaction.reply({
             content: 'Created voice on demand voice channel.',
             ephemeral: true,
@@ -60,7 +61,7 @@ export const voiceOnDemand = createModule({
       },
     },
   ],
-  eventHandlers: () => ({
+  eventHandlers: ({ logger }) => ({
     voiceStateUpdate: async (oldState, newState) => {
       const lobbyIds = await cache.get('lobbyIds', []);
       const onDemandChannels = await cache.get('onDemandChannels', []);
@@ -73,10 +74,18 @@ export const voiceOnDemand = createModule({
       }
 
       if (isOnDemandChannel && isLeaveState(oldState)) {
+        logger.debug(
+          { guild: newState.guild.id },
+          `User ${oldState.member.displayName} left the on-demand channel`,
+        );
         await handleLeaveOnDemand(oldState);
       }
 
       if (isLobbyChannel && isJoinState(newState)) {
+        logger.debug(
+          { guild: newState.guild.id },
+          `User ${newState.member.displayName} joined the lobby`,
+        );
         await handleJoinLobby(newState);
       }
     },
@@ -92,6 +101,11 @@ export const voiceOnDemand = createModule({
         return;
       }
 
+      logger.info(
+        { guild: channel.guild.id },
+        `Voice on demand voice channel ${channel.id} was deleted`,
+      );
+
       await cache.set(
         'lobbyIds',
         lobbyIds.filter((lobbyId) => lobbyId !== channel.id),

tsup.config.ts

@@ -1,7 +1,12 @@
+//eslint-disable-next-line import/no-extraneous-dependencies
 import { defineConfig } from 'tsup';
 
 export default defineConfig({
   clean: true,
+  entry: {
+    main: 'src/main.ts',
+    pinoTransportModule: 'src/core/pinoTransportModule.ts',
+  },
   format: ['esm'],
   keepNames: true,
   minify: true,