gtx-cli 1.1.0 → 1.1.2

package/README.md

@@ -18,6 +18,42 @@ npm install gtx-cli
 
 ## Usage
 
+### Set up
+
+For more details, check out the [setup command documentation](https://generaltranslation.com/docs/cli/setup).
+
+If you are using gt-react or gt-next, run this command to automatically insert `<T>` components into your project.
+
+```bash
+npx gtx-cli setup
+```
+
+### Init
+
+For more details, check out the [init command documentation](https://generaltranslation.com/docs/cli/init).
+
+This command sets up your `gt.config.json` file.
+You will need to run this command in order to run the translate command.
+
+```bash
+npx gtx-cli init
+```
+
+### Translation
+
+For more details, check out the [translate command documentation](https://generaltranslation.com/docs/cli/translate).
+
+Before deploying to production, you need to generate translations.
+First, add your [production api keys](https://generaltranslation.com/dashboard):
+
+```bash
+GT_API_KEY=your-production-api-key
+GT_PROJECT_ID=your-project-id
+```
+
+Next run the translate command.
+This will generate translations and either publish them to the CDN or save them in your project depending on your configuration.
+
 ```bash
 npx gtx-cli translate
 ```

package/dist/api/checkFileTranslations.d.ts

@@ -11,6 +11,6 @@
 export declare function checkFileTranslations(apiKey: string, baseUrl: string, data: {
     [key: string]: {
         versionId: string;
-        canonicalName: string;
+        fileName: string;
     };
 }, locales: string[], timeoutDuration: number, resolveOutputPath: (sourcePath: string, locale: string) => string): Promise<boolean>;

package/dist/api/checkFileTranslations.js

@@ -38,7 +38,7 @@ function checkFileTranslations(apiKey, baseUrl, data, locales, timeoutDuration,
             for (const locale of locales) {
                 fileQueryData.push({
                     versionId: data[file].versionId,
-                    fileName: data[file].canonicalName,
+                    fileName: data[file].fileName,
                     locale,
                 });
             }
@@ -62,13 +62,14 @@ function checkFileTranslations(apiKey, baseUrl, data, locales, timeoutDuration,
                     // Process available translations
                     for (const translation of translations) {
                         const locale = translation.locale;
-                        const fileName = data[translation.fileName].canonicalName;
+                        const fileName = translation.fileName;
+                        const translationId = translation.id;
                         if (translation.isReady && fileName) {
                             // Mark this file+locale as downloaded
                             downloadedFiles.add(`${fileName}:${locale}`);
                             // Download the file
                             const outputPath = resolveOutputPath(fileName, locale);
-                            yield (0, downloadFile_1.downloadFile)(baseUrl, apiKey, translation.fileId, outputPath);
+                            yield (0, downloadFile_1.downloadFile)(baseUrl, apiKey, translationId, outputPath);
                         }
                     }
                     // Update the spinner text

package/dist/api/downloadFile.d.ts

@@ -1 +1 @@
-export declare function downloadFile(baseUrl: string, apiKey: string, fileId: string, outputPath: string): Promise<boolean>;
+export declare function downloadFile(baseUrl: string, apiKey: string, translationId: string, outputPath: string): Promise<boolean>;

package/dist/api/downloadFile.js

@@ -46,10 +46,10 @@ exports.downloadFile = downloadFile;
 const fs = __importStar(require("fs"));
 const path = __importStar(require("path"));
 // Helper function to download a file
-function downloadFile(baseUrl, apiKey, fileId, outputPath) {
+function downloadFile(baseUrl, apiKey, translationId, outputPath) {
     return __awaiter(this, void 0, void 0, function* () {
         try {
-            const downloadResponse = yield fetch(`${baseUrl}/v1/project/translations/files/${fileId}/download`, {
+            const downloadResponse = yield fetch(`${baseUrl}/v1/project/translations/files/${translationId}/download`, {
                 method: 'GET',
                 headers: Object.assign({}, (apiKey && { 'x-gt-api-key': apiKey })),
             });

package/dist/cli/base.js

@@ -257,7 +257,7 @@ class BaseCLI {
             else {
                 const translationsDirWithFormat = path_1.default.join(translationsDir, `[locale].json`);
                 // Create gt.config.json
-                (0, setupConfig_1.default)(configFilepath, {
+                (0, setupConfig_1.default)('gt.config.json', {
                     defaultLocale,
                     locales: locales.split(' '),
                     files: {

package/dist/cli/react.js

@@ -376,15 +376,16 @@ class ReactCLI extends base_1.BaseCLI {
             (0, console_1.displayInitializingText)();
             const settings = (0, generateSettings_1.generateSettings)(initOptions);
             // First run the base class's handleTranslate method
-            try {
-                yield _super.handleGenericTranslate.call(this, settings);
-                // If the base class's handleTranslate completes successfully, continue with ReactCLI-specific code
-            }
-            catch (error) {
-                // Continue with ReactCLI-specific code even if base handleTranslate failed
-            }
-            // only for typing purposes
             const options = Object.assign(Object.assign({}, initOptions), settings);
+            if (!options.dryRun) {
+                try {
+                    yield _super.handleGenericTranslate.call(this, settings);
+                    // If the base class's handleTranslate completes successfully, continue with ReactCLI-specific code
+                }
+                catch (error) {
+                    // Continue with ReactCLI-specific code even if base handleTranslate failed
+                }
+            }
             if (!options.dictionary) {
                 options.dictionary = (0, findFilepath_1.default)([
                     './dictionary.js',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gtx-cli",
-  "version": "1.1.0",
+  "version": "1.1.2",
   "main": "dist/index.js",
   "bin": "dist/main.js",
   "scripts": {