chore: templates (#7)

* Type error fix

* Samples

* prettify

* formatting src/events/EventSample.disable

Co-authored-by: Antti <[email protected]>

* Update CommandSample.disable

* Update src/commands/CommandSample.disable

Co-authored-by: Antti <[email protected]>

* Update src/commands/CommandSample.disable

Co-authored-by: Antti <[email protected]>

* Rename CommandSample.disable to CommandSample.ts.disable

* Rename EventSample.disable to EventSample.ts.disable

* comment change

* return type

Co-authored-by: Antti <[email protected]>

Author: StrangeGirlMurph

src/Command.ts

@@ -8,5 +8,5 @@ export abstract class Command {
 
 	public readonly name: string;
 	abstract execute(interaction: CommandInteraction): Promise<void>;
-	abstract register(): SlashCommandBuilder;
+	abstract register(): SlashCommandBuilder | Omit<SlashCommandBuilder, "addSubcommandGroup" | "addSubcommand">;
 }

src/commands/CommandSample.ts.disable

@@ -0,0 +1,30 @@
+import { Command } from "../Command";
+import { CommandInteraction } from "discord.js";
+import { SlashCommandBuilder } from "@discordjs/builders";
+
+// set the class name, the export at the bottom and the file name to your desired command name (same as the one in the register function)
+class CommandName extends Command {
+    constructor() {
+        super("bunny"); // the name under which the bot internally stores your command (should be the same as the named set in `register`, must be unique)
+    }
+
+    async execute(interaction: CommandInteraction): Promise<void> {
+        // put the logic of your command here
+        // for example:
+        const num = interaction.options.getInteger("amount") || 1;
+        await interaction.reply("🐇".repeat(num));
+    }
+
+    register(): SlashCommandBuilder | Omit<SlashCommandBuilder, "addSubcommandGroup" | "addSubcommand"> {
+        // set the name and description shown in discord here (these are necessary)
+        // (name: string.length = 1-32, description string.length = 1-100)(the name has to be lowercase!)
+        // here you can also add things like options to your command
+        // see more under https://discord.js.org/#/docs/builders/stable/class/SlashCommandBuilder
+        return new SlashCommandBuilder()
+            .setName("bunny")
+            .setDescription("shows you a cute bunny")
+            .addIntegerOption(option => option.setName("amount").setDescription("number of bunnies").setRequired(false));
+    }
+}
+
+export default new CommandName();

src/commands/PingCommand.ts

@@ -12,7 +12,7 @@ class PingCommand extends Command {
 		await interaction.reply(`Pong! (Bot ping: ${botping}ms)`);
 	}
 
-	register(): SlashCommandBuilder {
+	register(): SlashCommandBuilder | Omit<SlashCommandBuilder, "addSubcommandGroup" | "addSubcommand"> {
 		return new SlashCommandBuilder().setName("ping").setDescription("Replies pong and the bots ping.");
 	}
 }

src/events/EventSample.ts.disable

@@ -0,0 +1,5 @@
+// set the function name to the event name 
+// and edit the parameter to fit in its type and name to the event
+export default async function interactionName(args: unknown) {
+    // do things if the event occurs 
+}

src/events/ready.ts

@@ -41,7 +41,10 @@ async function updateRegisteredCommands(client: Client) {
 	}
 }
 
-function commandsEqual(c1: ApplicationCommand, c2: SlashCommandBuilder): boolean {
+function commandsEqual(
+	c1: ApplicationCommand,
+	c2: SlashCommandBuilder | Omit<SlashCommandBuilder, "addSubcommandGroup" | "addSubcommand">
+): boolean {
 	return (
 		c1.name === c2.name &&
 		c1.description === c2.description &&