feat: improvements to the cli

Author: twlite

apps/test-bot/src/app/commands/(actions)/dm-only.ts

@@ -1,11 +1,11 @@
 import { SlashCommandProps, CommandData, dmOnly } from 'commandkit';
 
-export const data: CommandData = {
+export const command: CommandData = {
   name: 'dm-only',
   description: 'This is a dm only command',
 };
 
-export async function run({ interaction }: SlashCommandProps) {
+export async function chatInput({ interaction }: SlashCommandProps) {
   dmOnly();
 
   await interaction.reply('This command can only be used in a dm.');

apps/test-bot/src/app/commands/(actions)/giveaway.ts

@@ -11,7 +11,7 @@ import {
   AutocompleteProps,
 } from 'commandkit';
 
-export const data: CommandData = {
+export const command: CommandData = {
   name: 'ping',
   description: 'Pong!',
   options: [
@@ -42,7 +42,7 @@ export async function autocomplete({ interaction }: AutocompleteProps) {
   interaction.respond(filtered);
 }
 
-export async function run({ interaction, client }: SlashCommandProps) {
+export async function chatInput({ interaction, client }: SlashCommandProps) {
   if (!interaction.channel) return;
 
   const button = new ButtonKit()

apps/test-bot/src/app/commands/(actions)/guild-only.ts

@@ -1,11 +1,11 @@
 import { SlashCommandProps, CommandData, guildOnly } from 'commandkit';
 
-export const data: CommandData = {
+export const command: CommandData = {
   name: 'guild-only',
   description: 'This is a guild only command.',
 };
 
-export async function run({ interaction }: SlashCommandProps) {
+export async function chatInput({ interaction }: SlashCommandProps) {
   guildOnly();
 
   await interaction.reply('This command can only be used in a guild.');

apps/test-bot/src/app/commands/(developer)/reload.ts

@@ -1,11 +1,11 @@
 import { SlashCommandProps, CommandOptions, CommandData } from 'commandkit';
 
-export const data: CommandData = {
+export const command: CommandData = {
   name: 'reload',
   description: 'Reload commands, events, and validations.',
 };
 
-export async function run({ interaction, handler }: SlashCommandProps) {
+export async function chatInput({ interaction, handler }: SlashCommandProps) {
   await interaction.deferReply({ ephemeral: true });
 
   // await handler.reloadCommands();

apps/test-bot/src/app/commands/(developer)/run-after.ts

@@ -1,11 +1,11 @@
 import { SlashCommandProps, CommandData, afterCommand } from 'commandkit';
 
-export const data: CommandData = {
+export const command: CommandData = {
   name: 'run-after',
   description: 'This is a run-after command',
 };
 
-export async function run({ interaction }: SlashCommandProps) {
+export async function chatInput({ interaction }: SlashCommandProps) {
   afterCommand((env) => {
     console.log(
       `The command ${interaction.commandName} was executed successfully in ${env

apps/test-bot/src/app/commands/(general)/help.ts

@@ -1,6 +1,6 @@
 import { SlashCommandProps, CommandData } from 'commandkit';
 
-export const data: CommandData = {
+export const command: CommandData = {
   name: 'help',
   description: 'This is a help command.',
 };
@@ -12,7 +12,7 @@ function $botVersion(): string {
   return require(path).version;
 }
 
-export async function run({ interaction, handler }: SlashCommandProps) {
+export async function chatInput({ interaction, handler }: SlashCommandProps) {
   await interaction.deferReply();
 
   const botVersion = $botVersion();

apps/test-bot/src/app/commands/(general)/ping.ts

@@ -11,7 +11,7 @@ import {
   AutocompleteProps,
 } from 'commandkit';
 
-export const data: CommandData = {
+export const command: CommandData = {
   name: 'ping',
   description: 'Pong!',
   options: [
@@ -42,7 +42,7 @@ export async function autocomplete({ interaction }: AutocompleteProps) {
   interaction.respond(filtered);
 }
 
-export async function run({ interaction, client }: SlashCommandProps) {
+export async function chatInput({ interaction, client }: SlashCommandProps) {
   if (!interaction.channel) return;
 
   const button = new ButtonKit()

apps/test-bot/src/app/commands/(interactions)/commandkit.tsx

@@ -7,7 +7,7 @@ import CommandKit, {
 } from 'commandkit';
 import { MessageFlags } from 'discord.js';
 
-export const data: CommandData = {
+export const command: CommandData = {
   name: 'commandkit',
   description: 'This is a commandkit command.',
 };
@@ -40,7 +40,7 @@ function ButtonGrid() {
   );
 }
 
-export async function run({ interaction }: SlashCommandProps) {
+export async function chatInput({ interaction }: SlashCommandProps) {
   await interaction.deferReply();
 
   await interaction.editReply({

apps/test-bot/src/app/commands/(interactions)/confirmation.tsx

@@ -7,7 +7,7 @@ import CommandKit, {
 } from 'commandkit';
 import { ButtonStyle, MessageFlags } from 'discord.js';
 
-export const data: CommandData = {
+export const command: CommandData = {
   name: 'confirm',
   description: 'This is a confirm command.',
 };
@@ -30,7 +30,7 @@ const handleCancel: OnButtonKitClick = async (interaction, context) => {
   context.dispose();
 };
 
-export async function run({ interaction }: SlashCommandProps) {
+export async function chatInput({ interaction }: SlashCommandProps) {
   const buttons = (
     <ActionRow>
       <Button onClick={handleCancel} style={ButtonStyle.Primary}>

apps/test-bot/src/app/commands/(leveling)/xp.ts

@@ -1,7 +1,7 @@
 import { SlashCommandProps, CommandData, cacheTag } from 'commandkit';
 import { database } from '../../../database/store.ts';
 
-export const data: CommandData = {
+export const command: CommandData = {
   name: 'xp',
   description: 'This is an xp command.',
 };
@@ -17,7 +17,7 @@ async function getUserXP(guildId: string, userId: string) {
   return xp;
 }
 
-export async function run({ interaction }: SlashCommandProps) {
+export async function chatInput({ interaction }: SlashCommandProps) {
   await interaction.deferReply();
 
   const dataRetrievalStart = Date.now();

apps/test-bot/src/app/commands/random/index.ts

@@ -1,6 +1,6 @@
 import { SlashCommandProps, CommandData, cache } from 'commandkit';
 
-export const data: CommandData = {
+export const command: CommandData = {
   name: 'random',
   description: 'This is a random command.',
 };
@@ -12,7 +12,7 @@ const random = cache(
   { name: 'random', ttl: 60_000 },
 );
 
-export async function run({ interaction }: SlashCommandProps) {
+export async function chatInput({ interaction }: SlashCommandProps) {
   await interaction.deferReply();
 
   const xp = await random();

apps/test-bot/src/app/commands/random/invalidate.ts

@@ -1,11 +1,11 @@
 import { SlashCommandProps, CommandData, invalidate } from 'commandkit';
 
-export const data: CommandData = {
+export const command: CommandData = {
   name: 'invalidate-random',
   description: 'This is a random command invalidation.',
 };
 
-export async function run({ interaction }: SlashCommandProps) {
+export async function chatInput({ interaction }: SlashCommandProps) {
   await interaction.deferReply();
 
   await invalidate('random');

apps/test-bot/src/app/commands/random/revalidate.ts

@@ -1,11 +1,11 @@
 import { SlashCommandProps, CommandData, revalidate } from 'commandkit';
 
-export const data: CommandData = {
+export const command: CommandData = {
   name: 'revalidate-random',
   description: 'This is a random command invalidation.',
 };
 
-export async function run({ interaction }: SlashCommandProps) {
+export async function chatInput({ interaction }: SlashCommandProps) {
   await interaction.deferReply();
 
   const revalidated = await revalidate<number>('random');

packages/commandkit/package.json

@@ -13,7 +13,7 @@
   ],
   "scripts": {
     "lint": "tsc --noEmit",
-    "dev": "tsup --watch",
+    "dev": "pnpm run --filter=test-bot dev",
     "build": "tsup",
     "publish-package": "npm publish",
     "test": "vitest"
@@ -34,14 +34,15 @@
     "@babel/parser": "^7.26.5",
     "@babel/traverse": "^7.26.5",
     "@babel/types": "^7.26.5",
+    "chokidar": "^4.0.3",
     "commander": "^12.1.0",
     "dotenv": "^16.4.7",
     "ms": "^2.1.3",
     "ora": "^8.0.1",
     "picocolors": "^1.1.1",
     "rfdc": "^1.3.1",
     "rimraf": "^5.0.5",
-    "tsup": "^8.3.5",
+    "tsup": "^8.4.0",
     "use-macro": "^1.1.0"
   },
   "devDependencies": {

packages/commandkit/src/CommandKit.ts

@@ -14,6 +14,9 @@ import { LocalizationStrategy } from './app/i18n/LocalizationStrategy';
 import { CommandsRouter, EventsRouter } from './app/router';
 import { AppEventsHandler } from './app/handlers/AppEventsHandler';
 import { CommandKitPluginRuntime } from './plugins/runtime/CommandKitPluginRuntime';
+import { loadConfigFile } from './config/loader';
+import { COMMANDKIT_IS_DEV } from './utils/constants';
+import { registerDevHooks } from './utils/dev-hooks';
 
 export interface CommandKitConfiguration {
   defaultLocale: Locale;
@@ -95,6 +98,7 @@ export class CommandKit extends EventEmitter {
    * @param token The application token to connect to the discord gateway. If not provided, it will use the `TOKEN` or `DISCORD_TOKEN` environment variable. If set to `false`, it will not login.
    */
   async start(token?: string | false) {
+    await loadConfigFile();
     if (this.#started) return;
 
     await this.#init();
@@ -109,6 +113,10 @@ export class CommandKit extends EventEmitter {
 
     this.#started = true;
 
+    if (COMMANDKIT_IS_DEV) {
+      registerDevHooks(this);
+    }
+
     await this.commandHandler.registrar.register();
   }
 

packages/commandkit/src/app/handlers/AppEventsHandler.ts

@@ -1,5 +1,6 @@
 import { CommandKit } from '../../CommandKit';
 import { Logger } from '../../logger/Logger';
+import { toFileURL } from '../../utils/resolve-file-url';
 import { ParsedEvent } from '../router';
 
 export type EventListener = (...args: any[]) => any;
@@ -30,7 +31,7 @@ export class AppEventsHandler {
       const listeners: EventListener[] = [];
 
       for (const listener of event.listeners) {
-        const handler = await import(`file://${listener}?t=${Date.now()}`);
+        const handler = await import(toFileURL(listener, true));
 
         if (!handler.default || typeof handler.default !== 'function') {
           Logger.error(

packages/commandkit/src/cli/app-process.ts

@@ -0,0 +1,38 @@
+import { spawn } from 'node:child_process';
+import { DevEnv, devEnvFileArgs, prodEnvFileArgs } from './env';
+import { join } from 'node:path';
+import { existsSync } from 'node:fs';
+import { panic } from './common';
+
+export function createAppProcess(
+  fileName: string,
+  cwd: string,
+  isDev: boolean,
+) {
+  const envFiles = isDev ? devEnvFileArgs(cwd) : prodEnvFileArgs(cwd);
+
+  if (!existsSync(join(cwd, fileName))) {
+    panic(`Could not locate the entrypoint file: ${fileName}`);
+  }
+
+  const ps = spawn(
+    'node',
+    [
+      ...envFiles,
+      `--title="CommandKit ${isDev ? 'Development' : 'Production'}"`,
+      '--enable-source-maps',
+      fileName,
+    ],
+    {
+      cwd: cwd,
+      windowsHide: true,
+      env: DevEnv(),
+      stdio: 'pipe',
+    },
+  );
+
+  ps.stdout?.pipe(process.stdout);
+  ps.stderr?.pipe(process.stderr);
+
+  return ps;
+}