feat: locale cli template

Author: twlite

packages/commandkit/src/cli/env.ts

@@ -27,3 +27,7 @@ export const ProdEnvFiles = ['.env.production', '.env.production.local'];
 export const devEnvFileArgs = [...CommonEnvFiles, ...DevEnvFiles];
 
 export const prodEnvFileArgs = [...CommonEnvFiles, ...ProdEnvFiles];
+
+export function setCLIEnv() {
+  process.env.COMMANDKIT_IS_CLI = 'true';
+}

packages/commandkit/src/cli/init.ts

@@ -30,6 +30,7 @@ export async function bootstrapCommandkitCLI(
   const { generateCommand, generateEvent } = await import('./generators');
   const { version } = await import('../version');
   const { showInformation } = await import('./information');
+  const { setCLIEnv } = await import('./env');
 
   const program = new Command('commandkit');
 
@@ -72,6 +73,7 @@ export async function bootstrapCommandkitCLI(
     .description('Build your project for production usage.')
     .option('-c, --config [path]', 'Path to your commandkit config file.')
     .action(() => {
+      setCLIEnv();
       const options = program.opts();
       return createProductionBuild(options.config);
     });
@@ -87,6 +89,8 @@ export async function bootstrapCommandkitCLI(
     )
     .argument('[args...]', 'Additional arguments for the template')
     .action(async (template, args) => {
+      setCLIEnv();
+
       // Handle custom plugin templates
       const { plugins } = await loadConfigFile();
       const runtime = new CompilerPluginRuntime(

packages/commandkit/src/utils/constants.ts

@@ -1,7 +1,7 @@
 export const COMMANDKIT_CACHE_TAG = Symbol('kCommandKitCacheTag');
 
 export const COMMANDKIT_IS_DEV = process.env.COMMANDKIT_IS_DEV === 'true';
-
+export const COMMANDKIT_IS_CLI = process.env.COMMANDKIT_IS_CLI === 'true';
 export const COMMANDKIT_IS_TEST = process.env.COMMANDKIT_IS_TEST === 'true';
 
 export const COMMANDKIT_BOOTSTRAP_MODE = (process.env

packages/commandkit/src/utils/utilities.ts

@@ -1,19 +1,28 @@
 import { existsSync } from 'node:fs';
 import { join } from 'node:path';
-import { COMMANDKIT_IS_DEV } from './constants';
+import { COMMANDKIT_IS_CLI, COMMANDKIT_IS_DEV } from './constants';
 import { getConfig } from '../config/config';
 import { eventWorkerContext } from '../app/events/EventWorkerContext';
 
 let appDir: string | null = null;
 let currentDir: string | null = null;
 
+function getSrcDir() {
+  if (COMMANDKIT_IS_CLI) {
+    return 'src';
+  }
+
+  if (COMMANDKIT_IS_DEV) {
+    return '.commandkit';
+  }
+
+  return getConfig().distDir;
+}
+
 export function getCurrentDirectory(): string {
   if (currentDir) return currentDir;
-
-  let root = join(
-    process.cwd(),
-    COMMANDKIT_IS_DEV ? '.commandkit' : getConfig().distDir,
-  );
+  const src = getSrcDir();
+  let root = join(process.cwd(), src);
 
   if (!existsSync(root)) root = process.cwd();
 
@@ -38,10 +47,7 @@ export function getSourceDirectories(): string[] {
 export function findAppDirectory(): string | null {
   if (appDir) return appDir;
 
-  let root = join(
-    process.cwd(),
-    COMMANDKIT_IS_DEV ? '.commandkit' : getConfig().distDir,
-  );
+  let root = join(process.cwd(), getSrcDir());
 
   if (!existsSync(root)) root = process.cwd();
 

packages/i18n/src/cli.ts

@@ -0,0 +1,80 @@
+import { CompilerPlugin, CompilerPluginRuntime, Logger } from 'commandkit';
+import { DISCORD_LOCALES } from './constants';
+import { Locale } from 'discord.js';
+import { I18nPlugin } from './i18n';
+import { existsSync, mkdirSync, writeFileSync } from 'fs';
+import { join } from 'path';
+
+export class I18nCliTemplatePlugin extends CompilerPlugin {
+  public readonly name = 'I18nCliTemplatePlugin';
+
+  public async activate(ctx: CompilerPluginRuntime): Promise<void> {
+    try {
+      ctx.registerTemplate('locale', this.handleTemplate.bind(this));
+    } catch (e) {
+      Logger.error(`Failed to register CLI template "locale": ${e}`);
+    }
+  }
+
+  public async deactivate(ctx: CompilerPluginRuntime): Promise<void> {
+    ctx.unregisterTemplate('locale');
+  }
+
+  private panic(message: string): never {
+    Logger.error(message);
+    process.exit(1);
+  }
+
+  private async handleTemplate(args: string[]): Promise<void> {
+    if (args.length < 2) {
+      this.panic(
+        `Invalid arguments for locale template. Expected: <locale> <commandName>`,
+      );
+    }
+
+    const [locale, commandName] = args;
+
+    if (!DISCORD_LOCALES.has(locale as Locale)) {
+      this.panic(
+        `Invalid locale ${locale}. Please use one of the followings:\n${Array.from(
+          DISCORD_LOCALES,
+        )
+          .map((l) => `- ${l}`)
+          .join('\n')}`,
+      );
+    }
+
+    const localePath = I18nPlugin.getLoadPath('src', locale, commandName);
+
+    if (existsSync(localePath)) {
+      this.panic(`Locale file for "${locale}:${commandName}" already exists.`);
+    }
+
+    const localeDirSrc = join(localePath, '..', '..');
+
+    if (!existsSync(localeDirSrc)) {
+      this.panic(
+        `Could not locate source directory. Please make sure you are running this command from the location of your commandkit config file.`,
+      );
+    }
+
+    const localeDir = join(localePath, '..');
+
+    if (!existsSync(localeDir)) {
+      mkdirSync(localeDir, { recursive: true });
+    }
+
+    const data = {
+      $command: {
+        name: commandName,
+        description: `${commandName} command`,
+      },
+    };
+
+    writeFileSync(localePath, JSON.stringify(data, null, 2));
+
+    Logger.info(
+      `Locale file for ${locale} and ${commandName} created at ${localePath}`,
+    );
+  }
+}

packages/i18n/src/i18n.ts

@@ -183,13 +183,17 @@ export class I18nPlugin extends RuntimePlugin<LocalizationPluginOptions> {
     Logger.info('I18nPlugin has been activated');
   }
 
-  private getLoadPath() {
-    return join(getCurrentDirectory(), '/app/locales/{{lng}}/{{ns}}.json');
+  public static getLoadPath(
+    cwd = getCurrentDirectory(),
+    lng = '{{lng}}',
+    ns = '{{ns}}',
+  ) {
+    return join(cwd, `/app/locales/${lng}/${ns}.json`);
   }
 
   private async scanLocaleDirectory() {
     const endPattern = /{{lng}}(\/|\\){{ns}}.json$/;
-    const localesPath = this.getLoadPath();
+    const localesPath = I18nPlugin.getLoadPath();
     const scanDirTarget = localesPath.replace(endPattern, '');
 
     if (!existsSync(scanDirTarget)) {
@@ -301,7 +305,7 @@ export class I18nPlugin extends RuntimePlugin<LocalizationPluginOptions> {
   }
 
   private getBackendOptions() {
-    const loadPath = this.getLoadPath();
+    const loadPath = I18nPlugin.getLoadPath();
 
     return {
       loadPath: function (lng: string, namespace: string) {

packages/i18n/src/index.ts

@@ -1,6 +1,9 @@
+import { I18nCliTemplatePlugin } from './cli';
 import { I18nPlugin, LocalizationPluginOptions } from './i18n';
 
-export function i18n(options?: LocalizationPluginOptions) {
+export function i18n(
+  options?: LocalizationPluginOptions,
+): [I18nPlugin, I18nCliTemplatePlugin] {
   const opt = {
     ...options,
     i18nOptions: {
@@ -15,8 +18,9 @@ export function i18n(options?: LocalizationPluginOptions) {
 
   const localization = new I18nPlugin(opt);
 
-  return localization;
+  return [localization, new I18nCliTemplatePlugin({})];
 }
 
+export { I18nCliTemplatePlugin };
 export { locale } from './hooks';
-export { getI18n, type CommandLocalizationContext } from './i18n';
+export { getI18n, I18nPlugin, type CommandLocalizationContext } from './i18n';