gtx-cli 2.4.0 → 2.4.2

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # gtx-cli
 
+## 2.4.2
+
+### Patch Changes
+
+- [#753](https://github.com/generaltranslation/gt/pull/753) [`bd0bc26`](https://github.com/generaltranslation/gt/commit/bd0bc265192d5b51618a537a92122cd6eeae6e4d) Thanks [@ErnestM1234](https://github.com/ErnestM1234)! - fix: avoid downloading files when using --publish flag
+
+## 2.4.1
+
+### Patch Changes
+
+- [#751](https://github.com/generaltranslation/gt/pull/751) [`7114780`](https://github.com/generaltranslation/gt/commit/71147803bf3e4cf21556ffb9b5f77756e283a32a) Thanks [@SamEggert](https://github.com/SamEggert)! - transform for yaml files -- retrieve file format in downloadFileBatch
+
+- Updated dependencies [[`7114780`](https://github.com/generaltranslation/gt/commit/71147803bf3e4cf21556ffb9b5f77756e283a32a)]:
+  - generaltranslation@7.7.1
+
 ## 2.4.0
 
 ### Minor Changes

package/dist/api/checkFileTranslations.js

@@ -103,7 +103,9 @@ function prepareFileQueryData(data, locales) {
  */
 function generateStatusSuffixText(downloadStatus, fileQueryData) {
     // Simple progress indicator
-    const progressText = chalk.green(`[${downloadStatus.downloaded.size + downloadStatus.failed.size}/${fileQueryData.length}]`) + ` translations completed`;
+    const progressText = chalk.green(`[${downloadStatus.downloaded.size +
+        downloadStatus.failed.size +
+        downloadStatus.skipped.size}/${fileQueryData.length}]`) + ` translations completed`;
     // Get terminal height to adapt our output
     const terminalHeight = process.stdout.rows || 24; // Default to 24 if undefined
     // If terminal is very small, just show the basic progress
@@ -120,6 +122,7 @@ function generateStatusSuffixText(downloadStatus, fileQueryData) {
                 completed: new Set(),
                 pending: new Set([item.locale]),
                 failed: new Set(),
+                skipped: new Set(),
             });
         }
         else {
@@ -143,6 +146,14 @@ function generateStatusSuffixText(downloadStatus, fileQueryData) {
             status.failed.add(locale);
         }
     }
+    for (const fileLocale of downloadStatus.skipped) {
+        const [fileName, locale] = fileLocale.split(':');
+        const status = fileStatus.get(fileName);
+        if (status) {
+            status.pending.delete(locale);
+            status.skipped.add(locale);
+        }
+    }
     // Calculate how many files we can show based on terminal height
     const filesArray = Array.from(fileStatus.entries());
     const maxFilesToShow = Math.min(filesArray.length, terminalHeight - 3 // Header + progress + buffer
@@ -159,6 +170,13 @@ function generateStatusSuffixText(downloadStatus, fileQueryData) {
                 .join(', ');
             localeStatuses.push(chalk.green(`${completedCodes}`));
         }
+        // Add (translated but not downloaded) skipped locales
+        if (status.skipped.size > 0) {
+            const skippedCodes = Array.from(status.skipped)
+                .map((locale) => getLocaleProperties(locale).code)
+                .join(', ');
+            localeStatuses.push(chalk.green(`${skippedCodes}`));
+        }
         // Add failed locales
         if (status.failed.size > 0) {
             const failedCodes = Array.from(status.failed)
@@ -230,17 +248,19 @@ async function checkTranslationDeployment(fileQueryData, downloadStatus, spinner
                 };
             })
                 .filter((file) => file !== null);
-            const batchResult = await downloadFileBatch(batchFiles, options, 3, 1000, Boolean(forceDownload));
-            // Process results
-            batchFiles.forEach((file) => {
-                const { translationId, fileLocale } = file;
-                if (batchResult.successful.includes(translationId)) {
-                    downloadStatus.downloaded.add(fileLocale);
-                }
-                else if (batchResult.failed.includes(translationId)) {
-                    downloadStatus.failed.add(fileLocale);
-                }
-            });
+            if (batchFiles.length > 0) {
+                const batchResult = await downloadFileBatch(batchFiles, options, 3, 1000, Boolean(forceDownload));
+                // Process results
+                batchFiles.forEach((file) => {
+                    const { translationId, fileLocale } = file;
+                    if (batchResult.successful.includes(translationId)) {
+                        downloadStatus.downloaded.add(fileLocale);
+                    }
+                    else if (batchResult.failed.includes(translationId)) {
+                        downloadStatus.failed.add(fileLocale);
+                    }
+                });
+            }
         }
         // Force a refresh of the spinner display
         const statusText = generateStatusSuffixText(downloadStatus, fileQueryData);

package/dist/api/downloadFileBatch.js

@@ -8,6 +8,7 @@ import { mergeJson } from '../formats/json/mergeJson.js';
 import mergeYaml from '../formats/yaml/mergeYaml.js';
 import { getDownloadedVersions, saveDownloadedVersions, } from '../fs/config/downloadedVersions.js';
 import { recordDownloaded } from '../state/recentDownloads.js';
+import stringify from 'fast-json-stable-stringify';
 /**
  * Downloads multiple translation files in a single batch request
  * @param files - Array of files to download with their output paths
@@ -92,10 +93,22 @@ export async function downloadFileBatch(files, options, maxRetries = 3, retryDel
                                         translatedContent: file.data,
                                         targetLocale: locale,
                                     },
-                                ])[0];
+                                ], options.defaultLocale)[0];
                             }
                         }
                     }
+                    // If the file is a GTJSON file, stable sort the order and format the data
+                    if (file.fileFormat === 'GTJSON') {
+                        try {
+                            const jsonData = JSON.parse(data);
+                            const sortedData = stringify(jsonData); // stably sort with fast-json-stable-stringify
+                            const sortedJsonData = JSON.parse(sortedData);
+                            data = JSON.stringify(sortedJsonData, null, 2); // format the data
+                        }
+                        catch (error) {
+                            logWarning(`Failed to sort GTJson file: ${file.id}: ` + error);
+                        }
+                    }
                     // Write the file to disk
                     await fs.promises.writeFile(outputPath, data);
                     // Track as downloaded

package/dist/cli/commands/translate.js

@@ -10,12 +10,12 @@ import { noFilesError, noVersionIdError } from '../../console/index.js';
 import localizeStaticImports from '../../utils/localizeStaticImports.js';
 // Downloads translations that were completed
 export async function handleTranslate(options, settings, filesTranslationResponse) {
-    if (filesTranslationResponse && settings.files) {
+    if (filesTranslationResponse) {
         const { resolvedPaths, placeholderPaths, transformPaths } = settings.files;
         const fileMapping = createFileMapping(resolvedPaths, placeholderPaths, transformPaths, settings.locales, settings.defaultLocale);
         const { data } = filesTranslationResponse;
         // Check for remaining translations
-        await checkFileTranslations(data, settings.locales, options.timeout, (sourcePath, locale) => fileMapping[locale][sourcePath] ?? null, settings, options.force, options.forceDownload);
+        await checkFileTranslations(data, settings.locales, options.timeout, (sourcePath, locale) => fileMapping[locale]?.[sourcePath] ?? null, settings, options.force, options.forceDownload);
     }
 }
 // Downloads translations that were originally staged

package/dist/config/generateSettings.d.ts

@@ -2,8 +2,8 @@ import { Settings } from '../types/index.js';
 export declare const DEFAULT_SRC_PATTERNS: string[];
 /**
  * Generates settings from any
- * @param options - The options to generate settings from
+ * @param flags - The CLI flags to generate settings from
  * @param cwd - The current working directory
  * @returns The generated settings
  */
-export declare function generateSettings(options: any, cwd?: string): Promise<Settings>;
+export declare function generateSettings(flags: Record<string, any>, cwd?: string): Promise<Settings>;

package/dist/config/generateSettings.js

@@ -20,24 +20,24 @@ export const DEFAULT_SRC_PATTERNS = [
 ];
 /**
  * Generates settings from any
- * @param options - The options to generate settings from
+ * @param flags - The CLI flags to generate settings from
  * @param cwd - The current working directory
  * @returns The generated settings
  */
-export async function generateSettings(options, cwd = process.cwd()) {
+export async function generateSettings(flags, cwd = process.cwd()) {
     // Load config file
     let gtConfig = {};
-    if (options.config && !options.config.endsWith('.json')) {
-        options.config = `${options.config}.json`;
+    if (flags.config && !flags.config.endsWith('.json')) {
+        flags.config = `${flags.config}.json`;
     }
-    if (options.config) {
-        gtConfig = loadConfig(options.config);
+    if (flags.config) {
+        gtConfig = loadConfig(flags.config);
     }
     else {
         const config = resolveConfig(cwd);
         if (config) {
             gtConfig = config.config;
-            options.config = config.path;
+            flags.config = config.path;
         }
         else {
             gtConfig = {};
@@ -45,43 +45,43 @@ export async function generateSettings(options, cwd = process.cwd()) {
     }
     // Warn if apiKey is present in gt.config.json
     if (gtConfig.apiKey) {
-        warnApiKeyInConfig(options.config);
+        warnApiKeyInConfig(flags.config);
         process.exit(1);
     }
     const projectIdEnv = resolveProjectId();
     // Resolve mismatched projectIds
     if (gtConfig.projectId &&
-        options.projectId &&
-        gtConfig.projectId !== options.projectId) {
-        logErrorAndExit(`Project ID mismatch between ${chalk.green(gtConfig.projectId)} and ${chalk.green(options.projectId)}! Please use the same projectId in all configs.`);
+        flags.projectId &&
+        gtConfig.projectId !== flags.projectId) {
+        logErrorAndExit(`Project ID mismatch between ${chalk.green(gtConfig.projectId)} and ${chalk.green(flags.projectId)}! Please use the same projectId in all configs.`);
     }
     else if (gtConfig.projectId &&
         projectIdEnv &&
         gtConfig.projectId !== projectIdEnv) {
         logErrorAndExit(`Project ID mismatch between ${chalk.green(gtConfig.projectId)} and ${chalk.green(projectIdEnv)}! Please use the same projectId in all configs.`);
     }
-    if (options.options?.docsUrlPattern &&
-        !options.options?.docsUrlPattern.includes('[locale]')) {
+    if (flags.options?.docsUrlPattern &&
+        !flags.options?.docsUrlPattern.includes('[locale]')) {
         logErrorAndExit('Failed to localize static urls: URL pattern must include "[locale]" to denote the location of the locale');
     }
-    if (options.options?.docsImportPattern &&
-        !options.options?.docsImportPattern.includes('[locale]')) {
+    if (flags.options?.docsImportPattern &&
+        !flags.options?.docsImportPattern.includes('[locale]')) {
         logErrorAndExit('Failed to localize static imports: Import pattern must include "[locale]" to denote the location of the locale');
     }
-    if (options.options?.copyFiles) {
-        for (const file of options.options.copyFiles) {
+    if (flags.options?.copyFiles) {
+        for (const file of flags.options.copyFiles) {
             if (!file.includes('[locale]')) {
                 logErrorAndExit('Failed to copy files: File path must include "[locale]" to denote the location of the locale');
             }
         }
     }
     // merge options
-    const mergedOptions = { ...gtConfig, ...options };
+    const mergedOptions = { ...gtConfig, ...flags };
     // Add defaultLocale if not provided
     mergedOptions.defaultLocale =
         mergedOptions.defaultLocale || libraryDefaultLocale;
     // merge locales
-    mergedOptions.locales = Array.from(new Set([...(gtConfig.locales || []), ...(options.locales || [])]));
+    mergedOptions.locales = Array.from(new Set([...(gtConfig.locales || []), ...(flags.locales || [])]));
     // Separate defaultLocale from locales
     mergedOptions.locales = mergedOptions.locales.filter((locale) => locale !== mergedOptions.defaultLocale);
     // Add apiKey if not provided
@@ -104,7 +104,7 @@ export async function generateSettings(options, cwd = process.cwd()) {
     // For human review, always stage the project
     mergedOptions.stageTranslations = mergedOptions.stageTranslations ?? false;
     // Add publish if not provided
-    mergedOptions.publish = (gtConfig.publish || options.publish) ?? false;
+    mergedOptions.publish = (gtConfig.publish || flags.publish) ?? false;
     // Populate src if not provided
     mergedOptions.src = mergedOptions.src || DEFAULT_SRC_PATTERNS;
     // Resolve all glob patterns in the files object
@@ -115,21 +115,20 @@ export async function generateSettings(options, cwd = process.cwd()) {
         .map(([key]) => key);
     mergedOptions.files = mergedOptions.files
         ? resolveFiles(mergedOptions.files, mergedOptions.defaultLocale, mergedOptions.locales, cwd, compositePatterns)
-        : undefined;
+        : { resolvedPaths: {}, placeholderPaths: {}, transformPaths: {} };
     mergedOptions.options = {
         ...(mergedOptions.options || {}),
         experimentalLocalizeStaticImports: gtConfig.options?.experimentalLocalizeStaticImports ||
-            options.experimentalLocalizeStaticImports,
+            flags.experimentalLocalizeStaticImports,
         experimentalLocalizeStaticUrls: gtConfig.options?.experimentalLocalizeStaticUrls ||
-            options.experimentalLocalizeStaticUrls,
+            flags.experimentalLocalizeStaticUrls,
         experimentalHideDefaultLocale: gtConfig.options?.experimentalHideDefaultLocale ||
-            options.experimentalHideDefaultLocale,
+            flags.experimentalHideDefaultLocale,
         experimentalFlattenJsonFiles: gtConfig.options?.experimentalFlattenJsonFiles ||
-            options.experimentalFlattenJsonFiles,
+            flags.experimentalFlattenJsonFiles,
         experimentalClearLocaleDirs: gtConfig.options?.experimentalClearLocaleDirs ||
-            options.experimentalClearLocaleDirs,
-        clearLocaleDirsExclude: gtConfig.options?.clearLocaleDirsExclude ||
-            options.clearLocaleDirsExclude,
+            flags.experimentalClearLocaleDirs,
+        clearLocaleDirsExclude: gtConfig.options?.clearLocaleDirsExclude || flags.clearLocaleDirsExclude,
     };
     // Add additional options if provided
     if (mergedOptions.options) {

package/dist/formats/files/translate.js

@@ -112,7 +112,7 @@ export async function aggregateFiles(settings) {
             allFiles.push(...files);
         }
     }
-    if (allFiles.length === 0) {
+    if (allFiles.length === 0 && !settings.publish) {
         logError('No files to translate were found. Please check your configuration and try again.');
     }
     return allFiles;

package/dist/formats/yaml/mergeYaml.d.ts

@@ -2,4 +2,4 @@ import { AdditionalOptions } from '../../types/index.js';
 export default function mergeYaml(originalContent: string, inputPath: string, options: AdditionalOptions, targets: {
     translatedContent: string;
     targetLocale: string;
-}[]): string[];
+}[], defaultLocale: string): string[];

package/dist/formats/yaml/mergeYaml.js

@@ -2,7 +2,8 @@ import JSONPointer from 'jsonpointer';
 import { exit, logError } from '../../console/logging.js';
 import { validateYamlSchema } from './utils.js';
 import YAML from 'yaml';
-export default function mergeYaml(originalContent, inputPath, options, targets) {
+import { applyTransformations } from '../json/mergeJson.js';
+export default function mergeYaml(originalContent, inputPath, options, targets, defaultLocale) {
     const yamlSchema = validateYamlSchema(options, inputPath);
     if (!yamlSchema) {
         return targets.map((target) => target.translatedContent);
@@ -46,6 +47,10 @@ export default function mergeYaml(originalContent, inputPath, options, targets)
                 // Silently ignore invalid or non-existent JSON pointers
             }
         }
+        // Apply transformations if they exist
+        if (yamlSchema.transform) {
+            applyTransformations(mergedYaml, yamlSchema.transform, target.targetLocale, defaultLocale);
+        }
         output.push(YAML.stringify(mergedYaml));
     }
     if (!output.length) {

package/dist/types/index.d.ts

@@ -120,7 +120,7 @@ export type Settings = {
         resolvedPaths: ResolvedFiles;
         placeholderPaths: ResolvedFiles;
         transformPaths: TransformFiles;
-    } | undefined;
+    };
     stageTranslations: boolean;
     publish: boolean;
     _versionId?: string;
@@ -163,6 +163,7 @@ export type JsonSchema = {
 export type YamlSchema = {
     preset?: 'mintlify';
     include?: string[];
+    transform?: TransformOptions;
 };
 export type SourceObjectOptions = {
     type: 'array' | 'object';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gtx-cli",
-  "version": "2.4.0",
+  "version": "2.4.2",
   "main": "dist/index.js",
   "bin": "dist/main.js",
   "files": [
@@ -73,6 +73,7 @@
     "dotenv": "^16.4.5",
     "esbuild": "^0.25.4",
     "fast-glob": "^3.3.3",
+    "fast-json-stable-stringify": "^2.1.0",
     "form-data": "^4.0.4",
     "gt-remark": "^1.0.1",
     "json-pointer": "^0.6.2",
@@ -91,7 +92,7 @@
     "unified": "^11.0.5",
     "unist-util-visit": "^5.0.0",
     "yaml": "^2.8.0",
-    "generaltranslation": "7.7.0"
+    "generaltranslation": "7.7.1"
   },
   "devDependencies": {
     "@babel/types": "^7.28.4",