gtx-cli 2.1.10 → 2.1.11

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # gtx-cli
 
+## 2.1.11
+
+### Patch Changes
+
+- [#610](https://github.com/generaltranslation/gt/pull/610) [`bfb4f53`](https://github.com/generaltranslation/gt/commit/bfb4f53658c785520373af53a1e9fadb6eca2d0b) Thanks [@SamEggert](https://github.com/SamEggert)! - create loadTranslations.js when user specifies local translations in gtx-cli init
+
 ## 2.1.10
 
 ### Patch Changes

package/dist/cli/base.js

@@ -18,6 +18,7 @@ import { attachTranslateFlags } from './flags.js';
 import { handleStage } from './commands/stage.js';
 import { handleDownload, handleTranslate, postProcessTranslations, } from './commands/translate.js';
 import updateConfig from '../fs/config/updateConfig.js';
+import { createLoadTranslationsFile } from '../fs/createLoadTranslationsFile.js';
 export class BaseCLI {
     library;
     additionalModules;
@@ -241,17 +242,22 @@ See the docs for more information: https://generaltranslation.com/docs/react/tut
                 defaultValue: true,
             })
             : false;
-        if (isUsingGT && !usingCDN) {
-            logMessage(`Make sure to add a loadTranslations function to your app configuration to correctly use local translations.
-See https://generaltranslation.com/en/docs/next/guides/local-tx`);
-        }
         // Ask where the translations are stored
         const translationsDir = isUsingGT && !usingCDN
             ? await promptText({
                 message: 'What is the path to the directory where you would like to locally store your translations?',
-                defaultValue: './public/locales',
+                defaultValue: './public/_gt',
             })
             : null;
+        // Determine final translations directory with fallback
+        const finalTranslationsDir = translationsDir?.trim() || './public/_gt';
+        if (isUsingGT && !usingCDN) {
+            // Create loadTranslations.js file for local translations
+            await createLoadTranslationsFile(process.cwd(), finalTranslationsDir);
+            logMessage(`Created ${chalk.cyan('loadTranslations.js')} file for local translations.
+Make sure to add this function to your app configuration.
+See https://generaltranslation.com/en/docs/next/guides/local-tx`);
+        }
         const message = !isUsingGT
             ? 'What is the format of your language resource files? Select as many as applicable.\nAdditionally, you can translate any other files you have in your project.'
             : `${chalk.dim('(Optional)')} Do you have any separate files you would like to translate? For example, extra Markdown files for docs.`;
@@ -278,9 +284,9 @@ See https://generaltranslation.com/en/docs/next/guides/local-tx`);
             };
         }
         // Add GT translations if using GT and storing locally
-        if (isUsingGT && !usingCDN && translationsDir) {
+        if (isUsingGT && !usingCDN) {
             files.gt = {
-                output: path.join(translationsDir, `[locale].json`),
+                output: path.join(finalTranslationsDir, `[locale].json`),
             };
         }
         let configFilepath = 'gt.config.json';

package/dist/fs/createLoadTranslationsFile.d.ts

@@ -0,0 +1 @@
+export declare function createLoadTranslationsFile(appDirectory: string, translationsDir?: string): Promise<void>;

package/dist/fs/createLoadTranslationsFile.js

@@ -0,0 +1,36 @@
+import fs from 'node:fs';
+import path from 'node:path';
+import { logInfo } from '../console/logging.js';
+import chalk from 'chalk';
+export async function createLoadTranslationsFile(appDirectory, translationsDir = './public/_gt') {
+    const usingSrcDirectory = fs.existsSync(path.join(appDirectory, 'src'));
+    // Calculate the relative path from the loadTranslations.js location to the translations directory
+    const loadTranslationsDir = usingSrcDirectory
+        ? path.join(appDirectory, 'src')
+        : appDirectory;
+    const relativePath = path.relative(loadTranslationsDir, path.resolve(appDirectory, translationsDir));
+    const publicPath = relativePath ? `${relativePath}/` : './';
+    const filePath = usingSrcDirectory
+        ? path.join(appDirectory, 'src', 'loadTranslations.js')
+        : path.join(appDirectory, 'loadTranslations.js');
+    if (!fs.existsSync(filePath)) {
+        const loadTranslationsContent = `
+export default async function loadTranslations(locale) {
+  try {
+    // Load translations from ${translationsDir} directory
+    // This matches the GT config files.gt.output path
+    const t = await import(\`${publicPath}\${locale}.json\`);
+    return t.default;
+  } catch (error) {
+    console.warn(\`Failed to load translations for locale \${locale}:\`, error);
+    return {};
+  }
+}
+`;
+        await fs.promises.writeFile(filePath, loadTranslationsContent);
+        logInfo(`Created ${chalk.cyan('loadTranslations.js')} file at ${chalk.cyan(filePath)}.`);
+    }
+    else {
+        logInfo(`Found ${chalk.cyan('loadTranslations.js')} file at ${chalk.cyan(filePath)}. Skipping creation...`);
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gtx-cli",
-  "version": "2.1.10",
+  "version": "2.1.11",
   "main": "dist/index.js",
   "bin": "dist/main.js",
   "files": [