feat: context menu commands and user installables

Author: twlite

apps/test-bot/src/app/commands/avatar/command.ts

@@ -1,4 +1,8 @@
-import { MessageCommandContext, SlashCommandContext } from 'commandkit';
+import {
+  MessageCommandContext,
+  SlashCommandContext,
+  UserContextMenuCommandContext,
+} from 'commandkit';
 import { ApplicationCommandOptionType } from 'discord.js';
 
 export const command = {
@@ -13,6 +17,26 @@ export const command = {
   ],
 };
 
+export async function userContextMenu(ctx: UserContextMenuCommandContext) {
+  const target = ctx.interaction.targetUser;
+
+  const { t } = ctx.locale();
+
+  const msg = await t('avatar', { user: target.username });
+
+  await ctx.interaction.reply({
+    embeds: [
+      {
+        title: msg,
+        image: {
+          url: target.displayAvatarURL({ size: 2048 }),
+        },
+        color: 0x7289da,
+      },
+    ],
+  });
+}
+
 export async function chatInput(ctx: SlashCommandContext) {
   const user = ctx.options.getUser('user') ?? ctx.interaction.user;
 

apps/test-bot/src/app/commands/cat/command.ts

@@ -1,8 +1,36 @@
-import type { CommandData, SlashCommand, MessageCommand } from 'commandkit';
+import type {
+  CommandData,
+  SlashCommand,
+  MessageCommand,
+  MessageContextMenuCommand,
+} from 'commandkit';
+import {
+  ApplicationIntegrationType,
+  InteractionContextType,
+  MessageFlags,
+} from 'discord.js';
 
-export const data: CommandData = {
+export const command: CommandData = {
   name: 'cat',
   description: 'cat command',
+  integration_types: [
+    ApplicationIntegrationType.GuildInstall,
+    ApplicationIntegrationType.UserInstall,
+  ],
+  contexts: [
+    InteractionContextType.Guild,
+    InteractionContextType.BotDM,
+    InteractionContextType.PrivateChannel,
+  ],
+};
+
+export const messageContextMenu: MessageContextMenuCommand = async (ctx) => {
+  const content = ctx.interaction.targetMessage.content || 'No content found';
+
+  await ctx.interaction.reply({
+    content,
+    flags: MessageFlags.Ephemeral,
+  });
 };
 
 export const chatInput: SlashCommand = async (ctx) => {

apps/test-bot/src/app/commands/dog/command.ts

@@ -1,6 +1,6 @@
 import type { CommandData, SlashCommand, MessageCommand } from 'commandkit';
 
-export const data: CommandData = {
+export const command: CommandData = {
   name: 'dog',
   description: 'dog command',
 };

apps/test-bot/src/index.ts

@@ -13,8 +13,8 @@ const commandkit = new CommandKit({
   commandsPath: `${__dirname}/commands`,
   eventsPath: `${__dirname}/events`,
   validationsPath: `${__dirname}/validations`,
-  devGuildIds: process.env.DEV_GUILD_ID?.split(',') ?? [],
-  devUserIds: process.env.DEV_USER_ID?.split(',') ?? [],
+  // devGuildIds: process.env.DEV_GUILD_ID?.split(',') ?? [],
+  // devUserIds: process.env.DEV_USER_ID?.split(',') ?? [],
   bulkRegister: true,
 });
 

packages/commandkit/src/app/command-handler/AppCommandHandler.ts

@@ -74,10 +74,7 @@ export class AppCommandHandler {
   public constructor(public readonly commandkit: CommandKit) {}
 
   public getCommandsArray() {
-    return Array.from(this.loadedCommands.values()).map((v) => {
-      if ('toJSON' in v && typeof v.toJSON === 'function') return v.toJSON();
-      return v.data.command;
-    });
+    return Array.from(this.loadedCommands.values());
   }
 
   public async prepareCommandRun(

packages/commandkit/src/app/router/CommandsRouter.ts

@@ -206,7 +206,7 @@ export class CommandsRouter {
       if (commandSegments.length !== segments.length) return false;
 
       return commandSegments.every((segment, index) => {
-        if (segment === '[name]') return true;
+        if (/^\[.+\]$/.test(segment)) return true;
         return segment === segments[index];
       });
     });
@@ -266,7 +266,7 @@ export class CommandsRouter {
         });
 
         const parent = parentSegments.join(' ');
-        const name = parts[parts.length - 1].replace(/\.(m|c)?(j|t)sx?$/, '');
+        const name = parts[parts.length - 2];
 
         const command: ParsedCommand = {
           name,

packages/commandkit/src/cli/build.ts

@@ -17,7 +17,7 @@ import { BuildOptions } from './types';
 
 export async function bootstrapProductionBuild(configPath: string) {
   const config = await findCommandKitConfig(configPath);
-  const spinner = createSpinner('Creating optimized production build...');
+  const spinner = await createSpinner('Creating optimized production build...');
   const start = performance.now();
 
   try {
@@ -104,13 +104,15 @@ async function buildProject(options: BuildOptions) {
       !!polyfillRequire,
     );
 
-    write(
-      colors.green(
-        `\nRun ${colors.magenta(`commandkit start`)} ${colors.green(
-          'to start your bot.',
-        )}`,
-      ),
-    );
+    if (!options.isDevelopment) {
+      write(
+        colors.green(
+          `\nRun ${colors.magenta(`commandkit start`)} ${colors.green(
+            'to start your bot.',
+          )}`,
+        ),
+      );
+    }
   } catch (e) {
     panic(e);
   }

packages/commandkit/src/cli/development.ts

@@ -10,7 +10,7 @@ export async function bootstrapDevelopmentServer(opts: any) {
   const config = await findCommandKitConfig(opts.config);
   const { watch = true, nodeOptions = [], clearRestartLogs = true } = config;
 
-  const spinner = createSpinner('Starting development server...');
+  const spinner = await createSpinner('Starting development server...');
   const start = performance.now();
 
   try {

packages/commandkit/src/cli/generators.ts

@@ -24,7 +24,7 @@ export async function generateCommand(name: string, customPath?: string) {
   const commandFile = `
 import type { CommandData, SlashCommand, MessageCommand } from 'commandkit';
 
-export const data: CommandData = {
+export const command: CommandData = {
   name: '${name}',
   description: '${name} command',
 };
@@ -34,7 +34,7 @@ export const chatInput: SlashCommand = async (ctx) => {
 };
 
 export const message: MessageCommand = async (ctx) => {
-    await ctx.message.reply('Hello from ${name}!');
+  await ctx.message.reply('Hello from ${name}!');
 };
 `.trim();
 

packages/commandkit/src/cli/production.ts

@@ -15,7 +15,7 @@ export async function bootstrapProductionServer(configPath: string) {
     panic('Could not find production build, run `commandkit build` first');
   }
 
-  const spinner = createSpinner('Starting production server...');
+  const spinner = await createSpinner('Starting production server...');
 
   try {
     const processEnv = {};

packages/commandkit/src/cli/utils.ts

@@ -4,7 +4,9 @@ import { parseEnv } from './parse-env';
 import { ChildProcessWithoutNullStreams, spawn } from 'node:child_process';
 import colors from '../utils/colors';
 import { CLIOptions } from './types';
-import ora, { Ora } from 'ora';
+import type { Ora } from 'ora';
+
+let ora: typeof import('ora') | undefined;
 
 export function createNodeProcess(
   options: CLIOptions,
@@ -50,8 +52,10 @@ export function loadEnvFiles(options: CLIOptions) {
   return processEnv;
 }
 
-export function createSpinner(text: string): Ora {
-  return ora({
+export async function createSpinner(text: string): Promise<Ora> {
+  if (!ora) ora = await import('ora');
+
+  return (ora.default || ora)({
     text,
     color: 'cyan',
   });

packages/commandkit/src/legacy/handlers/command-handler/CommandHandler.ts

@@ -1,4 +1,10 @@
-import { CacheType, Events, Interaction, Message } from 'discord.js';
+import {
+  ApplicationCommandType,
+  CacheType,
+  Events,
+  Interaction,
+  Message,
+} from 'discord.js';
 import type {
   CommandData,
   CommandFileObject,
@@ -185,6 +191,8 @@ export class CommandHandler {
         commandObj.category = commandCategory;
       }
 
+      Logger.info(`Loaded command: ${commandObj.data.name}`);
+
       this.#data.commands.push(commandObj);
     }
 
@@ -193,19 +201,56 @@ export class CommandHandler {
 
       const commands = handler.getCommandsArray();
 
-      // this.#data.commands.push(...commands);
-
       for (const cmd of commands) {
-        const idx = this.#data.commands.findIndex(
-          (c) => c.data.name === cmd.name,
-        );
+        const json: CommandData =
+          'toJSON' in cmd.data.command
+            ? cmd.data.command.toJSON()
+            : cmd.data.command;
 
-        if (idx !== -1) {
-          // @ts-ignore
-          this.#data.commands[idx] = { data: cmd };
-        } else {
-          // @ts-ignore
-          this.#data.commands.push({ data: cmd });
+        const additionals: CommandData[] = [json];
+
+        if (
+          cmd.data.userContextMenu &&
+          json.type !== ApplicationCommandType.User
+        ) {
+          additionals.push({
+            ...json,
+            type: ApplicationCommandType.User,
+            options: undefined,
+            description_localizations: undefined,
+            // @ts-ignore
+            description: undefined,
+          });
+        }
+
+        if (
+          cmd.data.messageContextMenu &&
+          json.type !== ApplicationCommandType.Message
+        ) {
+          additionals.push({
+            ...json,
+            type: ApplicationCommandType.Message,
+            description_localizations: undefined,
+            // @ts-ignore
+            description: undefined,
+            options: undefined,
+          });
+        }
+
+        for (const variant of additionals) {
+          const idx = this.#data.commands.findIndex(
+            (c) => c.data.name === variant.name && c.data.type === variant.type,
+          );
+
+          if (idx !== -1) {
+            // @ts-ignore
+            this.#data.commands[idx] = { data: variant };
+          } else {
+            // @ts-ignore
+            this.#data.commands.push({ data: variant });
+          }
+
+          Logger.info(`(app ✨) Loaded command: ${variant.name}`);
         }
       }
     }

packages/commandkit/src/legacy/handlers/command-handler/functions/loadCommandsWithRest.ts

@@ -115,8 +115,9 @@ async function loadGlobalCommands(
           `Error ${
             reloading ? 'reloading' : 'loading'
           } global application commands.\n`,
-        ),
-        error,
+        ) +
+          '\n' +
+          error?.stack || error,
       );
     });
 

packages/commandkit/src/utils/utilities.ts

@@ -15,7 +15,7 @@ export function findAppDirectory(): string | null {
 
   if (!existsSync(root)) root = process.cwd();
 
-  const dirs = ['src/app'].map((dir) => join(root, dir));
+  const dirs = ['app'].map((dir) => join(root, dir));
 
   for (const dir of dirs) {
     if (existsSync(dir)) {

packages/commandkit/tsup.config.ts

@@ -11,7 +11,6 @@ export default defineConfig({
   keepNames: true,
   dts: true,
   shims: true,
-  splitting: false,
   skipNodeModulesBundle: true,
   clean: true,
   target: 'node16',