zumito-framework 1.20.0 → 1.21.0

package/dist/launcher.js

@@ -6,16 +6,15 @@ import fs from 'fs';
 import { pathToFileURL } from 'url';
 import dotenv from 'dotenv';
 import { RecursiveObjectMerger } from './services/utilities/RecursiveObjectMerger';
+import { EnvValidator } from './services/utilities/EnvValidator';
+import { BotReadyLogger } from './services/utilities/BotReadyLogger';
 dotenv.config();
-if (!process.env.DISCORD_TOKEN) {
-    throw new Error("Discord Token not found (DISCORD_TOKEN)");
-}
-else if (!process.env.DISCORD_CLIENT_ID) {
-    throw new Error("Discord Client ID not found (DISCORD_CLIENT_ID)");
-}
-else if (!process.env.MONGO_URI) {
-    throw new Error("No MongoDB connection string specified in .env file (MONGO_URI)");
-}
+const REQUIRED_ENV_VARS = {
+    DISCORD_TOKEN: 'Discord Bot Token',
+    DISCORD_CLIENT_ID: 'Discord Client ID',
+    MONGO_URI: 'MongoDB connection URI',
+};
+EnvValidator.validate(REQUIRED_ENV_VARS);
 const defaultConfig = {
     discordClientOptions: {
         intents: 3276799,
@@ -35,16 +34,7 @@ import(pathToFileURL(configFilePath).href)
     .then(({ config: userConfig }) => {
     const config = RecursiveObjectMerger.merge(defaultConfig, userConfig);
     new ZumitoFramework(config, (bot) => {
-        // Log number of commands loaded
-        console.log(`Loaded ${bot.commands.size} commands`);
-        // Log number of events loaded
-        console.log(`Loaded ${bot.events.size} events`);
-        // Log number of modules loaded
-        console.log(`Loaded ${bot.modules.size} modules`);
-        // Log number of translations loaded
-        console.log(`Loaded ${bot.translations.getAll().size} translations`);
-        // Log number of routes registered
-        console.log(`Loaded ${bot.routes.length} routes`);
+        BotReadyLogger.log(bot);
         userConfig.callbacks?.load?.(bot);
     });
 })

package/dist/services/utilities/BotReadyLogger.d.ts

@@ -0,0 +1,7 @@
+import { ZumitoFramework } from '../../ZumitoFramework';
+export declare class BotReadyLogger {
+    /**
+     * Log standard bot startup statistics (commands, events, modules, etc).
+     */
+    static log(bot: ZumitoFramework): void;
+}

package/dist/services/utilities/BotReadyLogger.js

@@ -0,0 +1,12 @@
+export class BotReadyLogger {
+    /**
+     * Log standard bot startup statistics (commands, events, modules, etc).
+     */
+    static log(bot) {
+        console.log(`Loaded ${bot.commands.size} commands`);
+        console.log(`Loaded ${bot.events.size} events`);
+        console.log(`Loaded ${bot.modules.size} modules`);
+        console.log(`Loaded ${bot.translations.getAll().size} translations`);
+        console.log(`Loaded ${bot.routes.length} routes`);
+    }
+}

package/dist/services/utilities/EnvValidator.d.ts

@@ -0,0 +1,9 @@
+export type EnvVarDefinitions = Record<string, string>;
+export declare class EnvValidator {
+    /**
+     * Validate that all required env vars are present. If any are missing,
+     * renders a visual error report and exits the process.
+     * @param required - Map of { KEY: 'Human label' }
+     */
+    static validate(required: EnvVarDefinitions): void;
+}

package/dist/services/utilities/EnvValidator.js

@@ -0,0 +1,50 @@
+import path from 'path';
+import fs from 'fs';
+import chalk from 'chalk';
+export class EnvValidator {
+    /**
+     * Validate that all required env vars are present. If any are missing,
+     * renders a visual error report and exits the process.
+     * @param required - Map of { KEY: 'Human label' }
+     */
+    static validate(required) {
+        const missing = [];
+        const present = [];
+        for (const [key] of Object.entries(required)) {
+            if (process.env[key]) {
+                present.push(key);
+            }
+            else {
+                missing.push(key);
+            }
+        }
+        if (missing.length === 0)
+            return;
+        const divider = chalk.yellow('━'.repeat(54));
+        const envPath = path.join(process.cwd(), '.env');
+        const hasEnvFile = fs.existsSync(envPath);
+        console.error(`\n${divider}`);
+        console.error(`  ${chalk.bold.red('CONFIGURATION ERROR')} — Missing environment variables`);
+        console.error(divider);
+        for (const key of present) {
+            const label = required[key];
+            const value = process.env[key];
+            const display = value.length > 28 ? value.slice(0, 25) + '...' : value;
+            console.error(`  ${chalk.green('✓')} ${chalk.green(key.padEnd(20))} ${chalk.dim(display)}`);
+        }
+        for (const key of missing) {
+            const label = required[key];
+            console.error(`  ${chalk.red('✗')} ${chalk.red(key.padEnd(20))} ${chalk.bold(label)}`);
+        }
+        console.error(divider);
+        if (!hasEnvFile) {
+            console.error(`  ${chalk.yellow('No .env file found in project root.')}`);
+            console.error(`  ${chalk.dim('Create one from .env.example and fill in the missing values.')}`);
+        }
+        else {
+            console.error(`  ${chalk.dim('.env file found but missing required variables.')}`);
+        }
+        console.error(divider + '\n');
+        process.exit(1);
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zumito-framework",
-  "version": "1.20.0",
+  "version": "1.21.0",
   "description": "Discord.js bot framework",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",