Add assert script to env vars, edit example file

Author: rafaelalmeidatk

.env.example

@@ -1,5 +1,10 @@
-DISCORD_BOT_TOKEN=foo
+# Required vars
+DISCORD_BOT_TOKEN=
+DISCORD_CLIENT_ID=
+MOD_LOG_CHANNEL_ID=
+
+# If you plan to register new commands in dev
+# DEV_GUILD_ID=
 
 # These are not required, you can set them to override the default channels IDs on dev
-#MOD_LOG_CHANNEL_ID=123456789012345678
-#RULES_CHANNEL_ID=123456789012345678
+# RULES_CHANNEL_ID=

README.md

@@ -1,6 +1,6 @@
 # Next.js Discord Bot
 
-The source code of the Discord bot for the official [Next.js discord](https://nextjs.org/discord).
+The source code of the Discord bot for the official [Next.js Discord](https://nextjs.org/discord).
 
 ## Features
 

env.d.ts

@@ -0,0 +1,12 @@
+declare global {
+  namespace NodeJS {
+    interface ProcessEnv {
+      // Required env variables
+      DISCORD_BOT_TOKEN: string;
+      DISCORD_CLIENT_ID: string;
+      MOD_LOG_CHANNEL_ID: string;
+    }
+  }
+}
+
+export {};

package.json

@@ -8,6 +8,7 @@
     "start": "node dist/index.js",
     "dev": "ts-node-dev src/index.ts",
     "dev:register-commands": "DEV=true ts-node ./src/register-commands.ts",
+    "register-commands": "ts-node ./src/register-commands.ts",
     "build": "tsc",
     "lint": "eslint src"
   },

src/assert-env-vars.ts

@@ -0,0 +1,18 @@
+import assert from 'assert';
+import dotenv from 'dotenv';
+
+dotenv.config();
+
+const required = (name: string, val: string | undefined) =>
+  assert(val, `${name} is not defined`);
+
+const optional = (name: string, val: string | undefined) => {
+  if (!val) {
+    console.warn(`Warning: ${name} is not defined, some features may not work`);
+  }
+};
+
+required('DISCORD_BOT_TOKEN', process.env.DISCORD_BOT_TOKEN);
+required('DISCORD_CLIENT_ID', process.env.DISCORD_CLIENT_ID);
+required('MOD_LOG_CHANNEL_ID', process.env.MOD_LOG_CHANNEL_ID);
+optional('MODERATOR_ROLE_ID', process.env.MODERATOR_ROLE_ID);

src/commands/context/report.ts

@@ -12,9 +12,6 @@ import { isStaff } from '../../utils';
  * Logs a message in the mod log channel. If a normal user uses the command it will ping the mods
  */
 
-const MOD_LOG_CHANNEL_ID =
-  process.env.MOD_LOG_CHANNEL_ID ?? '763149438951882792';
-
 // We will keep a memory cache of warned messages to avoid showing multiple warnings
 const warnedMessageIds: string[] = [];
 
@@ -44,11 +41,11 @@ export const command: ContextMenuCommand = {
       return;
     }
 
-    const channel = client.channels.cache.get(MOD_LOG_CHANNEL_ID);
+    const channel = client.channels.cache.get(process.env.MOD_LOG_CHANNEL_ID);
 
     if (!channel || !channel.isTextBased()) {
       console.error(
-        `No mod-log channel found (using the ID ${MOD_LOG_CHANNEL_ID})!`
+        `No mod-log channel found (using the ID ${process.env.MOD_LOG_CHANNEL_ID})!`
       );
 
       interaction.reply({

src/index.ts

@@ -1,8 +1,7 @@
 import fs from 'node:fs';
 import path from 'node:path';
-import dotenv from 'dotenv';
 import discord, { Events, GatewayIntentBits, Partials, User } from 'discord.js';
-dotenv.config();
+import './assert-env-vars';
 
 import { FeatureFile } from './types';
 import { isJsOrTsFile } from './utils';

src/register-commands.ts

@@ -1,18 +1,9 @@
-import dotenv from 'dotenv';
 import { REST, Routes } from 'discord.js';
-import { allCommands } from './commands';
+import './assert-env-vars';
 
-dotenv.config();
+import { allCommands } from './commands';
 
 (async () => {
-  if (!process.env.DISCORD_BOT_TOKEN) {
-    throw new Error('No bot token found!');
-  }
-
-  if (!process.env.DISCORD_CLIENT_ID) {
-    throw new Error('DISCORD_CLIENT_ID is not set');
-  }
-
   const isDevRegister = process.env.DEV === 'true';
   const guildId = process.env.DEV_GUILD_ID;
 

tsconfig.json

@@ -12,5 +12,6 @@
     "forceConsistentCasingInFileNames": true
   },
   "include": ["src/**/*.ts"],
-  "exclude": ["node_modules"]
+  "exclude": ["node_modules"],
+  "files": ["env.d.ts"]
 }