feat: i18n wip

Author: twlite

apps/test-bot/commandkit.config.ts

@@ -1,6 +1,7 @@
 import { defineConfig } from 'commandkit';
 import { legacy } from '@commandkit/legacy';
+import { i18n } from '@commandkit/i18n';
 
 export default defineConfig({
-  plugins: [legacy({ skipBuiltInValidations: true })],
+  plugins: [i18n(), legacy({ skipBuiltInValidations: true })],
 });

apps/test-bot/package.json

@@ -11,6 +11,7 @@
   "dependencies": {
     "commandkit": "workspace:*",
     "@commandkit/devtools": "workspace:*",
+    "@commandkit/i18n": "workspace:*",
     "@commandkit/legacy": "workspace:*",
     "discord.js": "^14.17.3",
     "dotenv": "^16.4.7"

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

@@ -20,10 +20,14 @@ export const command = {
 export async function userContextMenu(ctx: UserContextMenuCommandContext) {
   const target = ctx.interaction.targetUser;
 
+  const { t } = ctx.locale();
+
   await ctx.interaction.reply({
     embeds: [
       {
-        title: `${target.username}'s Avatar`,
+        title: t('avatar', {
+          user: target.username,
+        }),
         image: {
           url: target.displayAvatarURL({ size: 2048 }),
         },
@@ -35,11 +39,14 @@ export async function userContextMenu(ctx: UserContextMenuCommandContext) {
 
 export async function chatInput(ctx: SlashCommandContext) {
   const user = ctx.options.getUser('user') ?? ctx.interaction.user;
+  const { t } = ctx.locale();
 
   await ctx.interaction.reply({
     embeds: [
       {
-        title: `${user.username}'s Avatar`,
+        title: t('avatar', {
+          user: user.username,
+        }),
         image: {
           url: user.displayAvatarURL({ size: 2048 }),
         },
@@ -51,11 +58,14 @@ export async function chatInput(ctx: SlashCommandContext) {
 
 export async function message(ctx: MessageCommandContext) {
   const user = ctx.options.getUser('user') ?? ctx.message.author;
+  const { t } = ctx.locale();
 
   await ctx.message.reply({
     embeds: [
       {
-        title: `${user.username}'s Avatar`,
+        title: t('avatar', {
+          user: user.username,
+        }),
         image: {
           url: user.displayAvatarURL({ size: 2048 }),
         },

apps/test-bot/src/app/locales/en-US/avatar.json

@@ -0,0 +1,13 @@
+export default {
+  $command: {
+    name: 'avatar',
+    description: 'This is an avatar command.',
+    options: [
+      {
+        name: 'user',
+        description: 'The user to get the avatar for.',
+      },
+    ],
+  },
+  avatar: "{{user}}'s avatar",
+};

apps/test-bot/src/app/locales/en-US/avatar.ts

@@ -0,0 +1,13 @@
+export default {
+  $command: {
+    name: 'avatar',
+    description: "C'est une commande pour afficher l'avatar.",
+    options: [
+      {
+        name: 'user',
+        description: "L'utilisateur dont vous souhaitez voir l'avatar.",
+      },
+    ],
+  },
+  avatar: 'Avatar de {{user}}',
+};

apps/test-bot/src/app/locales/en-US/cat.json

@@ -13,7 +13,9 @@
     "skipDefaultLibCheck": true,
     "allowJs": true,
     "alwaysStrict": false,
-    "checkJs": false
+    "checkJs": false,
+    "strict": true,
+    "strictNullChecks": true
   },
   "include": ["src", "commandkit.config.ts", "commandkit-env.d.ts"]
 }

apps/test-bot/src/app/locales/en-US/legacy.json

@@ -137,7 +137,10 @@ export class CommandKit extends EventEmitter {
       });
 
       await this.options.client.login(
-        token ?? process.env.TOKEN ?? process.env.DISCORD_TOKEN,
+        token ??
+          this.options.client.token ??
+          process.env.TOKEN ??
+          process.env.DISCORD_TOKEN,
       );
 
       await this.plugins.execute((ctx, plugin) => {
@@ -155,7 +158,7 @@ export class CommandKit extends EventEmitter {
    */
   async loadPlugins() {
     const config = await loadConfigFile();
-    const plugins = config.plugins.filter((p) => isRuntimePlugin(p));
+    const plugins = config.plugins.flat(2).filter((p) => isRuntimePlugin(p));
 
     if (!plugins.length) return;
 

apps/test-bot/src/app/locales/en-US/prompt.json

@@ -2,6 +2,7 @@ export * from './handlers/AppCommandHandler';
 export * from './commands/Context';
 export * from './commands/MessageCommandParser';
 export * from './middleware/signals';
+export * from './register/CommandRegistrar';
 
 export {
   type CommandSource,

apps/test-bot/src/app/locales/fr/avatar.json

@@ -1,15 +1,12 @@
-import {
-  ApplicationCommandType,
-  REST,
-  Routes,
-  ApplicationCommandOptionType,
-  APIApplicationCommandSubcommandGroupOption,
-  APIApplicationCommandSubcommandOption,
-} from 'discord.js';
+import { ApplicationCommandType, REST, Routes } from 'discord.js';
 import { CommandKit } from '../../CommandKit';
 import { CommandData } from '../../types';
 import { Logger } from '../../logger/Logger';
-import { Command } from '../router/CommandsRouter';
+
+export interface PreRegisterCommandsEvent {
+  preventDefault(): void;
+  commands: CommandData[];
+}
 
 export class CommandRegistrar {
   private api = new REST();
@@ -80,11 +77,30 @@ export class CommandRegistrar {
    * Registers loaded commands.
    */
   public async register() {
+    const commands = this.getCommandsData();
+
+    let preRegistrationPrevented = false;
+    const preRegisterEvent: PreRegisterCommandsEvent = {
+      preventDefault() {
+        preRegistrationPrevented = true;
+      },
+      commands,
+    };
+
+    await this.commandkit.plugins.execute(async (ctx, plugin) => {
+      if (preRegistrationPrevented) return;
+      return plugin.onBeforeRegisterCommands(ctx, preRegisterEvent);
+    });
+
+    if (preRegistrationPrevented) return;
+
+    // we check this after the plugin event
+    // because plugins may be able to register commands
+    // before the client is ready
     if (!this.commandkit.client.isReady()) {
       throw new Error('Cannot register commands before the client is ready');
     }
 
-    const commands = this.getCommandsData();
     const guildCommands = commands
       .filter((command) => command.guilds?.filter(Boolean).length)
       .map((c) => ({
@@ -105,6 +121,19 @@ export class CommandRegistrar {
   public async updateGlobalCommands(commands: CommandData[]) {
     if (!commands.length) return;
 
+    let prevented = false;
+    const preRegisterEvent: PreRegisterCommandsEvent = {
+      preventDefault() {
+        prevented = true;
+      },
+      commands,
+    };
+
+    await this.commandkit.plugins.execute(async (ctx, plugin) => {
+      if (prevented) return;
+      return plugin.onBeforeRegisterGlobalCommands(ctx, preRegisterEvent);
+    });
+
     try {
       const data = (await this.api.put(
         Routes.applicationCommands(this.commandkit.client.user!.id),
@@ -128,6 +157,24 @@ export class CommandRegistrar {
    * Updates the guild commands.
    */
   public async updateGuildCommands(commands: CommandData[]) {
+    if (!commands.length) return;
+
+    let prevented = false;
+    const preRegisterEvent: PreRegisterCommandsEvent = {
+      preventDefault() {
+        prevented = true;
+      },
+      commands,
+    };
+    await this.commandkit.plugins.execute(async (ctx, plugin) => {
+      if (prevented) return;
+      return plugin.onBeforePrepareGuildCommandsRegistration(
+        ctx,
+        preRegisterEvent,
+      );
+    });
+    if (prevented) return;
+
     try {
       const guildCommandsMap = new Map<string, CommandData[]>();
 
@@ -148,6 +195,21 @@ export class CommandRegistrar {
       let count = 0;
 
       for (const [guild, guildCommands] of guildCommandsMap) {
+        let prevented = false;
+        const preRegisterEvent: PreRegisterCommandsEvent = {
+          preventDefault() {
+            prevented = true;
+          },
+          commands: guildCommands,
+        };
+
+        await this.commandkit.plugins.execute(async (ctx, plugin) => {
+          if (prevented) return;
+          return plugin.onBeforeRegisterGuildCommands(ctx, preRegisterEvent);
+        });
+
+        if (prevented) continue;
+
         const data = (await this.api.put(
           Routes.applicationGuildCommands(
             this.commandkit.client.user!.id,

apps/test-bot/src/app/locales/fr/avatar.ts

@@ -18,7 +18,7 @@ async function buildAndStart(configPath: string, skipStart = false) {
   await buildApplication({
     configPath,
     isDev: true,
-    plugins: config.plugins.filter((p) => isCompilerPlugin(p)),
+    plugins: config.plugins.flat(2).filter((p) => isCompilerPlugin(p)),
     esbuildPlugins: config.esbuildPlugins,
   });
 

apps/test-bot/src/app/locales/fr/prompt.json

@@ -1,3 +1,5 @@
+import { MaybeArray } from '../components';
+import { CommandKitPlugin } from '../plugins';
 import { defaultConfig } from './default';
 import { CommandKitConfig } from './types';
 import { ResolvedCommandKitConfig } from './utils';
@@ -43,7 +45,10 @@ export function defineConfig(
       ...(config.esbuildPlugins ?? []),
       ...(defaultConfig.esbuildPlugins ?? []),
     ],
-    plugins: [...(config.plugins ?? []), ...(defaultConfig.plugins ?? [])],
+    plugins: [
+      ...(config.plugins ?? []),
+      ...(defaultConfig.plugins ?? []),
+    ] as MaybeArray<CommandKitPlugin[]>,
     sourceMap: {
       ...defaultConfig.sourceMap,
       ...config.sourceMap,

apps/test-bot/tsconfig.json

@@ -1,10 +1,11 @@
+import { MaybeArray } from '../components';
 import { CommandKitPlugin } from '../plugins';
 
 export interface CommandKitConfig {
   /**
    * The plugins to use with CommandKit.
    */
-  plugins?: CommandKitPlugin[];
+  plugins?: MaybeArray<CommandKitPlugin[]>;
   /**
    * The esbuild plugins to use with CommandKit.
    */