docs: generate api docs

twlite · twlite · commit ba7bc22c404d · 2025-06-24T18:51:16.000+05:45
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -39,7 +39,6 @@ git checkout -b your-feature-or-bugfix
 2. Make your changes. Please make sure to use the [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) extension for consistent formatting and comments wherever necessary.
 
 3. Ensure that your changes don't break any existing functionality. You can test the functionality of your code depending on where you've made changes:
-
    1. If you've made changes to the CommandKit package, you can use the "apps/test-bot" project to test your own bot. Just make sure to create a new `.env` file with the template from the `.env.example` file provided. This also requires you to build the commandkit package locally (after you make your changes) because it's symlinked with pnpm workspaces.
    2. If you've made changes to the docs, you can run `pnpm dev` inside "apps/website" to spin up a local development server.
 
diff --git a/apps/website/docs/api-reference/commandkit/classes/app-command-handler.mdx b/apps/website/docs/api-reference/commandkit/classes/app-command-handler.mdx
@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## AppCommandHandler
 
-<GenerationInfo sourceFile="packages/commandkit/src/app/handlers/AppCommandHandler.ts" sourceLine="150" packageName="commandkit" />
+<GenerationInfo sourceFile="packages/commandkit/src/app/handlers/AppCommandHandler.ts" sourceLine="149" packageName="commandkit" />
 
 Handles application commands for CommandKit, including loading, registration, and execution.
 Manages both slash commands and message commands with middleware support.
diff --git a/apps/website/docs/api-reference/commandkit/classes/command-kit.mdx b/apps/website/docs/api-reference/commandkit/classes/command-kit.mdx
@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## CommandKit
 
-<GenerationInfo sourceFile="packages/commandkit/src/CommandKit.ts" sourceLine="92" packageName="commandkit" />
+<GenerationInfo sourceFile="packages/commandkit/src/CommandKit.ts" sourceLine="94" packageName="commandkit" />
 
 The commandkit class that serves as the main entry point for the CommandKit framework.
 
@@ -22,10 +22,11 @@ class CommandKit extends EventEmitter {
     public eventInterceptor!: EventInterceptor;
     public static readonly createElement = createElement;
     public static readonly Fragment = Fragment;
-    public readonly config: CommandKitConfiguration = {
+    public readonly appConfig: CommandKitConfiguration = {
     defaultLocale: Locale.EnglishUS,
     getMessageCommandPrefix: () => '!',
   };
+    public config: ResolvedCommandKitConfig = getConfig();
     public readonly store = new Map<string, any>();
     public readonly flags = new FlagStore();
     public commandsRouter!: CommandsRouter;
@@ -73,11 +74,16 @@ The static createElement function to create jsx elements
 <MemberInfo kind="property" type={``}   />
 
 The static Fragment component to create jsx fragments
-### config
+### appConfig
 
 <MemberInfo kind="property" type={`<a href='/docs/next/api-reference/commandkit/interfaces/command-kit-configuration#commandkitconfiguration'>CommandKitConfiguration</a>`}   />
 
 The configuration for the CommandKit instance.
+### config
+
+<MemberInfo kind="property" type={`<a href='/docs/next/api-reference/commandkit/types/resolved-command-kit-config#resolvedcommandkitconfig'>ResolvedCommandKitConfig</a>`}   />
+
+The configuration for the CommandKit environment.
 ### store
 
 <MemberInfo kind="property" type={``}   />
diff --git a/apps/website/docs/api-reference/commandkit/classes/noop-logger.mdx b/apps/website/docs/api-reference/commandkit/classes/noop-logger.mdx
@@ -0,0 +1,62 @@
+---
+title: "NoopLogger"
+isDefaultIndex: false
+generated: true
+---
+
+import MemberInfo from '@site/src/components/MemberInfo';
+import GenerationInfo from '@site/src/components/GenerationInfo';
+import MemberDescription from '@site/src/components/MemberDescription';
+
+<!-- This file was generated from the CommandKit source. Do not modify. Instead, re-run the "docgen" script -->
+
+
+## NoopLogger
+
+<GenerationInfo sourceFile="packages/commandkit/src/logger/NoopLogger.ts" sourceLine="6" packageName="commandkit" />
+
+Noop logger implementation that does nothing.
+
+```ts title="Signature"
+class NoopLogger implements ILogger {
+    debug(args: any[]) => void;
+    error(args: any[]) => void;
+    log(args: any[]) => void;
+    info(args: any[]) => void;
+    warn(args: any[]) => void;
+}
+```
+* Implements: <code><a href='/docs/next/api-reference/commandkit/interfaces/ilogger#ilogger'>ILogger</a></code>
+
+
+
+<div className="members-wrapper">
+
+### debug
+
+<MemberInfo kind="method" type={`(args: any[]) => void`}   />
+
+Logs a debug message.
+### error
+
+<MemberInfo kind="method" type={`(args: any[]) => void`}   />
+
+Logs an error message.
+### log
+
+<MemberInfo kind="method" type={`(args: any[]) => void`}   />
+
+Logs a default message.
+### info
+
+<MemberInfo kind="method" type={`(args: any[]) => void`}   />
+
+Logs an info message.
+### warn
+
+<MemberInfo kind="method" type={`(args: any[]) => void`}   />
+
+Logs a warning message.
+
+
+</div>
diff --git a/apps/website/docs/api-reference/commandkit/functions/on-application-bootstrap.mdx b/apps/website/docs/api-reference/commandkit/functions/on-application-bootstrap.mdx
@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## onApplicationBootstrap
 
-<GenerationInfo sourceFile="packages/commandkit/src/CommandKit.ts" sourceLine="83" packageName="commandkit" />
+<GenerationInfo sourceFile="packages/commandkit/src/CommandKit.ts" sourceLine="85" packageName="commandkit" />
 
 Registers a bootstrap hook that will be called when the CommandKit instance is created.
 This is useful for plugins that need to run some code after the CommandKit instance is fully initialized.
diff --git a/apps/website/docs/api-reference/commandkit/functions/on-bootstrap.mdx b/apps/website/docs/api-reference/commandkit/functions/on-bootstrap.mdx
@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## onBootstrap
 
-<GenerationInfo sourceFile="packages/commandkit/src/CommandKit.ts" sourceLine="67" packageName="commandkit" />
+<GenerationInfo sourceFile="packages/commandkit/src/CommandKit.ts" sourceLine="69" packageName="commandkit" />
 
 Registers a bootstrap hook that will be called when the CommandKit instance is created.
 This is useful for plugins that need to run some code after the CommandKit instance is fully initialized.
diff --git a/apps/website/docs/api-reference/commandkit/interfaces/command-kit-config.mdx b/apps/website/docs/api-reference/commandkit/interfaces/command-kit-config.mdx
@@ -54,6 +54,7 @@ interface CommandKitConfig {
   };
     typedCommands?: boolean;
     disablePrefixCommands?: boolean;
+    showUnknownPrefixCommandsWarning?: boolean;
 }
 ```
 
@@ -110,6 +111,11 @@ Whether or not to enable the typed commands.
 <MemberInfo kind="property" type={`boolean`} default={`false`}   />
 
 Whether or not to disable the prefix commands.
+### showUnknownPrefixCommandsWarning
+
+<MemberInfo kind="property" type={`boolean`} default={`true`}   />
+
+Whether or not to show a warning when a prefix command is not found. This only affects development mode.
 
 
 </div>
diff --git a/apps/website/docs/api-reference/commandkit/interfaces/command-kit-configuration.mdx b/apps/website/docs/api-reference/commandkit/interfaces/command-kit-configuration.mdx
@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## CommandKitConfiguration
 
-<GenerationInfo sourceFile="packages/commandkit/src/CommandKit.ts" sourceLine="28" packageName="commandkit" />
+<GenerationInfo sourceFile="packages/commandkit/src/CommandKit.ts" sourceLine="30" packageName="commandkit" />
 
 Configurations for the CommandKit instance.
 
diff --git a/apps/website/docs/api-reference/commandkit/interfaces/custom-app-command-props.mdx b/apps/website/docs/api-reference/commandkit/interfaces/custom-app-command-props.mdx
@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## CustomAppCommandProps
 
-<GenerationInfo sourceFile="packages/commandkit/src/app/handlers/AppCommandHandler.ts" sourceLine="53" packageName="commandkit" />
+<GenerationInfo sourceFile="packages/commandkit/src/app/handlers/AppCommandHandler.ts" sourceLine="52" packageName="commandkit" />
 
 Custom properties that can be added to an AppCommand.
 This allows for additional metadata or configuration to be associated with a command.
diff --git a/apps/website/docs/api-reference/commandkit/interfaces/loaded-command.mdx b/apps/website/docs/api-reference/commandkit/interfaces/loaded-command.mdx
@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## LoadedCommand
 
-<GenerationInfo sourceFile="packages/commandkit/src/app/handlers/AppCommandHandler.ts" sourceLine="75" packageName="commandkit" />
+<GenerationInfo sourceFile="packages/commandkit/src/app/handlers/AppCommandHandler.ts" sourceLine="74" packageName="commandkit" />
 
 Represents a loaded command with its metadata and configuration.
 
diff --git a/apps/website/docs/api-reference/commandkit/interfaces/prepared-app-command-execution.mdx b/apps/website/docs/api-reference/commandkit/interfaces/prepared-app-command-execution.mdx
@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## PreparedAppCommandExecution
 
-<GenerationInfo sourceFile="packages/commandkit/src/app/handlers/AppCommandHandler.ts" sourceLine="103" packageName="commandkit" />
+<GenerationInfo sourceFile="packages/commandkit/src/app/handlers/AppCommandHandler.ts" sourceLine="102" packageName="commandkit" />
 
 Represents a prepared command execution with all necessary data and middleware.
 
diff --git a/apps/website/docs/api-reference/commandkit/types/app-command.mdx b/apps/website/docs/api-reference/commandkit/types/app-command.mdx
@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## AppCommand
 
-<GenerationInfo sourceFile="packages/commandkit/src/app/handlers/AppCommandHandler.ts" sourceLine="61" packageName="commandkit" />
+<GenerationInfo sourceFile="packages/commandkit/src/app/handlers/AppCommandHandler.ts" sourceLine="60" packageName="commandkit" />
 
 Represents a command in the CommandKit application, including its metadata and handlers.
 This type extends the native command structure with additional properties.
diff --git a/apps/website/docs/api-reference/commandkit/types/bootstrap-function.mdx b/apps/website/docs/api-reference/commandkit/types/bootstrap-function.mdx
@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## BootstrapFunction
 
-<GenerationInfo sourceFile="packages/commandkit/src/CommandKit.ts" sourceLine="46" packageName="commandkit" />
+<GenerationInfo sourceFile="packages/commandkit/src/CommandKit.ts" sourceLine="48" packageName="commandkit" />
 
 Represents the function executed during the bootstrap phase of CommandKit.
 
diff --git a/apps/website/docs/api-reference/commandkit/types/command-builder-like.mdx b/apps/website/docs/api-reference/commandkit/types/command-builder-like.mdx
@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## CommandBuilderLike
 
-<GenerationInfo sourceFile="packages/commandkit/src/app/handlers/AppCommandHandler.ts" sourceLine="112" packageName="commandkit" />
+<GenerationInfo sourceFile="packages/commandkit/src/app/handlers/AppCommandHandler.ts" sourceLine="111" packageName="commandkit" />
 
 Type representing command builder objects supported by CommandKit.
 
diff --git a/apps/website/docs/api-reference/commandkit/types/command-data-schema-key.mdx b/apps/website/docs/api-reference/commandkit/types/command-data-schema-key.mdx
@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## CommandDataSchemaKey
 
-<GenerationInfo sourceFile="packages/commandkit/src/app/handlers/AppCommandHandler.ts" sourceLine="134" packageName="commandkit" />
+<GenerationInfo sourceFile="packages/commandkit/src/app/handlers/AppCommandHandler.ts" sourceLine="133" packageName="commandkit" />
 
 
 
diff --git a/apps/website/docs/api-reference/commandkit/types/command-data-schema-value.mdx b/apps/website/docs/api-reference/commandkit/types/command-data-schema-value.mdx
@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## CommandDataSchemaValue
 
-<GenerationInfo sourceFile="packages/commandkit/src/app/handlers/AppCommandHandler.ts" sourceLine="135" packageName="commandkit" />
+<GenerationInfo sourceFile="packages/commandkit/src/app/handlers/AppCommandHandler.ts" sourceLine="134" packageName="commandkit" />
 
 
 
diff --git a/apps/website/docs/api-reference/commandkit/types/command-data-schema.mdx b/apps/website/docs/api-reference/commandkit/types/command-data-schema.mdx
@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## CommandDataSchema
 
-<GenerationInfo sourceFile="packages/commandkit/src/app/handlers/AppCommandHandler.ts" sourceLine="133" packageName="commandkit" />
+<GenerationInfo sourceFile="packages/commandkit/src/app/handlers/AppCommandHandler.ts" sourceLine="132" packageName="commandkit" />
 
 
 
diff --git a/apps/website/docs/api-reference/commandkit/types/command-data.mdx b/apps/website/docs/api-reference/commandkit/types/command-data.mdx
@@ -22,6 +22,7 @@ type CommandData = Prettify<
   Omit<RESTPostAPIApplicationCommandsJSONBody, 'description'> & {
     description?: string;
     guilds?: string[];
+    aliases?: string[];
   }
 >
 ```
diff --git a/apps/website/docs/api-reference/commandkit/types/command-type-data.mdx b/apps/website/docs/api-reference/commandkit/types/command-type-data.mdx
@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## CommandTypeData
 
-<GenerationInfo sourceFile="packages/commandkit/src/app/handlers/AppCommandHandler.ts" sourceLine="84" packageName="commandkit" />
+<GenerationInfo sourceFile="packages/commandkit/src/app/handlers/AppCommandHandler.ts" sourceLine="83" packageName="commandkit" />
 
 Type representing command data identifier.
 
diff --git a/apps/website/docs/api-reference/commandkit/types/resolvable-command.mdx b/apps/website/docs/api-reference/commandkit/types/resolvable-command.mdx
@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## ResolvableCommand
 
-<GenerationInfo sourceFile="packages/commandkit/src/app/handlers/AppCommandHandler.ts" sourceLine="89" packageName="commandkit" />
+<GenerationInfo sourceFile="packages/commandkit/src/app/handlers/AppCommandHandler.ts" sourceLine="88" packageName="commandkit" />
 
 Type for commands that can be resolved by the handler.
 
diff --git a/apps/website/docs/api-reference/commandkit/variables/commandkit.mdx b/apps/website/docs/api-reference/commandkit/variables/commandkit.mdx
@@ -13,7 +13,7 @@ import MemberDescription from '@site/src/components/MemberDescription';
 
 ## commandkit
 
-<GenerationInfo sourceFile="packages/commandkit/src/CommandKit.ts" sourceLine="478" packageName="commandkit" />
+<GenerationInfo sourceFile="packages/commandkit/src/CommandKit.ts" sourceLine="488" packageName="commandkit" />
 
 The singleton instance of CommandKit.
 
diff --git a/apps/website/docs/guide/01-getting-started/04-commandkit-config.mdx b/apps/website/docs/guide/01-getting-started/04-commandkit-config.mdx
@@ -109,7 +109,6 @@ export default defineConfig({
 1. **Type Safety**: Always use `commandkit.config.ts` for better type checking and IDE support.
 2. **Security**: Always store sensitive information in `.env` file and make sure it is not committed to your version control system.
 3. **Plugin Management**:
-
    - Only include necessary plugins to keep build times fast
    - Plugins have full access to your discord bot. So always be careful when installing the plugins.
 
diff --git a/apps/website/docs/guide/01-getting-started/05-using-commandkit-cli.mdx b/apps/website/docs/guide/01-getting-started/05-using-commandkit-cli.mdx
@@ -93,13 +93,11 @@ npx commandkit create event ready
 ## Best Practices
 
 1. **Development Workflow**:
-
    - Use `commandkit dev` during development for instant feedback
    - Enable debug mode when troubleshooting issues
    - Keep your `.env` file updated with all required variables
 
 2. **Production Deployment**:
-
    - Always run `commandkit build` before deploying
    - Test the production build locally before deployment
    - Use environment variables for sensitive data
diff --git a/apps/website/docs/guide/04-caching/01-caching-in-commandkit.mdx b/apps/website/docs/guide/04-caching/01-caching-in-commandkit.mdx
@@ -72,13 +72,11 @@ When you call this function multiple times with the same `userId`, it will only
 CommandKit's caching system works by:
 
 1. **Generating a Cache Key**: Each cached function call generates a unique key based on:
-
    - The function's identity
    - The arguments passed to the function
    - A build ID for stability
 
 2. **Storing Results**: When a function is called:
-
    - If the result isn't cached, the function executes and stores its result
    - If the result is cached, it's returned immediately without executing the function
 
@@ -107,19 +105,16 @@ async function fetchUserData(userId: string) {
 ## Best Practices
 
 1. **Choose What to Cache**:
-
    - Cache expensive operations (API calls, database queries)
    - Cache data that doesn't change frequently
    - Don't cache sensitive or frequently changing data
 
 2. **Set Appropriate TTL**:
-
    - Use shorter TTL for frequently changing data
    - Use longer TTL for static data
    - Consider your data's update frequency
 
 3. **Use Tags for Revalidation**:
-
    - Add meaningful tags to your cache entries
    - Group related cache entries with the same tag
    - Use tags for targeted cache invalidation
diff --git a/apps/website/docs/guide/04-caching/02-cacheTag-function.mdx b/apps/website/docs/guide/04-caching/02-cacheTag-function.mdx
@@ -79,13 +79,11 @@ await revalidateTag('user:123');
 ## Best Practices
 
 1. **Use Consistent Naming**:
-
    - Follow a consistent pattern (e.g., `type:id`)
    - Make tags descriptive and meaningful
    - Use hierarchical tags when appropriate
 
 2. **Group Related Data**:
-
    - Tag related cache entries with the same tag
    - Use multiple tags for cross-category entries
    - Consider data relationships when tagging
diff --git a/apps/website/docs/guide/04-caching/03-cacheLife-function.mdx b/apps/website/docs/guide/04-caching/03-cacheLife-function.mdx
@@ -99,13 +99,11 @@ async function fetchData(type: 'frequent' | 'rare') {
 ## Best Practices
 
 1. **Choose Appropriate Duration**:
-
    - Use shorter TTL for frequently changing data
    - Use longer TTL for static content
    - Consider your data update patterns
 
 2. **Balance Freshness and Performance**:
-
    - Don't cache too long if data changes often
    - Don't cache too short if data is static
    - Consider your application's needs
diff --git a/apps/website/docs/guide/04-caching/05-revalidateTag-function.mdx b/apps/website/docs/guide/04-caching/05-revalidateTag-function.mdx
@@ -66,13 +66,11 @@ setInterval(
 ## Best Practices
 
 1. **Strategic Invalidation**:
-
    - Invalidate only what needs to be refreshed
    - Use specific tags for targeted invalidation
    - Consider the impact on performance
 
 2. **Timing**:
-
    - Invalidate after data changes
    - Consider using scheduled revalidation
    - Balance freshness and performance
diff --git a/apps/website/docs/guide/04-caching/06-cleanup-function.mdx b/apps/website/docs/guide/04-caching/06-cleanup-function.mdx
@@ -66,13 +66,11 @@ async function performConservativeCleanup() {
 ## Best Practices
 
 1. **Choose Appropriate Time Period**:
-
    - Consider your application's memory constraints
    - Balance between memory usage and cache effectiveness
    - Monitor cache hit rates
 
 2. **Schedule Regular Cleanup**:
-
    - Set up automated cleanup tasks
    - Choose appropriate intervals
    - Handle cleanup errors gracefully
diff --git a/apps/website/docs/guide/14-useful-utilities/index.mdx b/apps/website/docs/guide/14-useful-utilities/index.mdx
diff --git a/package.json b/package.json
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
