Review comments

Author: Gerrit0

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+pretty-quick --staged

README.md

@@ -16,5 +16,5 @@ We also have a docker-compose.yml for development, along with a .env.example.
 
 ## Thanks!
 
--   [ckie](https://github.com/ckiee) for writing the base for the bot.
+-   [ckie](https://github.com/ckiee) for writing the base for the bot!
 -   [Python Discord](https://github.com/python-discord) for heavily influencing our help channel system.

package.json

@@ -20,23 +20,18 @@
 		"undici": "^5.12.0"
 	},
 	"devDependencies": {
-		"@types/dotenv-safe": "^8.1.2",
-		"@types/lz-string": "^1.3.34",
-		"@types/node": "^16",
-		"@types/npm-registry-fetch": "^8.0.4",
-		"@types/prettier": "^2.7.1",
-		"@types/tar": "^6.1.3",
-		"@types/ws": "^8.5.3",
+		"@types/dotenv-safe": "8.1.2",
+		"@types/lz-string": "1.3.34",
+		"@types/node": "16.18.3",
+		"@types/npm-registry-fetch": "8.0.4",
+		"@types/prettier": "2.7.1",
+		"@types/tar": "6.1.3",
+		"@types/ws": "8.5.3",
 		"husky": "^8.0.2",
 		"pretty-quick": "^3.1.3",
 		"ts-node-dev": "^2.0.0",
 		"typescript": "^4.9.3"
 	},
-	"husky": {
-		"hooks": {
-			"pre-commit": "pretty-quick --staged"
-		}
-	},
 	"scripts": {
 		"start": "ts-node-dev --respawn src",
 		"build": "tsc",

src/bot.ts

@@ -7,9 +7,15 @@ export interface CommandRegistration {
 	listener: (msg: Message, content: string) => Promise<void>;
 }
 
+interface Command {
+	admin: boolean;
+	aliases: string[];
+	description?: string;
+	listener: (msg: Message, content: string) => Promise<void>;
+}
+
 export class Bot {
-	commands: CommandRegistration[] = [];
-	adminCommands: CommandRegistration[] = [];
+	commands = new Map<string, Command>();
 
 	constructor(public client: Client<true>) {
 		client.on('messageCreate', msg => {
@@ -26,11 +32,7 @@ export class Bot {
 					triggerWithPrefix.substring(matchingPrefix.length),
 				);
 
-				if (
-					!command ||
-					(this.adminCommands.includes(command) &&
-						!this.isAdmin(msg.author))
-				) {
+				if (!command || (command.admin && !this.isAdmin(msg.author))) {
 					return;
 				}
 				command.listener(msg, content).catch(err => {
@@ -40,17 +42,28 @@ export class Bot {
 		});
 	}
 
-	registerCommand(command: CommandRegistration) {
-		this.commands.push(command);
+	registerCommand(registration: CommandRegistration) {
+		const command: Command = {
+			...registration,
+			admin: false,
+		};
+		for (const a of command.aliases) {
+			this.commands.set(a, command);
+		}
 	}
 
-	registerAdminCommand(command: CommandRegistration) {
-		this.adminCommands.push(command);
+	registerAdminCommand(registration: CommandRegistration) {
+		const command: Command = {
+			...registration,
+			admin: true,
+		};
+		for (const a of command.aliases) {
+			this.commands.set(a, command);
+		}
 	}
 
-	getByTrigger(trigger: string): CommandRegistration | undefined {
-		const match = (c: CommandRegistration) => c.aliases.includes(trigger);
-		return this.commands.find(match) || this.adminCommands.find(match);
+	getByTrigger(trigger: string): Command | undefined {
+		return this.commands.get(trigger);
 	}
 
 	isMod(member: GuildMember | null) {
@@ -80,18 +93,18 @@ export class Bot {
 		const mentioned = msg.mentions.members?.first()?.user;
 		if (mentioned) return mentioned;
 
-		if (query) {
-			// Search by ID
-			const queriedUser = await this.client.users
-				.fetch(query)
-				.catch(() => undefined);
-			if (queriedUser) return queriedUser;
-
-			// Search by name, likely a better way to do this...
-			for (const user of this.client.users.cache.values()) {
-				if (user.tag === query || user.username === query) {
-					return user;
-				}
+		if (!query) return;
+
+		// Search by ID
+		const queriedUser = await this.client.users
+			.fetch(query)
+			.catch(() => undefined);
+		if (queriedUser) return queriedUser;
+
+		// Search by name, likely a better way to do this...
+		for (const user of this.client.users.cache.values()) {
+			if (user.tag === query || user.username === query) {
+				return user;
 			}
 		}
 	}

src/modules/autorole.ts

@@ -1,4 +1,3 @@
-import { TextBasedChannel } from 'discord.js';
 import { Bot } from '../bot';
 import { autorole, rolesChannelId } from '../env';
 
@@ -19,10 +18,6 @@ export async function autoroleModule({ client }: Bot) {
 		await msg?.react(ar.emoji);
 	}
 
-	client.channels.fetch(rolesChannelId).then(channel => {
-		(channel as TextBasedChannel).messages.fetch();
-	});
-
 	client.on('messageReactionAdd', async (reaction, user) => {
 		if (user.id == client.user.id) return;
 		if (reaction.partial) await reaction.fetch();

src/modules/help.ts

@@ -54,10 +54,10 @@ export function helpModule(bot: Bot) {
 						`Hello ${msg.author.username}! Here is a list of all commands in me! To get detailed description on any specific command, do \`help <command>\``,
 					);
 
-				for (const cat of getCommandCategories(bot.commands)) {
+				for (const cat of getCommandCategories(bot.commands.values())) {
 					embed.addFields({
 						name: `**${cat} Commands:**`,
-						value: getCategoryHelp(cat, bot.commands),
+						value: getCategoryHelp(cat, bot.commands.values()),
 					});
 				}
 
@@ -72,7 +72,7 @@ export function helpModule(bot: Bot) {
 			}
 
 			let cmd: { description?: string; aliases?: string[] } =
-				bot.commands.find(c => c.aliases.includes(cmdTrigger)) || {};
+				bot.getByTrigger(cmdTrigger) || {};
 
 			if (!cmd.description && cmdTrigger.includes(':')) {
 				const snippet = await Snippet.findOne({

yarn.lock

@@ -227,14 +227,14 @@
   resolved "https://registry.yarnpkg.com/@tsconfig/node16/-/node16-1.0.3.tgz#472eaab5f15c1ffdd7f8628bd4c4f753995ec79e"
   integrity sha512-yOlFc+7UtL/89t2ZhjPvvB/DeAr3r+Dq58IgzsFkOAvVC6NMJXmCGjbptdXdR9qsX7pKcTL+s87FtYREi2dEEQ==
 
-"@types/dotenv-safe@^8.1.2":
+"@types/[email protected]":
   version "8.1.2"
   resolved "https://registry.yarnpkg.com/@types/dotenv-safe/-/dotenv-safe-8.1.2.tgz#72f126969f445af5654efd3167deabc2cbc6c24e"
   integrity sha512-R/B/wIMda6lRE2P1H0vwSoJsV78IOkhccE4vIvmKZQNXOIjiU0QyJsUXwSotBxOPZFZ/oOnjCa3+kK5kVJwGyw==
   dependencies:
     dotenv "^8.2.0"
 
-"@types/lz-string@^1.3.34":
+"@types/[email protected]":
   version "1.3.34"
   resolved "https://registry.yarnpkg.com/@types/lz-string/-/lz-string-1.3.34.tgz#69bfadde419314b4a374bf2c8e58659c035ed0a5"
   integrity sha512-j6G1e8DULJx3ONf6NdR5JiR2ZY3K3PaaqiEuKYkLQO0Czfi1AzrtjfnfCROyWGeDd5IVMKCwsgSmMip9OWijow==
@@ -257,7 +257,7 @@
   resolved "https://registry.yarnpkg.com/@types/node/-/node-18.11.9.tgz#02d013de7058cea16d36168ef2fc653464cfbad4"
   integrity sha512-CRpX21/kGdzjOpFsZSkcrXMGIBWMGNIHXXBVFSH+ggkftxg+XYP20TESbh+zFvFj3EQOl5byk0HTRn1IL6hbqg==
 
-"@types/node@^16":
+"@types/node@16.18.3":
   version "16.18.3"
   resolved "https://registry.yarnpkg.com/@types/node/-/node-16.18.3.tgz#d7f7ba828ad9e540270f01ce00d391c54e6e0abc"
   integrity sha512-jh6m0QUhIRcZpNv7Z/rpN+ZWXOicUUQbSoWks7Htkbb9IjFQj4kzcX/xFCkjstCj5flMsN8FiSvt+q+Tcs4Llg==
@@ -267,7 +267,7 @@
   resolved "https://registry.yarnpkg.com/@types/npm-package-arg/-/npm-package-arg-6.1.1.tgz#9e2d8adc04d39824a3d9f36f738010a3f7da3c1a"
   integrity sha512-452/1Kp9IdM/oR10AyqAgZOxUt7eLbm+EMJ194L6oarMYdZNiFIFAOJ7IIr0OrZXTySgfHjJezh2oiyk2kc3ag==
 
-"@types/npm-registry-fetch@^8.0.4":
+"@types/[email protected]":
   version "8.0.4"
   resolved "https://registry.yarnpkg.com/@types/npm-registry-fetch/-/npm-registry-fetch-8.0.4.tgz#77b2737cde22314ccda1dfdb9568fd7769e95b90"
   integrity sha512-R9yEj6+NDmXLpKNS19cIaMyaHfV0aHjy/1qbo8K9jiHyjyaYg0CEmuOV/L0Q91DZDi3SuxlYY+2XYwh9TbB+eQ==
@@ -283,7 +283,7 @@
   resolved "https://registry.yarnpkg.com/@types/npmlog/-/npmlog-4.1.4.tgz#30eb872153c7ead3e8688c476054ddca004115f6"
   integrity sha512-WKG4gTr8przEZBiJ5r3s8ZIAoMXNbOgQ+j/d5O4X3x6kZJRLNvyUJuUK/KoG3+8BaOHPhp2m7WC6JKKeovDSzQ==
 
-"@types/prettier@^2.7.1":
+"@types/[email protected]":
   version "2.7.1"
   resolved "https://registry.yarnpkg.com/@types/prettier/-/prettier-2.7.1.tgz#dfd20e2dc35f027cdd6c1908e80a5ddc7499670e"
   integrity sha512-ri0UmynRRvZiiUJdiz38MmIblKK+oH30MztdBVR95dv/Ubw6neWSb8u1XpRb72L4qsZOhz+L+z9JD40SJmfWow==
@@ -305,15 +305,15 @@
   resolved "https://registry.yarnpkg.com/@types/strip-json-comments/-/strip-json-comments-0.0.30.tgz#9aa30c04db212a9a0649d6ae6fd50accc40748a1"
   integrity sha512-7NQmHra/JILCd1QqpSzl8+mJRc8ZHz3uDm8YV1Ks9IhK0epEiTw8aIErbvH9PI+6XbqhyIQy3462nEsn7UVzjQ==
 
-"@types/tar@^6.1.3":
+"@types/[email protected]":
   version "6.1.3"
   resolved "https://registry.yarnpkg.com/@types/tar/-/tar-6.1.3.tgz#46a2ce7617950c4852dfd7e9cd41aa8161b9d750"
   integrity sha512-YzDOr5kdAeqS8dcO6NTTHTMJ44MUCBDoLEIyPtwEn7PssKqUYL49R1iCVJPeiPzPlKi6DbH33eZkpeJ27e4vHg==
   dependencies:
     "@types/node" "*"
     minipass "^3.3.5"
 
-"@types/ws@^8.5.3":
+"@types/ws@8.5.3", "@types/ws@^8.5.3":
   version "8.5.3"
   resolved "https://registry.yarnpkg.com/@types/ws/-/ws-8.5.3.tgz#7d25a1ffbecd3c4f2d35068d0b283c037003274d"
   integrity sha512-6YOoWjruKj1uLf3INHH7D3qTXwFfEsg1kf3c0uDdSBJwfa/llkwIjrAGV7j7mVgGNbzTQ3HiHKKDXl6bJPD97w==