Add automatic command registration

CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Add automatic command registration
+
 ### Changed
 
 - Update dependencies
@@ -24,6 +28,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Removed
 
 - **Breaking:** remove `pm2` from the `npm start` script
+- Remove `commands:deploy` and `commands:revoke` scripts
 
 ### Fixed
 

README.md

@@ -215,7 +215,7 @@ The docker script will take care of every part of the docker development process
 
 ### Build the bot
 
-Be sure to install dependencies, generate necessary files, initialize the database, and deploy commands. Here's a handy command to do all of that:
+Be sure to install dependencies, generate necessary files, and initialize the database. Here's a handy command to do all of that:
 
 ```sh
 $ npm run setup
@@ -245,16 +245,6 @@ Migrations can be run on the database with the following command:
 $ npm run db:migrate
 ```
 
-### Register Slash Commands
-
-If you want support for Discord [Slash Commands](https://support.discord.com/hc/en-us/articles/1500000368501-Slash-Commands-FAQ), you'll need to deploy the commands directly. To avoid rate limits, use a command-line tool, rather than deploying on startup.
-
-Once you have your bot's account token in the .env file, run the following command to tell Discord about our commands:
-
-```sh
-$ npm run commands:deploy
-```
-
 ### Test the bot
 
 Whenever you make changes, you should make sure to run all unit tests before submitting.

package.json

@@ -21,8 +21,6 @@
 	"type": "module",
 	"main": "src/main.ts",
 	"scripts": {
-		"commands:deploy": "node --env-file=.env . --deploy # TODO: Replace these with automatic command deployment",
-		"commands:revoke": "node --env-file=.env . --revoke",
 		"db:generate": "./node_modules/.bin/prisma generate --no-hints --schema ./prisma/schema.prisma",
 		"db:init": "npm run db:migrate:initial || ./node_modules/.bin/prisma db push && npm run db:migrate:initial",
 		"db:migrate:initial": "./node_modules/.bin/prisma migrate resolve --applied 20240905171155_initial_state",
@@ -38,7 +36,7 @@
 		"lint": "./node_modules/.bin/eslint --flag unstable_native_nodejs_ts_config",
 		"lint:fix": "npm run lint -- --fix",
 		"release": "node ./scripts/release.ts",
-		"setup": "npm ci && npm run export-version && npm run db:migrate && npm run db:generate && npm run commands:deploy",
+		"setup": "npm ci && npm run export-version && npm run db:migrate && npm run db:generate",
 		"start": "node --env-file=.env .",
 		"test": "./node_modules/.bin/vitest",
 		"type-check": "./node_modules/.bin/tsc --noEmit"

scripts/launch_in_docker.sh

@@ -13,8 +13,5 @@ else
 	npm run db:init
 fi
 
-# Deploy commands
-node . --deploy
-
 # Launch
 node .

src/@types/Command.d.ts

@@ -19,7 +19,7 @@ declare global {
 			| Omit<SlashCommandBuilder, 'addSubcommand' | 'addSubcommandGroup'>;
 
 		/** The type of the command. */
-		type?: ApplicationCommandType.ChatInput;
+		type: ApplicationCommandType.ChatInput;
 
 		/**
 		 * A handler for autocomplete requests.

src/commands/contextMenu/altText.ts

@@ -4,7 +4,9 @@ import { ApplicationCommandType, ContextMenuCommandBuilder } from 'discord.js';
 import { isNonEmptyArray } from '../../helpers/guards/isNonEmptyArray.ts';
 
 export const altText: MessageContextMenuCommand = {
-	info: new ContextMenuCommandBuilder().setName('Get Alt Text'),
+	info: new ContextMenuCommandBuilder()
+		.setName('Get Alt Text')
+		.setType(ApplicationCommandType.Message),
 	type: ApplicationCommandType.Message,
 	requiresGuild: false,
 	async execute({ targetMessage, replyPrivately }) {

src/commands/contextMenu/fxtwitter.ts

@@ -10,7 +10,9 @@ const x = 'x.com';
 const xPermutations = new Set([x, `www.${x}`]);
 
 export const fxtwitter: MessageContextMenuCommand = {
-	info: new ContextMenuCommandBuilder().setName('Fix Twitter/X Links'),
+	info: new ContextMenuCommandBuilder()
+		.setName('Fix Twitter/X Links')
+		.setType(ApplicationCommandType.Message),
 	type: ApplicationCommandType.Message,
 	requiresGuild: false,
 	async execute({ targetMessage, replyPrivately }) {

src/commands/contextMenu/talk.ts

@@ -2,7 +2,9 @@ import { ApplicationCommandType, ContextMenuCommandBuilder } from 'discord.js';
 
 import { speak } from '../talk.ts';
 
-const builder = new ContextMenuCommandBuilder().setName('Talk');
+const builder = new ContextMenuCommandBuilder()
+	.setName('Talk')
+	.setType(ApplicationCommandType.Message);
 
 export const talk: MessageContextMenuCommand = {
 	info: builder,

src/commands/emoji.ts

@@ -1,4 +1,4 @@
-import { EmbedBuilder, SlashCommandBuilder } from 'discord.js';
+import { ApplicationCommandType, EmbedBuilder, SlashCommandBuilder } from 'discord.js';
 
 import { UserMessageError } from '../helpers/UserMessageError.ts';
 
@@ -21,6 +21,7 @@ const builder = new SlashCommandBuilder()
 
 export const emoji: GlobalCommand = {
 	info: builder,
+	type: ApplicationCommandType.ChatInput,
 	requiresGuild: false,
 	async execute({ reply, client, options }): Promise<void> {
 		const emojiName = options.getString(EmojiName, true);

src/commands/findRoom.ts

@@ -1,5 +1,5 @@
 import { array, boolean, string, tuple, type as schema } from 'superstruct';
-import { EmbedBuilder, SlashCommandBuilder } from 'discord.js';
+import { ApplicationCommandType, EmbedBuilder, SlashCommandBuilder } from 'discord.js';
 import { URL } from 'node:url';
 
 import { fetchJson } from '../helpers/fetch.ts';
@@ -213,6 +213,7 @@ const builder = new SlashCommandBuilder()
 
 export const findRoom: GlobalCommand = {
 	info: builder,
+	type: ApplicationCommandType.ChatInput,
 	requiresGuild: false,
 	async execute({ replyPrivately, options }): Promise<void> {
 		const input_bldg = options.getString('building');

src/commands/help.ts

@@ -1,4 +1,4 @@
-import { EmbedBuilder, SlashCommandBuilder } from 'discord.js';
+import { ApplicationCommandType, EmbedBuilder, SlashCommandBuilder } from 'discord.js';
 
 import { appVersion, repo } from '../constants/meta.ts';
 
@@ -8,6 +8,7 @@ const builder = new SlashCommandBuilder()
 
 export const help: GlobalCommand = {
 	info: builder,
+	type: ApplicationCommandType.ChatInput,
 	requiresGuild: false,
 	async execute({ reply }) {
 		const embed = new EmbedBuilder()

src/commands/isCasDown.ts

@@ -1,4 +1,4 @@
-import { EmbedBuilder, SlashCommandBuilder, Colors } from 'discord.js';
+import { EmbedBuilder, SlashCommandBuilder, Colors, ApplicationCommandType } from 'discord.js';
 
 const statusURI = 'https://cas.byu.edu/cas/serviceValidate';
 
@@ -18,6 +18,7 @@ const builder = new SlashCommandBuilder()
 
 export const isCasDown: GlobalCommand = {
 	info: builder,
+	type: ApplicationCommandType.ChatInput,
 	requiresGuild: false,
 	async execute({ reply }) {
 		const res = await fetch(statusURI);

src/commands/profile.ts

@@ -1,5 +1,11 @@
 import type { User } from 'discord.js';
-import { DiscordAPIError, EmbedBuilder, SlashCommandBuilder, userMention } from 'discord.js';
+import {
+	ApplicationCommandType,
+	DiscordAPIError,
+	EmbedBuilder,
+	SlashCommandBuilder,
+	userMention,
+} from 'discord.js';
 
 import { DiscordErrorCode } from '../helpers/DiscordErrorCode.ts';
 
@@ -14,6 +20,7 @@ const builder = new SlashCommandBuilder()
 
 export const profile: GlobalCommand = {
 	info: builder,
+	type: ApplicationCommandType.ChatInput,
 	requiresGuild: false,
 	async execute({ client, user, options, reply, guild, source }) {
 		const otherUser = options.getUser(UserParamName);

src/commands/sendtag.ts

@@ -1,4 +1,4 @@
-import { SlashCommandBuilder } from 'discord.js';
+import { ApplicationCommandType, SlashCommandBuilder } from 'discord.js';
 
 const NameOption = 'name';
 
@@ -15,6 +15,7 @@ const info = new SlashCommandBuilder()
 
 export const sendtag: GuildedCommand = {
 	info,
+	type: ApplicationCommandType.ChatInput,
 	requiresGuild: true,
 	autocomplete(interaction) {
 		// Get the user-provided intermediate value

src/commands/setReactboard.ts

@@ -1,4 +1,5 @@
 import {
+	ApplicationCommandType,
 	Guild,
 	GuildEmoji,
 	SlashCommandBuilder,
@@ -44,6 +45,7 @@ interface ReactboardReactInfo {
 
 export const setReactboard: GuildedCommand = {
 	info: builder,
+	type: ApplicationCommandType.ChatInput,
 	requiresGuild: true,
 	async execute({ guild, options, replyPrivately }) {
 		const channel = options.getChannel(channelOption, true);

src/commands/stats.ts

@@ -1,5 +1,5 @@
 import type { ChatInputCommandInteraction } from 'discord.js';
-import { EmbedBuilder, SlashCommandBuilder, userMention } from 'discord.js';
+import { ApplicationCommandType, EmbedBuilder, SlashCommandBuilder, userMention } from 'discord.js';
 
 import { db } from '../database/index.ts';
 import { sanitize } from '../helpers/sanitize.ts';
@@ -73,8 +73,8 @@ const builder = new SlashCommandBuilder()
 
 export const stats: GuildedCommand = {
 	info: builder,
+	type: ApplicationCommandType.ChatInput,
 	requiresGuild: true,
-
 	async execute({ reply, replyPrivately, interaction, guild }): Promise<void> {
 		const subcommand = interaction.options.getSubcommand();
 

src/commands/talk.ts

@@ -1,5 +1,10 @@
 import type { AttachmentPayload } from 'discord.js';
-import { SlashCommandBuilder, ChannelType, PermissionFlagsBits } from 'discord.js';
+import {
+	SlashCommandBuilder,
+	ChannelType,
+	PermissionFlagsBits,
+	ApplicationCommandType,
+} from 'discord.js';
 import type { AudioResource } from '@discordjs/voice';
 import {
 	createAudioResource,
@@ -46,6 +51,7 @@ const builder = new SlashCommandBuilder()
 
 export const talk: GlobalCommand = {
 	info: builder,
+	type: ApplicationCommandType.ChatInput,
 	requiresGuild: false,
 	async execute(context) {
 		const options = context.options;

src/commands/toTheGallows.ts

@@ -1,4 +1,4 @@
-import { SlashCommandBuilder } from 'discord.js';
+import { ApplicationCommandType, SlashCommandBuilder } from 'discord.js';
 
 import { EvilHangmanGame } from '../evilHangman/evilHangmanGame.ts';
 import { buildEvilHangmanMessage } from '../evilHangman/evilHangmanMessage.ts';
@@ -25,6 +25,7 @@ const builder = new SlashCommandBuilder()
 
 export const toTheGallows: GlobalCommand = {
 	info: builder,
+	type: ApplicationCommandType.ChatInput,
 	requiresGuild: false,
 	async execute({ reply, options }): Promise<void> {
 		const wordLength = options.getInteger(LengthOption);

src/commands/xkcd.ts

@@ -1,4 +1,4 @@
-import { EmbedBuilder, SlashCommandBuilder } from 'discord.js';
+import { ApplicationCommandType, EmbedBuilder, SlashCommandBuilder } from 'discord.js';
 import { URL } from 'node:url';
 import { number, string, type as schema } from 'superstruct';
 
@@ -75,10 +75,9 @@ const builder = new SlashCommandBuilder()
 	);
 
 export const xkcd: GlobalCommand = {
-	requiresGuild: false,
 	info: builder,
-
-	// entry point for command execution
+	type: ApplicationCommandType.ChatInput,
+	requiresGuild: false,
 	async execute({ options, reply, sendTyping }) {
 		let comic = '';
 		// not making this nullable, instead filling with dummy data to be later filled.