feat: allow importing commandkit directly

Author: twlite

apps/test-bot/src/app.ts

@@ -1,5 +1,5 @@
 import { Client } from 'discord.js';
-import { Logger, onApplicationBootstrap } from 'commandkit';
+import { Logger, commandkit } from 'commandkit';
 
 const client = new Client({
   intents: [
@@ -11,16 +11,15 @@ const client = new Client({
   ],
 });
 
-onApplicationBootstrap((commandkit) => {
-  Logger.log('Application bootstrapped successfully!');
-  commandkit.setPrefixResolver((message) => {
-    return [
-      `<@${message.client.user.id}>`,
-      `<@!${message.client.user.id}>`,
-      '!',
-      '?',
-    ];
-  });
+Logger.log('Application bootstrapped successfully!');
+
+commandkit.setPrefixResolver((message) => {
+  return [
+    `<@${message.client.user.id}>`,
+    `<@!${message.client.user.id}>`,
+    '!',
+    '?',
+  ];
 });
 
 export default client;

packages/commandkit/src/CommandKit.ts

@@ -3,8 +3,8 @@ import type { CommandKitOptions } from './types';
 import colors from './utils/colors';
 import { createElement, Fragment } from './components';
 import { EventInterceptor } from './components/common/EventInterceptor';
-import { Awaitable, Events, Locale, Message } from 'discord.js';
-import { findAppDirectory } from './utils/utilities';
+import { Awaitable, Client, Events, Locale, Message } from 'discord.js';
+import { createProxy, findAppDirectory, SimpleProxy } from './utils/utilities';
 import { join } from 'node:path';
 import { AppCommandHandler } from './app/handlers/AppCommandHandler';
 import { CommandsRouter, EventsRouter } from './app/router';
@@ -26,9 +26,6 @@ export interface CommandKitConfiguration {
   getMessageCommandPrefix: (message: Message) => Awaitable<string | string[]>;
 }
 
-// @ts-ignore
-export let commandkit: CommandKit;
-
 export type BootstrapFunction =
   | GenericFunction<[CommandKit]>
   | AsyncFunction<[CommandKit]>;
@@ -74,7 +71,8 @@ export function onApplicationBootstrap<F extends BootstrapFunction>(
 
 export class CommandKit extends EventEmitter {
   #started = false;
-  private options: CommandKitOptions;
+  #clientProxy: SimpleProxy<Client> | null = createProxy({} as Client);
+  #client!: Client;
   public eventInterceptor!: EventInterceptor;
 
   public static readonly createElement = createElement;
@@ -103,7 +101,7 @@ export class CommandKit extends EventEmitter {
    * @param options - The default CommandKit configuration.
    * @see {@link https://commandkit.js.org/docs/guide/commandkit-setup}
    */
-  constructor(options: CommandKitOptions) {
+  constructor(options: CommandKitOptions = {}) {
     if (CommandKit.instance) {
       process.emitWarning(
         'CommandKit instance already exists. Having multiple instance in same project is discouraged and it may lead to unexpected behavior.',
@@ -113,24 +111,17 @@ export class CommandKit extends EventEmitter {
       );
     }
 
-    if (!options.client) {
-      throw new Error(
-        colors.red('"client" is required when instantiating CommandKit.'),
-      );
-    }
-
     super();
 
-    this.options = options;
-
     if (!CommandKit.instance) {
       CommandKit.instance = this;
     }
 
-    this.plugins = new CommandKitPluginRuntime(this);
+    if (options?.client) {
+      this.setClient(options.client);
+    }
 
-    // @ts-ignore
-    commandkit = CommandKit.instance;
+    this.plugins = new CommandKitPluginRuntime(this);
 
     this.#bootstrapHooks();
   }
@@ -171,7 +162,7 @@ export class CommandKit extends EventEmitter {
   async start(token?: string | false) {
     if (this.#started) return;
 
-    if (!this.options.client) {
+    if (!this.#client) {
       throw new Error(
         colors.red('"client" is required when starting CommandKit.'),
       );
@@ -199,7 +190,7 @@ export class CommandKit extends EventEmitter {
     this.commandHandler.registerCommandHandler();
     this.incrementClientListenersCount();
 
-    if (token !== false && !this.options.client.isReady()) {
+    if (token !== false && !this.client.isReady()) {
       this.client.once(Events.ClientReady, async () => {
         await this.commandHandler.registrar.register();
       });
@@ -210,16 +201,16 @@ export class CommandKit extends EventEmitter {
 
       const botToken =
         token ??
-        this.options.client.token ??
+        this.client.token ??
         process.env.TOKEN ??
         process.env.DISCORD_TOKEN;
 
-      await this.options.client.login(botToken);
+      await this.client.login(botToken);
 
       await this.plugins.execute((ctx, plugin) => {
         return plugin.onAfterClientLogin?.(ctx);
       });
-    } else if (this.options.client.isReady()) {
+    } else if (this.client.isReady()) {
       await this.commandHandler.registrar.register();
     }
 
@@ -272,8 +263,33 @@ export class CommandKit extends EventEmitter {
   /**
    * Get the client attached to this CommandKit instance.
    */
-  get client() {
-    return this.options.client;
+  get client(): Client {
+    const client = this.#client || this.#clientProxy?.proxy;
+
+    if (!client) {
+      throw new Error('Client instance is not set');
+    }
+
+    return client;
+  }
+
+  /**
+   * Sets the client attached to this CommandKit instance.
+   * @param client The client to set.
+   */
+  setClient(client: Client) {
+    this.#client = client;
+
+    // update the proxy target if it exists
+    if (this.#clientProxy) {
+      // this is a hack to update the proxy target
+      // because some of the dependencies of commandkit may
+      // depend on the client instance
+      this.#clientProxy.setTarget(client);
+      this.#clientProxy = null;
+    }
+
+    return this;
   }
 
   async #init() {
@@ -350,18 +366,14 @@ export class CommandKit extends EventEmitter {
    * Increment the client listeners count.
    */
   incrementClientListenersCount() {
-    this.options.client.setMaxListeners(
-      this.options.client.getMaxListeners() + 1,
-    );
+    this.client.setMaxListeners(this.client.getMaxListeners() + 1);
   }
 
   /**
    * Decrement the client listeners count.
    */
   decrementClientListenersCount() {
-    this.options.client.setMaxListeners(
-      this.options.client.getMaxListeners() - 1,
-    );
+    this.client.setMaxListeners(this.client.getMaxListeners() - 1);
   }
 
   /**
@@ -388,3 +400,5 @@ export class CommandKit extends EventEmitter {
     }
   }
 }
+
+export const commandkit = CommandKit.instance || new CommandKit();

packages/commandkit/src/cli/build.ts

@@ -134,13 +134,17 @@ async function injectEntryFile(
   const code = `/* Entrypoint File Generated By CommandKit */
 ${isDev ? `\n\n// Injected for development\n${wrapInAsyncIIFE([envScript(isDev), antiCrashScript])}\n\n` : wrapInAsyncIIFE([envScript(isDev)])}
 
-import { CommandKit } from 'commandkit';
+import { commandkit } from 'commandkit';
+import { Client } from 'discord.js';
 
 async function bootstrap() {
   const app = await import('./app.js').then((m) => m.default ?? m);
-  const commandkit = new CommandKit({
-    client: app,
-  });
+
+  if (!app || !(app instanceof Client)) {
+    throw new Error('The app file must default export the discord.js client instance');
+  }
+
+  commandkit.setClient(app);
 
   await commandkit.start();
 }

packages/commandkit/src/types.ts

@@ -13,7 +13,7 @@ export interface CommandKitOptions {
   /**
    * The Discord.js client object to use with CommandKit.
    */
-  client: Client;
+  client?: Client;
 }
 
 /**

packages/commandkit/src/utils/utilities.ts

@@ -133,3 +133,68 @@ export function stopEvents(): never {
 
   throw new StopEventPropagationError();
 }
+
+export interface SimpleProxy<T extends object> {
+  proxy: T;
+  setTarget(newTarget: T): void;
+}
+
+/**
+ * Creates a simple proxy object that mirrors the target object.
+ * @param target The target object to proxy.
+ * @returns The proxied object.
+ */
+export function createProxy<T extends object>(target: T): SimpleProxy<T> {
+  let _target = target;
+
+  const proxy = new Proxy(_target, {
+    get(target, prop, receiver) {
+      return Reflect.get(_target, prop, receiver);
+    },
+    set(target, prop, value, receiver) {
+      return Reflect.set(_target, prop, value, receiver);
+    },
+    deleteProperty(target, prop) {
+      return Reflect.deleteProperty(_target, prop);
+    },
+    has(target, prop) {
+      return Reflect.has(_target, prop);
+    },
+    ownKeys(target) {
+      return Reflect.ownKeys(_target);
+    },
+    getOwnPropertyDescriptor(target, prop) {
+      return Reflect.getOwnPropertyDescriptor(_target, prop);
+    },
+    defineProperty(target, prop, attributes) {
+      return Reflect.defineProperty(_target, prop, attributes);
+    },
+    getPrototypeOf(target) {
+      return Reflect.getPrototypeOf(_target);
+    },
+    setPrototypeOf(target, proto) {
+      return Reflect.setPrototypeOf(_target, proto);
+    },
+    isExtensible(target) {
+      return Reflect.isExtensible(_target);
+    },
+    preventExtensions(target) {
+      return Reflect.preventExtensions(_target);
+    },
+    apply(target, thisArg, args) {
+      // @ts-ignore
+      return Reflect.apply(_target, thisArg, args);
+    },
+    construct(target, args, newTarget) {
+      // @ts-ignore
+      return Reflect.construct(_target, args, newTarget);
+    },
+  });
+
+  return {
+    proxy,
+    setTarget(newTarget: T) {
+      _target = newTarget;
+    },
+  };
+}