feat: add logger

Author: Manuel

.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/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,41 @@
+import createLogger, { type LoggerOptions } from 'pino';
+import type pinodev from 'pino-dev';
+import type { PrettyOptions } from 'pino-pretty';
+
+type PrettyDevOptions = Parameters<typeof pinodev>[0];
+type BotLoggerOptions = LoggerOptions &
+  (
+    | { transport?: { target: 'pino-dev'; options: PrettyDevOptions } }
+    | { transport?: { target: 'pino-pretty'; options: PrettyOptions } }
+  );
+
+const developmentOptionsOverride: BotLoggerOptions = {
+  transport: {
+    target: 'pino-dev',
+    options: {
+      colorize: true,
+      // propertyMap: {
+      //   module: '[module]',
+      // },
+    },
+  },
+  // transport: {
+  //   target: 'pino-pretty',
+  //   options: {
+  //     customPrettifiers: {
+  //       // module: (name) => `[${name}]`,
+  //     },
+  //   },
+  // },
+  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/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);
     },