Add Inherited Config to Support Multi-Environment Configuration (#210)

.gitignore

@@ -5,4 +5,5 @@ node_modules/
 .nyc_output/
 coverage/
 .codacy-coverage/
-.vscode
+.vscode
+src/config.dev.json

README.md

@@ -14,6 +14,7 @@ This repository contains the code for the CodeSupport Discord Bot. The project i
 - [Axios](https://www.npmjs.com/package/axios)
 - [Twitter](https://www.npmjs.com/package/twitter)
 - [dotenv](https://www.npmjs.com/package/dotenv)
+- [Inherited Config](https://www.npmjs.com/package/@codesupport/inherited-config)
 
 ### Development
 - [TypeScript](https://www.npmjs.com/package/typescript)
@@ -39,6 +40,7 @@ This repository contains the code for the CodeSupport Discord Bot. The project i
    - You will need to supply the `DISCORD_TOKEN` environment variable
 
 If you would like to use a `.env` file for storing your environment variables please create it in the root of the project.
+If you would like to overwrite values in `config.json` to better suit your local environment create a file named `config.dev.json` with any values you would like to overwrite `config.json` with.
 
 ## Structure
 - All source code lives inside `src/`

package.json

@@ -6,7 +6,7 @@
   "scripts": {
     "start": "node -r dotenv/config ./build/index.js",
     "build": "tsc",
-    "dev": "cross-env NODE_ENV=development nodemon --watch src --ext ts --exec 'ts-node -r dotenv/config ./src/index.ts'",
+    "dev": "cross-env NODE_ENV=dev nodemon --watch src --ext ts --exec 'ts-node -r dotenv/config ./src/index.ts'",
     "coverage": "nyc --reporter=lcov --reporter=text-summary npm test",
     "test": "ts-mocha test/**/*Test.ts test/**/**/*Test.ts test/appTest.ts --exit",
     "test:debug": "ts-mocha test/**/*Test.ts test/**/**/*Test.ts test/appTest.ts --timeout 999999999 --exit",
@@ -33,6 +33,7 @@
     "npm": ">=7.0.0"
   },
   "dependencies": {
+    "@codesupport/inherited-config": "^1.0.2",
     "axios": "^0.21.1",
     "axios-cache-adapter": "^2.5.0",
     "discord.js": "^13.5.0",

src/abstracts/LogMessageDeleteHandler.ts

@@ -1,6 +1,7 @@
 import {MessageEmbed, Message, TextChannel, ColorResolvable} from "discord.js";
-import { LOG_CHANNEL_ID, EMBED_COLOURS } from "../config.json";
 import EventHandler from "./EventHandler";
+import getConfigValue from "../utils/getConfigValue";
+import GenericObject from "../interfaces/GenericObject";
 
 abstract class LogMessageDeleteHandler extends EventHandler {
 	async sendLog(message: Message): Promise<void> {
@@ -10,9 +11,11 @@ abstract class LogMessageDeleteHandler extends EventHandler {
 			embed.setTitle("Message Deleted");
 			embed.setDescription(`Author: ${message.author}\nChannel: ${message.channel}`);
 			embed.addField("Message", message.content);
-			embed.setColor(<ColorResolvable>EMBED_COLOURS.DEFAULT);
+			embed.setColor(getConfigValue<GenericObject<ColorResolvable>>("EMBED_COLOURS").DEFAULT);
 
-			const logsChannel = message.guild?.channels.cache.find(channel => channel.id === LOG_CHANNEL_ID) as TextChannel;
+			const logsChannel = message.guild?.channels.cache.find(
+				channel => channel.id === getConfigValue<string>("LOG_CHANNEL_ID")
+			) as TextChannel;
 
 			await logsChannel?.send({ embeds: [embed] });
 		}