+ 
+ 
-CommandKit is a powerful meta-framework for building Discord bots with [discord.js](https://discord.js.org/). It provides a simple and intuitive API for creating commands, handling interactions, and managing events. With CommandKit, you can focus on building your bot's features without worrying about the underlying complexities.
+CommandKit is a powerful meta-framework for building Discord
+applications with [discord.js](https://discord.js.org/). It provides a
+simple and intuitive API for creating commands, handling interactions,
+and managing events. With CommandKit, you can focus on building your
+Discord application without worrying about the underlying
+complexities.
-## Key Features
+## Key features
- Beginner friendly 🚀
- Suitable for both beginners and advanced users 👶👨💻
-- Slash + context menu commands + prefix commands support ✅
+- Slash + context menu commands + message commands support ✅
- Automatic command registration and updates 🤖
- Command middlewares for easy command management 🛠️
-- Localization support through `@commandkit/i18n` plugin 🌍
-- Plugin system to extend functionality 🔌
+- Localization support through
+ [`@commandkit/i18n`](../05-official-plugins/05-commandkit-i18n.mdx)
+ plugin 🌍
+- Powerful plugin system to extend functionality 🔌
- Built-in command line interface for easy development 🖥️
- Out-of-the-box support for TypeScript and JavaScript 📜
-- Built-in customizable cache system for speedy data storage and retrieval 🗄️
+- Customizable caching using the
+ [`@commandkit/cache`](../05-official-plugins/03-commandkit-cache.mdx)
+ plugin for speedy data fetching 🗄️
- User installable/guild scoped commands 🔧
- Custom events support 🔔
-- JSX support for declaring Discord interaction components and modals 🎨
-- Easy to use interaction components and modals system (forget about collectors) 🧩
+- JSX support for easily managing Discord components 🎨
+- Easy to use interaction components (forget about collectors) 🧩
- Less boilerplate code, more productivity 💪
-- and much more...
+- ...and much more!
-## Documentation
+## Support and suggestions
-You can start with the [setting up CommandKit](./02-setup-commandkit.mdx) guide to get your bot up and running quickly. The documentation covers everything from installation to advanced features.
-
-## Support and Suggestions
-
-Submit any queries or suggestions in our [Discord community](https://ctrl.lol/discord).
+- [GitHub repository](https://github.com/underctrl-io/commandkit)
+- [Discord community](https://ctrl.lol/discord)
diff --git a/apps/website/docs/guide/01-getting-started/02-setup-commandkit.mdx b/apps/website/docs/guide/01-getting-started/02-setup-commandkit.mdx
index f18564ec..61385b82 100644
--- a/apps/website/docs/guide/01-getting-started/02-setup-commandkit.mdx
+++ b/apps/website/docs/guide/01-getting-started/02-setup-commandkit.mdx
@@ -1,19 +1,34 @@
---
title: Setup CommandKit
-description: Setup a new CommandKit project manually, or using the create-commandkit CLI
+description:
+ Setup a new CommandKit project using the create-commandkit CLI
---
-You can quickly setup a new CommandKit project using `create-commandkit` — a command-line utility used for creating new discord.js applications with CommandKit. To get started, run the following command:
+:::info
+
+- CommandKit requires at least [Node.js](https://nodejs.org/) v24
+- This documentation assumes that you have a basic understanding of
+ how to use [discord.js](https://discord.js.org/). If you are new to
+ discord.js, we recommend you to read the
+ [discord.js guide](https://discordjs.guide/) first.
+
+:::
+
+The quickest way to setup a new CommandKit project is to use the
+`create-commandkit` CLI. To get started, run the following command in
+your terminal:
```sh npm2yarn
-npx create-commandkit@latest
+npm create commandkit@next
```
-This will start the CLI in the current directory which will help you quickly setup a base CommandKit project.
+This will start the CLI in an interactive mode. You can follow the
+prompts to setup your project.
## Project structure
-By using the CLI to create a base project, you should get a project structure that looks like this:
+By using the CLI to create a base project, you should get a file tree
+that looks something like this:
```
.
@@ -32,41 +47,46 @@ By using the CLI to create a base project, you should get a project structure th
└── tsconfig.json
```
-:::info
-The `src/app.ts` file is the main entry point for your application. This file default exports the discord.js client which CommandKit loads at runtime. For example, the `src/app.ts` file looks like this:
+## Entry point
+
+The `src/app.ts` file is the main entry point for your application.
+This file default exports the discord.js client instance which
+CommandKit loads at runtime.
-```ts
+```ts title="src/app.ts"
import { Client } from 'discord.js';
const client = new Client({
- intents: [
- /* add stuff */
- ],
+ intents: ['Guilds', 'GuildMessages', 'MessageContent'],
});
-// setting up the token manually
+// Optional: Setting up the token manually
client.token = process.env.MY_BOT_TOKEN;
export default client;
```
-Notice how we are not calling `client.login()` in this file. This is because CommandKit will automatically call `client.login()` for you when the application starts.
+Notice how there's no `client.login()` in this file. This is because
+CommandKit will automatically handle the login process for you when
+the application starts.
-Also, you might have noticed that we are not using anything from CommandKit in this file. This is because CommandKit is designed to reduce boilerplate code and make it easier to build discord bot applications.
-:::
+## Development version
-:::info
-The `src/app` directory is a special directory that CommandKit understands. All the commands and events in this directory will be automatically registered when the application starts.
-:::
+If you would like to try the latest development builds, you can use
+the `@dev` tag like so:
-## Development version
+```sh npm2yarn
+npm create commandkit@dev
+```
:::warning
+
The development version is likely to have bugs.
+
:::
-If you'd like to try the latest development builds, you can use the `@dev` tag like so:
+## Manual setup
-```sh npm2yarn
-npx create-commandkit@dev
-```
+Alternatively, if you would like to setup a new CommandKit project
+manually, you can follow
+[this guide](../08-advanced/01-setup-commandkit-manually.mdx).
diff --git a/apps/website/docs/guide/01-getting-started/03-setup-commandkit-manually.mdx b/apps/website/docs/guide/01-getting-started/03-setup-commandkit-manually.mdx
deleted file mode 100644
index 710637f6..00000000
--- a/apps/website/docs/guide/01-getting-started/03-setup-commandkit-manually.mdx
+++ /dev/null
@@ -1,125 +0,0 @@
----
-title: Setup CommandKit manually
-description: Learn how to install CommandKit.
----
-
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
-
-If you don't want to use the CLI to automatically generate a base CommandKit project, you can integrate CommandKit manually into your application.
-
-:::info
-While this guide primarily uses TypeScript, you can alternatively use JavaScript files to follow along if that's what you're comfortable with (e.g. `commandkit.config.js`, `app.js`, etc)
-:::
-
-## Configuration file
-
-To get started, create a file called `commandkit.config.ts` at the root of your project. This file is used to configure CommandKit and its plugins.
-
-```ts title="commandkit.config.ts"
-import { defineConfig } from 'commandkit';
-
-export default defineConfig({});
-```
-
-## Entrypoint file
-
-Then, create a folder called `src`, followed by a file called `app.ts` inside it. The file should look like this:
-
-```ts title="src/app.ts"
-import { Client } from 'discord.js';
-
-const client = new Client({
- intents: ['Guilds', 'GuildMembers'],
-});
-
-client.token = '...'; // Optional: You can manually set your bot's token
-
-// must export the `client` here
-export default client;
-```
-
-With the current entrypoint file created, it's important to understand that:
-
-1. The `app.ts` file is the entrypoint for this application. This file **must** export your discord.js client instance.
-2. You don't have to call `client.login()` as CommandKit will handle that for you.
-3. You should store your bot token as an environment variable with either `DISCORD_TOKEN` or `TOKEN` as the name.
-
-## Adding commands
-
-To add a command, create a folder inside the `src/app` directory called `commands` and create your command file (e.g. `ping.ts`). This example will use a simple ping/pong command which will register as a chat input (slash) and message (legacy) command.
-
-```ts title="src/app/commands/ping.ts"
-import type { ChatInputCommand, CommandData, MessageCommand } from 'commandkit';
-
-export const command: CommandData = {
- name: 'ping',
- description: 'Pong!',
-};
-
-export const chatInput: ChatInputCommand = async ({ interaction }) => {
- await interaction.reply('Pong!');
-};
-
-export const message: MessageCommand = async ({ message }) => {
- await message.reply('Pong!');
-};
-```
-
-This command will reply with "Pong!" when the user runs the `/ping` slash command, or sends `!ping` in the chat.
-
-:::tip
-Prefixes for your message (legacy) commands can be changed. Learn more [here](/docs/next/guide/resolve-message-commands-prefix).
-:::
-
-## Adding events
-
-To register and handle events emitted by discord.js, create a folder inside the `src/app` directory called `events` and create a folder with the name of the discord.js event you'd like to handle (e.g. ready, messageCreate, etc). This example will use the `ready` event.
-
-In the `src/app/events/{eventName}` directory, you can create files which will export default functions that will be called when the respective event is emitted by discord.js. Following the `ready` event example mentioned above, you may want to log when your bot comes online. The function for that will look like so:
-
-```ts title="src/app/events/log.ts"
-import type { Client } from 'discord.js';
-
-export default function (client: Client
+
+## Troubleshooting
+
+### Port already in use
+
+If port `4356` is already in use, you can specify a different port in
+the configuration:
+
+```ts
+devtools({ port: 4357 });
+```
+
+### Interface not loading
+
+Ensure that:
+
+1. The devtools plugin is properly configured
+2. Your application is running in development mode
+3. No firewall is blocking the specified port
+4. You're accessing the correct URL (`http://localhost:4356`)
+
+### Performance issues
+
+If you experience performance issues:
+
+1. Disable unnecessary features in the configuration
+2. Reduce logging verbosity
+3. Consider using a different port
+
+## Feedback and contributions
+
+As this plugin is in early development, your feedback is valuable for
+improving the devtools experience. Please report issues, suggest
+features, or contribute to the development through:
+
+- [GitHub Issues](https://github.com/underctrl-io/commandkit/issues)
+- [Discord Community](https://ctrl.lol/discord)
diff --git a/apps/website/docs/guide/05-official-plugins/05-commandkit-i18n.mdx b/apps/website/docs/guide/05-official-plugins/05-commandkit-i18n.mdx
new file mode 100644
index 00000000..9167bbb2
--- /dev/null
+++ b/apps/website/docs/guide/05-official-plugins/05-commandkit-i18n.mdx
@@ -0,0 +1,901 @@
+---
+title: '@commandkit/i18n'
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+The `@commandkit/i18n` plugin integrates
+[i18next](https://www.i18next.com/) into CommandKit, enabling you to
+create multilingual Discord bots that automatically adapt to your
+users' preferred languages. This plugin provides seamless
+internationalization support for commands, events, and all bot
+interactions.
+
+## Features
+
+- **Automatic locale detection** - Automatically uses Discord's guild
+ preferred locale
+- **Easy setup** - Simple configuration with sensible defaults
+- **File-based translations** - Organize translations in JSON files
+- **Context-aware** - Access translations in commands, events, and
+ legacy handlers
+- **i18next ecosystem** - Full compatibility with i18next plugins and
+ features
+- **Command metadata localization** - Localize command names,
+ descriptions, and options
+
+## Installation
+
+```sh npm2yarn
+npm install @commandkit/i18n
+```
+
+## Basic setup
+
+Add the i18n plugin to your CommandKit configuration:
+
+```ts title="commandkit.config.ts"
+import { defineConfig } from 'commandkit';
+import { i18n } from '@commandkit/i18n';
+
+export default defineConfig({
+ plugins: [i18n()],
+});
+```
+
+## Advanced configuration
+
+You can customize the i18n plugin by passing options to it:
+
+```ts title="commandkit.config.ts"
+import { defineConfig } from 'commandkit';
+import { i18n } from '@commandkit/i18n';
+
+export default defineConfig({
+ plugins: [
+ i18n({
+ plugins: [someI18nextPlugin],
+ // Add other i18next configuration options as needed
+ }),
+ ],
+});
+```
+
+## Translation files structure
+
+Create a `locales` directory inside your `src/app` folder with
+subdirectories for each language. Each language directory should
+contain JSON files for your translations.
+
+```
+src
+└── app
+ ├── locales
+ │ ├── en-US
+ │ │ └── ping.json
+ │ │ └── messageCreate.event.json
+ │ └── fr
+ │ └── ping.json
+ │ └── messageCreate.event.json
+ ├── commands
+ │ ├── ping.ts
+ │ └── help.ts
+ └── events
+ └── messageCreate
+ └── handler.ts
+```
+
+### Supported locales
+
+CommandKit uses Discord's locale identifiers. Please refer to
+[Discord's Locales documentation](https://discord.com/developers/docs/reference#locales)
+for a complete list.
+
+## Quick start example
+
+Here's a complete example to get you started:
+
+1. **Configure the plugin**:
+
+```ts title="commandkit.config.ts"
+import { defineConfig } from 'commandkit';
+import { i18n } from '@commandkit/i18n';
+
+export default defineConfig({
+ plugins: [i18n()],
+});
+```
+
+2. **Create translation files**:
+
+```json title="src/app/locales/en-US/ping.json"
+{
+ "$command": {
+ "name": "ping",
+ "description": "Check the bot's latency"
+ },
+ "response": "🏓 Pong! Latency: **{{latency}}ms**"
+}
+```
+
+```json title="src/app/locales/fr/ping.json"
+{
+ "$command": {
+ "name": "ping",
+ "description": "Vérifier la latence du bot"
+ },
+ "response": "🏓 Pong! Latence: **{{latency}}ms**"
+}
+```
+
+3. **Use translations in your command**:
+
+```ts title="src/app/commands/ping.ts"
+import type { ChatInputCommand, CommandData } from 'commandkit';
+
+export const command: CommandData = {
+ name: 'ping',
+ description: "Check the bot's latency",
+};
+
+export const chatInput: ChatInputCommand = async (ctx) => {
+ const { t } = ctx.locale();
+
+ await ctx.interaction.reply({
+ content: t('response', { latency: ctx.client.ws.ping }),
+ });
+};
+```
+
+That's it! Your bot will now automatically respond in the user's guild
+preferred language.
+
+## Commands localization
+
+CommandKit's i18n plugin provides powerful localization features for
+chat input commands, allowing you to translate command metadata
+(names, descriptions, options) and responses to match your users'
+preferred languages.
+
+### Translation file structure
+
+Translation files should be placed in your `locales` directory and
+named after the command they translate. For example, translations for
+a `ping` command should be in `ping.json`.
+
+#### Basic translation file
+
+```json title="src/app/locales/en-US/ping.json"
+{
+ "response": "🏓 Pong! Latency: **{{latency}}ms**",
+ "error": "❌ Failed to ping the server",
+ "database_response": "📊 Database latency: **{{dbLatency}}ms**"
+}
+```
+
+#### Command metadata localization
+
+Use the special `$command` key to localize command metadata that
+appears in Discord's interface:
+
+```json title="src/app/locales/en-US/ping.json"
+{
+ "$command": {
+ "name": "ping",
+ "description": "Check the bot's latency and response time",
+ "options": [
+ {
+ "name": "database",
+ "description": "Also check database connection latency"
+ },
+ {
+ "name": "target",
+ "description": "Specify a target server to ping",
+ "choices": [
+ {
+ "name": "Main Server",
+ "value": "main"
+ },
+ {
+ "name": "Backup Server",
+ "value": "backup"
+ }
+ ]
+ }
+ ]
+ },
+ "response": "🏓 Pong! Latency: **{{latency}}ms**",
+ "database_response": "📊 Database latency: **{{dbLatency}}ms**"
+}
+```
+
+The `$command` object structure mirrors Discord's application command
+structure:
+
+- `name`: Command name (shown in Discord's command picker)
+- `description`: Command description (shown in Discord's command
+ picker)
+- `options`: Array of option localizations
+ - `name`: Option name
+ - `description`: Option description
+ - `choices`: Array of choice localizations (for string options with
+ predefined choices)
+
+### Using translations in commands
+
+The `locale()` function in your command context provides access to
+translations and i18next features:
+
+```ts title="src/app/commands/ping.ts"
+import type { ChatInputCommand } from 'commandkit';
+
+export const chatInput: ChatInputCommand = async (ctx) => {
+ // Get translation function and i18next instance for the current guild's locale
+ const { t, i18n } = ctx.locale();
+
+ const latency = ctx.client.ws.ping;
+
+ // Use the translation function with interpolation
+ await ctx.interaction.reply({
+ content: t('response', { latency }),
+ ephemeral: true,
+ });
+};
+```
+
+#### Manual locale override
+
+You can specify a particular locale instead of using the guild's
+preferred locale:
+
+```ts
+export const chatInput: ChatInputCommand = async (ctx) => {
+ // Force French locale
+ const { t } = ctx.locale('fr');
+
+ await ctx.interaction.reply({
+ content: t('response', { latency: ctx.client.ws.ping }),
+ });
+};
+```
+
+### Advanced translation features
+
+#### Pluralization
+
+i18next supports automatic pluralization:
+
+```json title="locales/en-US/user.json"
+{
+ "member_count": "{{count}} member",
+ "member_count_plural": "{{count}} members"
+}
+```
+
+```ts
+const { t } = ctx.locale();
+const memberCount = guild.memberCount;
+
+// Automatically chooses singular or plural form
+const message = t('member_count', { count: memberCount });
+```
+
+#### Nested Translations
+
+Organize translations using nested objects:
+
+```json title="locales/en-US/errors.json"
+{
+ "validation": {
+ "required": "This field is required",
+ "invalid_format": "Invalid format provided",
+ "too_long": "Input is too long (max {{max}} characters)"
+ },
+ "permissions": {
+ "insufficient": "You don't have permission to use this command",
+ "missing_role": "You need the {{role}} role to use this command"
+ }
+}
+```
+
+```ts
+const { t } = ctx.locale();
+
+// Access nested translations with dot notation
+await ctx.interaction.reply({
+ content: t('errors.permissions.insufficient'),
+ ephemeral: true,
+});
+```
+
+#### Context and Namespaces
+
+Use different translation contexts for better organization:
+
+```ts
+const { t } = ctx.locale();
+
+// Default namespace (command file name)
+t('response');
+
+// Specific namespace
+t('common:greeting', { name: user.displayName });
+
+// Multiple namespaces
+t(['errors:validation.required', 'common:error']);
+```
+
+## Events localization
+
+Event handlers in CommandKit can also benefit from localization,
+allowing you to create multilingual responses and messages for various
+Discord events like message creation, member joins, and more.
+
+### Using translations in event handlers
+
+Since event handlers don't have the same context as commands, you need
+to import the `locale` function directly from the i18n plugin:
+
+```ts title="src/app/events/messageCreate/handler.ts"
+import { locale } from '@commandkit/i18n';
+import type { Message } from 'discord.js';
+
+export default async function onMessageCreate(message: Message) {
+ // Skip bot messages
+ if (message.author.bot) return;
+
+ // Get translations for the guild's preferred locale
+ const { t } = locale(message.guild?.preferredLocale);
+
+ if (message.content.toLowerCase() === 'hello') {
+ await message.reply(
+ t('greeting', { user: message.author.displayName }),
+ );
+ }
+
+ if (message.content.toLowerCase() === 'help') {
+ await message.reply(t('help_message'));
+ }
+}
+```
+
+### Event translation files
+
+Create translation files for your events using descriptive names:
+
+```json title="src/app/locales/en-US/messageCreate.event.json"
+{
+ "greeting": "👋 Hello {{user}}! Welcome to our server!",
+ "help_message": "📖 Use `/help` to see all available commands",
+ "auto_mod": {
+ "warning": "⚠️ {{user}}, please watch your language!",
+ "timeout": "🔇 {{user}} has been timed out for inappropriate language"
+ }
+}
+```
+
+```json title="src/app/locales/fr/messageCreate.event.json"
+{
+ "greeting": "👋 Salut {{user}} ! Bienvenue sur notre serveur !",
+ "help_message": "📖 Utilisez `/help` pour voir toutes les commandes disponibles",
+ "auto_mod": {
+ "warning": "⚠️ {{user}}, attention à votre langage !",
+ "timeout": "🔇 {{user}} a été mis en sourdine pour langage inapproprié"
+ }
+}
+```
+
+### Advanced event localization
+
+#### Guild welcome messages
+
+```ts title="src/app/events/guildMemberAdd/handler.ts"
+import { locale } from '@commandkit/i18n';
+import type { GuildMember } from 'discord.js';
+
+export default async function onGuildMemberAdd(member: GuildMember) {
+ const { t } = locale(member.guild.preferredLocale);
+
+ // Find welcome channel
+ const welcomeChannel = member.guild.channels.cache.find(
+ (channel) => channel.name === 'welcome',
+ );
+
+ if (welcomeChannel?.isTextBased()) {
+ const memberCount = member.guild.memberCount;
+
+ await welcomeChannel.send({
+ content: t('welcome.message', {
+ user: member.displayName,
+ guild: member.guild.name,
+ count: memberCount,
+ }),
+ // You can also send embeds with localized content
+ embeds: [
+ {
+ title: t('welcome.embed.title'),
+ description: t('welcome.embed.description', {
+ user: member.displayName,
+ }),
+ color: 0x00ff00,
+ fields: [
+ {
+ name: t('welcome.embed.fields.rules'),
+ value: t('welcome.embed.fields.rules_description'),
+ },
+ {
+ name: t('welcome.embed.fields.channels'),
+ value: t('welcome.embed.fields.channels_description'),
+ },
+ ],
+ },
+ ],
+ });
+ }
+}
+```
+
+```json title="src/app/locales/en-US/guildMemberAdd.event.json"
+{
+ "welcome": {
+ "message": "🎉 Welcome {{user}} to **{{guild}}**! You're our **{{count}}** member!",
+ "embed": {
+ "title": "Welcome to the Server!",
+ "description": "Hi {{user}}, we're glad to have you here!",
+ "fields": {
+ "rules": "📋 Rules",
+ "rules_description": "Please read our rules in #rules channel",
+ "channels": "💬 Important Channels",
+ "channels_description": "Check out #announcements and #general"
+ }
+ }
+ }
+}
+```
+
+#### Locale detection strategies
+
+When working with events, you have several options for determining the
+appropriate locale:
+
+##### 1. Guild preferred locale (recommended)
+
+```ts
+// Use the guild's preferred locale set by server admins
+const { t } = locale(message.guild?.preferredLocale);
+```
+
+##### 2. User locale
+
+```ts
+// Use the individual user's Discord locale
+const { t } = locale(message.author.locale);
+```
+
+##### 3. Fallback chain
+
+```ts
+// Try multiple locale sources with fallback
+const detectedLocale =
+ message.guild?.preferredLocale || message.author.locale || 'en-US';
+
+const { t } = locale(detectedLocale);
+```
+
+##### 4. Custom locale detection
+
+```ts
+async function detectLocale(message: Message): Promise+
The discord.js meta-framework for building powerful, modular, and extensible Discord bots with ease.
Guide
API Reference
diff --git a/apps/website/src/plugins/llms-txt.js b/apps/website/src/plugins/llms-txt.js
index e1ac3378..e07e3ff0 100644
--- a/apps/website/src/plugins/llms-txt.js
+++ b/apps/website/src/plugins/llms-txt.js
@@ -2,6 +2,14 @@ const path = require('path');
const fs = require('fs');
const matter = require('gray-matter');
+const DOCS_URL = 'https://commandkit.dev/docs/guide';
+
+const removeNumericPrefix = (path) => {
+ // 01-getting-started/01-introduction -> getting-started/introduction
+ const segments = path.split('/');
+ return segments.map((segment) => segment.replace(/^\d+\-/, '')).join('/');
+};
+
module.exports = function (context) {
return {
name: 'llms-txt-plugin',
@@ -16,7 +24,8 @@ module.exports = function (context) {
if (!fs.existsSync(dir)) return;
// skip versioned docs
- if (dir.includes(versionedDocsDir)) return;
+ // TODO: remove guide.old
+ if (dir.includes(versionedDocsDir) || dir.includes('guide.old')) return;
const entries = await fs.promises.readdir(dir, { withFileTypes: true });
diff --git a/package.json b/package.json
index 072ade2f..9003aa8f 100644
--- a/package.json
+++ b/package.json
@@ -9,12 +9,11 @@
],
"scripts": {
"bootstrap": "turbo gen bootstrap --args",
- "lint": "turbo run --filter=\"./packages/*\" lint",
+ "check-types": "turbo run --filter=\"./packages/*\" check-types",
"build": "turbo run --filter=\"./packages/*\" build",
- "publish-package": "pnpm publish-package",
- "build-docs": "pnpm run --filter=\"./apps/website\" build",
- "docgen": "tsx ./scripts/docs/generate-typescript-docs.ts && pnpm format",
- "format": "prettier --experimental-cli --write ./ --ignore-path=.prettierignore"
+ "docgen": "tsx ./scripts/docs/generate-typescript-docs.ts && pnpm prettier:format",
+ "prettier:check": "prettier --check . --ignore-path=.prettierignore",
+ "prettier:format": "prettier --write . --ignore-path=.prettierignore"
},
"devDependencies": {
"@types/node": "^22.10.2",
diff --git a/packages/ai/package.json b/packages/ai/package.json
index 608ea632..e97c3e69 100644
--- a/packages/ai/package.json
+++ b/packages/ai/package.json
@@ -8,7 +8,7 @@
"main": "dist/index.js",
"types": "dist/index.d.ts",
"scripts": {
- "lint": "tsc --noEmit",
+ "check-types": "tsc --noEmit",
"build": "tsc"
},
"repository": {
diff --git a/packages/analytics/package.json b/packages/analytics/package.json
index e78b77b6..8f6a9130 100644
--- a/packages/analytics/package.json
+++ b/packages/analytics/package.json
@@ -16,7 +16,7 @@
}
},
"scripts": {
- "lint": "tsc --noEmit",
+ "check-types": "tsc --noEmit",
"build": "tsc"
},
"repository": {
diff --git a/packages/cache/package.json b/packages/cache/package.json
index 4c4c35ac..473e38e6 100644
--- a/packages/cache/package.json
+++ b/packages/cache/package.json
@@ -8,7 +8,7 @@
"dist"
],
"scripts": {
- "lint": "tsc --noEmit",
+ "check-types": "tsc --noEmit",
"build": "tsc"
},
"repository": {
diff --git a/packages/commandkit/package.json b/packages/commandkit/package.json
index a753c915..cd7a411b 100644
--- a/packages/commandkit/package.json
+++ b/packages/commandkit/package.json
@@ -146,10 +146,9 @@
}
},
"scripts": {
- "lint": "tsc --noEmit",
+ "check-types": "tsc --noEmit",
"dev": "pnpm run --filter=test-bot dev",
"build": "tsdown",
- "publish-package": "npm publish",
"test": "vitest"
},
"repository": {
diff --git a/packages/commandkit/src/app/router/CommandsRouter.ts b/packages/commandkit/src/app/router/CommandsRouter.ts
index 1a4edd1d..1185724b 100644
--- a/packages/commandkit/src/app/router/CommandsRouter.ts
+++ b/packages/commandkit/src/app/router/CommandsRouter.ts
@@ -270,7 +270,7 @@ export class CommandsRouter {
parentPath: entry.parentPath,
global: GLOBAL_MIDDLEWARE_PATTERN.test(name),
command: COMMAND_MIDDLEWARE_PATTERN.test(name)
- ? name.split('.')[0] || null
+ ? name.match(COMMAND_MIDDLEWARE_PATTERN)?.[1] || null
: null,
};
diff --git a/packages/commandkit/src/cli/build.ts b/packages/commandkit/src/cli/build.ts
index e5ba0899..ac61b774 100644
--- a/packages/commandkit/src/cli/build.ts
+++ b/packages/commandkit/src/cli/build.ts
@@ -131,7 +131,7 @@ export async function buildApplication({
env: mergeDefinitionsIfNeeded(config.env || {}, !!isDev),
entry: Array.from(
new Set([
- 'src',
+ 'src/**/*.{js,cjs,mjs,ts,cts,mts,jsx,tsx}',
`!${config.distDir}`,
'!.commandkit',
'!**/*.test.*',
diff --git a/packages/commandkit/src/types.ts b/packages/commandkit/src/types.ts
index d192d5f3..4681e306 100644
--- a/packages/commandkit/src/types.ts
+++ b/packages/commandkit/src/types.ts
@@ -1,6 +1,7 @@
-import {
+import type {
CacheType,
Client,
+ ClientEvents,
Interaction,
RESTPostAPIApplicationCommandsJSONBody,
} from 'discord.js';
@@ -51,3 +52,10 @@ export type CommandData = Prettify<
aliases?: string[];
}
>;
+
+/**
+ * Represents an event handler for a specific event.
+ */
+export type EventHandler = (
+ ...args: ClientEvents[K]
+) => void | Promise;
diff --git a/packages/commandkit/tsdown.config.mts b/packages/commandkit/tsdown.config.mts
index 74317a2c..3607b260 100644
--- a/packages/commandkit/tsdown.config.mts
+++ b/packages/commandkit/tsdown.config.mts
@@ -5,7 +5,7 @@ const macro = new MacroTransformer();
export default defineConfig({
format: ['cjs'],
- entry: ['src'],
+ entry: ['src/**/*.ts'],
outDir: './dist',
sourcemap: true,
watch: false,
diff --git a/packages/create-commandkit/package.json b/packages/create-commandkit/package.json
index b7d0a857..9ced6c09 100644
--- a/packages/create-commandkit/package.json
+++ b/packages/create-commandkit/package.json
@@ -28,10 +28,9 @@
},
"homepage": "https://commandkit.dev",
"scripts": {
- "lint": "tsc --noEmit",
+ "check-types": "tsc --noEmit",
"dev": "tsc --watch",
- "build": "tsc",
- "publish-package": "npm publish"
+ "build": "tsc"
},
"dependencies": {
"@clack/prompts": "^0.11.0",
diff --git a/packages/devtools-ui/src/routeTree.gen.ts b/packages/devtools-ui/src/routeTree.gen.ts
index b04d4dc9..60e6c915 100644
--- a/packages/devtools-ui/src/routeTree.gen.ts
+++ b/packages/devtools-ui/src/routeTree.gen.ts
@@ -8,81 +8,81 @@
// You should NOT make any changes in this file as it will be overwritten.
// Additionally, you should also exclude this file from your linter and/or formatter to prevent it from being checked or modified.
-import { Route as rootRouteImport } from './routes/__root';
-import { Route as PluginsRouteImport } from './routes/plugins';
-import { Route as GuildsRouteImport } from './routes/guilds';
-import { Route as FeatureFlagsRouteImport } from './routes/feature-flags';
-import { Route as EventsRouteImport } from './routes/events';
-import { Route as CommandsRouteImport } from './routes/commands';
-import { Route as IndexRouteImport } from './routes/index';
+import { Route as rootRouteImport } from './routes/__root'
+import { Route as PluginsRouteImport } from './routes/plugins'
+import { Route as GuildsRouteImport } from './routes/guilds'
+import { Route as FeatureFlagsRouteImport } from './routes/feature-flags'
+import { Route as EventsRouteImport } from './routes/events'
+import { Route as CommandsRouteImport } from './routes/commands'
+import { Route as IndexRouteImport } from './routes/index'
const PluginsRoute = PluginsRouteImport.update({
id: '/plugins',
path: '/plugins',
getParentRoute: () => rootRouteImport,
-} as any);
+} as any)
const GuildsRoute = GuildsRouteImport.update({
id: '/guilds',
path: '/guilds',
getParentRoute: () => rootRouteImport,
-} as any);
+} as any)
const FeatureFlagsRoute = FeatureFlagsRouteImport.update({
id: '/feature-flags',
path: '/feature-flags',
getParentRoute: () => rootRouteImport,
-} as any);
+} as any)
const EventsRoute = EventsRouteImport.update({
id: '/events',
path: '/events',
getParentRoute: () => rootRouteImport,
-} as any);
+} as any)
const CommandsRoute = CommandsRouteImport.update({
id: '/commands',
path: '/commands',
getParentRoute: () => rootRouteImport,
-} as any);
+} as any)
const IndexRoute = IndexRouteImport.update({
id: '/',
path: '/',
getParentRoute: () => rootRouteImport,
-} as any);
+} as any)
export interface FileRoutesByFullPath {
- '/': typeof IndexRoute;
- '/commands': typeof CommandsRoute;
- '/events': typeof EventsRoute;
- '/feature-flags': typeof FeatureFlagsRoute;
- '/guilds': typeof GuildsRoute;
- '/plugins': typeof PluginsRoute;
+ '/': typeof IndexRoute
+ '/commands': typeof CommandsRoute
+ '/events': typeof EventsRoute
+ '/feature-flags': typeof FeatureFlagsRoute
+ '/guilds': typeof GuildsRoute
+ '/plugins': typeof PluginsRoute
}
export interface FileRoutesByTo {
- '/': typeof IndexRoute;
- '/commands': typeof CommandsRoute;
- '/events': typeof EventsRoute;
- '/feature-flags': typeof FeatureFlagsRoute;
- '/guilds': typeof GuildsRoute;
- '/plugins': typeof PluginsRoute;
+ '/': typeof IndexRoute
+ '/commands': typeof CommandsRoute
+ '/events': typeof EventsRoute
+ '/feature-flags': typeof FeatureFlagsRoute
+ '/guilds': typeof GuildsRoute
+ '/plugins': typeof PluginsRoute
}
export interface FileRoutesById {
- __root__: typeof rootRouteImport;
- '/': typeof IndexRoute;
- '/commands': typeof CommandsRoute;
- '/events': typeof EventsRoute;
- '/feature-flags': typeof FeatureFlagsRoute;
- '/guilds': typeof GuildsRoute;
- '/plugins': typeof PluginsRoute;
+ __root__: typeof rootRouteImport
+ '/': typeof IndexRoute
+ '/commands': typeof CommandsRoute
+ '/events': typeof EventsRoute
+ '/feature-flags': typeof FeatureFlagsRoute
+ '/guilds': typeof GuildsRoute
+ '/plugins': typeof PluginsRoute
}
export interface FileRouteTypes {
- fileRoutesByFullPath: FileRoutesByFullPath;
+ fileRoutesByFullPath: FileRoutesByFullPath
fullPaths:
| '/'
| '/commands'
| '/events'
| '/feature-flags'
| '/guilds'
- | '/plugins';
- fileRoutesByTo: FileRoutesByTo;
- to: '/' | '/commands' | '/events' | '/feature-flags' | '/guilds' | '/plugins';
+ | '/plugins'
+ fileRoutesByTo: FileRoutesByTo
+ to: '/' | '/commands' | '/events' | '/feature-flags' | '/guilds' | '/plugins'
id:
| '__root__'
| '/'
@@ -90,62 +90,62 @@ export interface FileRouteTypes {
| '/events'
| '/feature-flags'
| '/guilds'
- | '/plugins';
- fileRoutesById: FileRoutesById;
+ | '/plugins'
+ fileRoutesById: FileRoutesById
}
export interface RootRouteChildren {
- IndexRoute: typeof IndexRoute;
- CommandsRoute: typeof CommandsRoute;
- EventsRoute: typeof EventsRoute;
- FeatureFlagsRoute: typeof FeatureFlagsRoute;
- GuildsRoute: typeof GuildsRoute;
- PluginsRoute: typeof PluginsRoute;
+ IndexRoute: typeof IndexRoute
+ CommandsRoute: typeof CommandsRoute
+ EventsRoute: typeof EventsRoute
+ FeatureFlagsRoute: typeof FeatureFlagsRoute
+ GuildsRoute: typeof GuildsRoute
+ PluginsRoute: typeof PluginsRoute
}
declare module '@tanstack/react-router' {
interface FileRoutesByPath {
'/plugins': {
- id: '/plugins';
- path: '/plugins';
- fullPath: '/plugins';
- preLoaderRoute: typeof PluginsRouteImport;
- parentRoute: typeof rootRouteImport;
- };
+ id: '/plugins'
+ path: '/plugins'
+ fullPath: '/plugins'
+ preLoaderRoute: typeof PluginsRouteImport
+ parentRoute: typeof rootRouteImport
+ }
'/guilds': {
- id: '/guilds';
- path: '/guilds';
- fullPath: '/guilds';
- preLoaderRoute: typeof GuildsRouteImport;
- parentRoute: typeof rootRouteImport;
- };
+ id: '/guilds'
+ path: '/guilds'
+ fullPath: '/guilds'
+ preLoaderRoute: typeof GuildsRouteImport
+ parentRoute: typeof rootRouteImport
+ }
'/feature-flags': {
- id: '/feature-flags';
- path: '/feature-flags';
- fullPath: '/feature-flags';
- preLoaderRoute: typeof FeatureFlagsRouteImport;
- parentRoute: typeof rootRouteImport;
- };
+ id: '/feature-flags'
+ path: '/feature-flags'
+ fullPath: '/feature-flags'
+ preLoaderRoute: typeof FeatureFlagsRouteImport
+ parentRoute: typeof rootRouteImport
+ }
'/events': {
- id: '/events';
- path: '/events';
- fullPath: '/events';
- preLoaderRoute: typeof EventsRouteImport;
- parentRoute: typeof rootRouteImport;
- };
+ id: '/events'
+ path: '/events'
+ fullPath: '/events'
+ preLoaderRoute: typeof EventsRouteImport
+ parentRoute: typeof rootRouteImport
+ }
'/commands': {
- id: '/commands';
- path: '/commands';
- fullPath: '/commands';
- preLoaderRoute: typeof CommandsRouteImport;
- parentRoute: typeof rootRouteImport;
- };
+ id: '/commands'
+ path: '/commands'
+ fullPath: '/commands'
+ preLoaderRoute: typeof CommandsRouteImport
+ parentRoute: typeof rootRouteImport
+ }
'/': {
- id: '/';
- path: '/';
- fullPath: '/';
- preLoaderRoute: typeof IndexRouteImport;
- parentRoute: typeof rootRouteImport;
- };
+ id: '/'
+ path: '/'
+ fullPath: '/'
+ preLoaderRoute: typeof IndexRouteImport
+ parentRoute: typeof rootRouteImport
+ }
}
}
@@ -156,7 +156,7 @@ const rootRouteChildren: RootRouteChildren = {
FeatureFlagsRoute: FeatureFlagsRoute,
GuildsRoute: GuildsRoute,
PluginsRoute: PluginsRoute,
-};
+}
export const routeTree = rootRouteImport
._addFileChildren(rootRouteChildren)
- ._addFileTypes();
+ ._addFileTypes()
diff --git a/packages/devtools/package.json b/packages/devtools/package.json
index 8f27cce9..4965cf40 100644
--- a/packages/devtools/package.json
+++ b/packages/devtools/package.json
@@ -5,7 +5,7 @@
"main": "dist/index.js",
"types": "dist/index.d.ts",
"scripts": {
- "lint": "tsc --noEmit",
+ "check-types": "tsc --noEmit",
"build:ui": "pnpm --filter=@commandkit/devtools-ui build",
"copy-ui": "node -e \"require('node:fs').cpSync('../devtools-ui/dist', './ui', {recursive:true})\"",
"build": "pnpm run build:ui && pnpm run copy-ui && pnpm run build:server",
diff --git a/packages/i18n/package.json b/packages/i18n/package.json
index 9a83155d..8e72f76f 100644
--- a/packages/i18n/package.json
+++ b/packages/i18n/package.json
@@ -8,7 +8,7 @@
"dist"
],
"scripts": {
- "lint": "tsc --noEmit",
+ "check-types": "tsc --noEmit",
"build": "tsc"
},
"repository": {
diff --git a/packages/legacy/package.json b/packages/legacy/package.json
index 95633533..beddc999 100644
--- a/packages/legacy/package.json
+++ b/packages/legacy/package.json
@@ -8,7 +8,7 @@
"dist"
],
"scripts": {
- "lint": "tsc --noEmit",
+ "check-types": "tsc --noEmit",
"build": "tsc"
},
"repository": {
diff --git a/packages/queue/package.json b/packages/queue/package.json
index ec2a031d..788c93b2 100644
--- a/packages/queue/package.json
+++ b/packages/queue/package.json
@@ -18,7 +18,7 @@
}
},
"scripts": {
- "lint": "tsc --noEmit",
+ "check-types": "tsc --noEmit",
"build": "tsc"
},
"repository": {
diff --git a/packages/redis/package.json b/packages/redis/package.json
index 05edbf00..206c1177 100644
--- a/packages/redis/package.json
+++ b/packages/redis/package.json
@@ -8,7 +8,7 @@
"dist"
],
"scripts": {
- "lint": "tsc --noEmit",
+ "check-types": "tsc --noEmit",
"build": "tsc"
},
"repository": {
diff --git a/packages/tasks/package.json b/packages/tasks/package.json
index e46f9e80..907534e6 100644
--- a/packages/tasks/package.json
+++ b/packages/tasks/package.json
@@ -25,7 +25,7 @@
"dist"
],
"scripts": {
- "lint": "tsc --noEmit",
+ "check-types": "tsc --noEmit",
"build": "tsc"
},
"repository": {
diff --git a/turbo.json b/turbo.json
index 45be36aa..66c5e9aa 100644
--- a/turbo.json
+++ b/turbo.json
@@ -1,11 +1,21 @@
{
"$schema": "https://turborepo.com/schema.json",
+ "ui": "tui",
"tasks": {
"build": {
- "dependsOn": ["^build"]
+ "dependsOn": ["^build", "check-types"],
+ "outputs": ["dist/**", "build/**"],
+ "cache": true
},
- "lint": {
- "dependsOn": ["^build", "^lint"]
+ "check-types": {
+ "dependsOn": ["^build"],
+ "outputs": [],
+ "cache": true
+ },
+ "dev": {
+ "dependsOn": ["^build"],
+ "cache": false,
+ "persistent": true
}
}
}
diff --git a/turbo/generators/templates/package.json.hbs b/turbo/generators/templates/package.json.hbs
index 31ad439b..5caf3225 100644
--- a/turbo/generators/templates/package.json.hbs
+++ b/turbo/generators/templates/package.json.hbs
@@ -8,7 +8,7 @@
"dist"
],
"scripts": {
- "lint": "tsc --noEmit",
+ "check-types": "tsc --noEmit",
"build": "tsc"
},
"repository": {