gtx-cli 2.5.8 → 2.5.9

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # gtx-cli
 
+## 2.5.9
+
+### Patch Changes
+
+- [#823](https://github.com/generaltranslation/gt/pull/823) [`afbd29a`](https://github.com/generaltranslation/gt/commit/afbd29a34b051c76fce387269c4eb4a2e00a5831) Thanks [@brian-lou](https://github.com/brian-lou)! - Deprecate old 'setup' command -> Use 'init' instead. New 'setup' command runs project setup
+
+- Updated dependencies [[`afbd29a`](https://github.com/generaltranslation/gt/commit/afbd29a34b051c76fce387269c4eb4a2e00a5831)]:
+  - generaltranslation@8.0.3
+
 ## 2.5.8
 
 ### Patch Changes

package/dist/cli/base.d.ts

@@ -16,16 +16,17 @@ export declare class BaseCLI {
     constructor(program: Command, library: SupportedLibraries, additionalModules?: SupportedLibraries[]);
     init(): void;
     execute(): void;
+    protected setupSetupProjectCommand(): void;
     protected setupStageCommand(): void;
     protected setupTranslateCommand(): void;
     protected setupSendDiffsCommand(): void;
+    protected handleSetupProject(initOptions: TranslateFlags): Promise<void>;
     protected handleStage(initOptions: TranslateFlags): Promise<void>;
     protected handleTranslate(initOptions: TranslateFlags): Promise<void>;
     protected setupUploadCommand(): void;
     protected setupLoginCommand(): void;
     protected setupInitCommand(): void;
     protected setupConfigureCommand(): void;
-    protected setupSetupCommand(): void;
     protected handleUploadCommand(settings: Settings & UploadOptions): Promise<void>;
     protected handleSetupReactCommand(options: SetupOptions): Promise<void>;
     protected handleInitCommand(ranReactSetup: boolean): Promise<void>;

package/dist/cli/base.js

@@ -17,6 +17,7 @@ import { areCredentialsSet } from '../utils/credentials.js';
 import { upload } from '../formats/files/upload.js';
 import { attachTranslateFlags } from './flags.js';
 import { handleStage } from './commands/stage.js';
+import { handleSetupProject } from './commands/setupProject.js';
 import { handleDownload, handleTranslate, postProcessTranslations, } from './commands/translate.js';
 import { getDownloaded, clearDownloaded } from '../state/recentDownloads.js';
 import updateConfig from '../fs/config/updateConfig.js';
@@ -34,13 +35,14 @@ export class BaseCLI {
         this.additionalModules = additionalModules || [];
         this.setupInitCommand();
         this.setupConfigureCommand();
-        this.setupSetupCommand();
         this.setupUploadCommand();
         this.setupLoginCommand();
         this.setupSendDiffsCommand();
     }
     // Init is never called in a child class
     init() {
+        this.setupSetupProjectCommand();
+        this.setupStageCommand();
         this.setupTranslateCommand();
     }
     // Execute is called by the main program
@@ -50,6 +52,15 @@ export class BaseCLI {
             process.argv.push('init');
         }
     }
+    setupSetupProjectCommand() {
+        attachTranslateFlags(this.program
+            .command('setup')
+            .description('Upload source files and setup the project for translation')).action(async (initOptions) => {
+            displayHeader('Uploading source files and setting up project...');
+            await this.handleSetupProject(initOptions);
+            logger.endCommand('Done!');
+        });
+    }
     setupStageCommand() {
         attachTranslateFlags(this.program
             .command('stage')
@@ -80,6 +91,12 @@ export class BaseCLI {
             logger.endCommand('Saved local edits');
         });
     }
+    async handleSetupProject(initOptions) {
+        const settings = await generateSettings(initOptions);
+        // Preprocess shared static assets if configured (move + rewrite sources)
+        await processSharedStaticAssets(settings);
+        await handleSetupProject(initOptions, settings, this.library);
+    }
     async handleStage(initOptions) {
         const settings = await generateSettings(initOptions);
         // Preprocess shared static assets if configured (move + rewrite sources)
@@ -208,18 +225,6 @@ See the docs for more information: https://generaltranslation.com/docs/react/tut
             logger.endCommand('Done! Make sure you have an API key and project ID to use General Translation. Get them on the dashboard: https://generaltranslation.com/dashboard');
         });
     }
-    setupSetupCommand() {
-        this.program
-            .command('setup')
-            .description('Run the setup to configure your Next.js or React project for General Translation')
-            .option('--src <paths...>', "Space-separated list of glob patterns containing the app's source code, by default 'src/**/*.{js,jsx,ts,tsx}' 'app/**/*.{js,jsx,ts,tsx}' 'pages/**/*.{js,jsx,ts,tsx}' 'components/**/*.{js,jsx,ts,tsx}'")
-            .option('-c, --config <path>', 'Filepath to config file, by default gt.config.json', findFilepath(['gt.config.json']))
-            .action(async (options) => {
-            displayHeader('Running React setup wizard...');
-            await this.handleSetupReactCommand(options);
-            logger.endCommand("Done! Take advantage of all of General Translation's features by signing up for a free account! https://generaltranslation.com/signup");
-        });
-    }
     async handleUploadCommand(settings) {
         // dataFormat for JSONs
         let dataFormat;
@@ -265,7 +270,7 @@ See the docs for more information: https://generaltranslation.com/docs/react/tut
                 message: `Auto-detected that you're using gt-next or gt-react. Would you like to use the General Translation CDN to store your translations?\nSee ${isUsingGTNext
                     ? 'https://generaltranslation.com/en/docs/next/guides/local-tx'
                     : 'https://generaltranslation.com/en/docs/react/guides/local-tx'} for more information.\nIf you answer no, we'll configure the CLI tool to download completed translations.`,
-                defaultValue: true,
+                defaultValue: false,
             })
             : false;
         // Ask where the translations are stored
@@ -279,7 +284,7 @@ See the docs for more information: https://generaltranslation.com/docs/react/tut
         const finalTranslationsDir = translationsDir?.trim() || './public/_gt';
         if (isUsingGT && !usingCDN) {
             // Create loadTranslations.js file for local translations
-            await createLoadTranslationsFile(process.cwd(), finalTranslationsDir);
+            await createLoadTranslationsFile(process.cwd(), finalTranslationsDir, locales);
             logger.message(`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`);

package/dist/cli/commands/setupProject.d.ts

@@ -0,0 +1,7 @@
+import { Settings, SupportedLibraries, TranslateFlags } from '../../types/index.js';
+import { FileTranslationData } from '../../workflow/download.js';
+import { BranchData } from '../../types/branch.js';
+export declare function handleSetupProject(options: TranslateFlags, settings: Settings, library: SupportedLibraries): Promise<{
+    fileVersionData: FileTranslationData | undefined;
+    branchData: BranchData | undefined;
+} | null>;

package/dist/cli/commands/setupProject.js

@@ -0,0 +1,50 @@
+import { logger } from '../../console/logger.js';
+import { logCollectedFiles, logErrorAndExit } from '../../console/logging.js';
+import { noLocalesError, noDefaultLocaleError, noApiKeyError, noProjectIdError, devApiKeyError, } from '../../console/index.js';
+import { collectFiles } from '../../formats/files/collectFiles.js';
+import { setupProject } from '../../workflow/setupProject.js';
+export async function handleSetupProject(options, settings, library) {
+    // Validate required settings are present if not in dry run
+    if (!options.dryRun) {
+        if (!settings.locales) {
+            return logErrorAndExit(noLocalesError);
+        }
+        if (!settings.defaultLocale) {
+            return logErrorAndExit(noDefaultLocaleError);
+        }
+        if (!settings.apiKey) {
+            return logErrorAndExit(noApiKeyError);
+        }
+        if (settings.apiKey.startsWith('gtx-dev-')) {
+            return logErrorAndExit(devApiKeyError);
+        }
+        if (!settings.projectId) {
+            return logErrorAndExit(noProjectIdError);
+        }
+    }
+    const { files: allFiles, reactComponents } = await collectFiles(options, settings, library);
+    // Dry run
+    if (options.dryRun) {
+        logger.success(`Dry run: No files were uploaded to General Translation.`);
+        logCollectedFiles(allFiles, reactComponents);
+        return null;
+    }
+    // Upload files and run setup step
+    let fileVersionData;
+    let branchData;
+    if (allFiles.length > 0) {
+        const { branchData: branchDataResult } = await setupProject(allFiles, options, settings);
+        branchData = branchDataResult;
+        fileVersionData = Object.fromEntries(allFiles.map((file) => [
+            file.fileId,
+            {
+                fileName: file.fileName,
+                versionId: file.versionId,
+            },
+        ]));
+    }
+    return {
+        fileVersionData,
+        branchData,
+    };
+}

package/dist/cli/commands/stage.d.ts

@@ -2,8 +2,6 @@ import { Settings, SupportedLibraries, TranslateFlags } from '../../types/index.
 import type { EnqueueFilesResult } from 'generaltranslation/types';
 import { FileTranslationData } from '../../workflow/download.js';
 import { BranchData } from '../../types/branch.js';
-export declare const TEMPLATE_FILE_NAME = "__INTERNAL_GT_TEMPLATE_NAME__";
-export declare const TEMPLATE_FILE_ID: string;
 export declare function handleStage(options: TranslateFlags, settings: Settings, library: SupportedLibraries, stage: boolean): Promise<{
     fileVersionData: FileTranslationData | undefined;
     jobData: EnqueueFilesResult | undefined;

package/dist/cli/commands/stage.js

@@ -1,14 +1,11 @@
 import { logger } from '../../console/logger.js';
-import { logErrorAndExit } from '../../console/logging.js';
-import { noLocalesError, noDefaultLocaleError, noApiKeyError, noProjectIdError, devApiKeyError, invalidConfigurationError, } from '../../console/index.js';
-import { aggregateFiles } from '../../formats/files/translate.js';
-import { aggregateReactTranslations } from '../../translation/stage.js';
+import { logCollectedFiles, logErrorAndExit } from '../../console/logging.js';
+import { noLocalesError, noDefaultLocaleError, noApiKeyError, noProjectIdError, devApiKeyError, } from '../../console/index.js';
 import { stageFiles } from '../../workflow/stage.js';
 import { updateVersions } from '../../fs/config/updateVersions.js';
 import updateConfig from '../../fs/config/updateConfig.js';
-import { hashStringSync } from '../../utils/hash.js';
-export const TEMPLATE_FILE_NAME = '__INTERNAL_GT_TEMPLATE_NAME__';
-export const TEMPLATE_FILE_ID = hashStringSync(TEMPLATE_FILE_NAME);
+import { TEMPLATE_FILE_ID } from '../../utils/constants.js';
+import { collectFiles } from '../../formats/files/collectFiles.js';
 export async function handleStage(options, settings, library, stage) {
     // Validate required settings are present if not in dry run
     if (!options.dryRun) {
@@ -28,57 +25,11 @@ export async function handleStage(options, settings, library, stage) {
             return logErrorAndExit(noProjectIdError);
         }
     }
-    // Aggregate files
-    const allFiles = await aggregateFiles(settings);
-    // Parse for React components
-    let reactComponents = 0;
-    if (library === 'gt-react' || library === 'gt-next') {
-        const updates = await aggregateReactTranslations(options, settings, library);
-        if (updates.length > 0) {
-            if (!options.dryRun &&
-                !settings.publish &&
-                !settings.files?.placeholderPaths.gt) {
-                logErrorAndExit(invalidConfigurationError);
-            }
-            reactComponents = updates.length;
-            // Convert updates to a file object
-            const fileData = {};
-            const fileMetadata = {};
-            // Convert updates to the proper data format
-            for (const update of updates) {
-                const { source, metadata, dataFormat } = update;
-                metadata.dataFormat = dataFormat; // add the data format to the metadata
-                const { hash, id } = metadata;
-                if (id) {
-                    fileData[id] = source;
-                    fileMetadata[id] = metadata;
-                }
-                else {
-                    fileData[hash] = source;
-                    fileMetadata[hash] = metadata;
-                }
-            }
-            allFiles.push({
-                fileName: TEMPLATE_FILE_NAME,
-                content: JSON.stringify(fileData),
-                fileFormat: 'GTJSON',
-                formatMetadata: fileMetadata,
-                fileId: TEMPLATE_FILE_ID,
-                versionId: hashStringSync(JSON.stringify(fileData)),
-            });
-        }
-    }
+    const { files: allFiles, reactComponents } = await collectFiles(options, settings, library);
     // Dry run
     if (options.dryRun) {
-        const fileNames = allFiles
-            .map((file) => {
-            if (file.fileName === TEMPLATE_FILE_NAME) {
-                return `- <React Elements> (${reactComponents})`;
-            }
-            return `- ${file.fileName}`;
-        })
-            .join('\n');
-        logger.success(`Dry run: No files were sent to General Translation. Found files:\n${fileNames}`);
+        logger.success(`Dry run: No files were sent to General Translation.`);
+        logCollectedFiles(allFiles, reactComponents);
         return null;
     }
     // Send translations to General Translation

package/dist/cli/next.js

@@ -6,6 +6,7 @@ export class NextCLI extends ReactCLI {
         super(command, library, additionalModules);
     }
     init() {
+        this.setupSetupProjectCommand();
         this.setupStageCommand();
         this.setupTranslateCommand();
         this.setupGenerateSourceCommand();

package/dist/cli/react.d.ts

@@ -8,6 +8,7 @@ export declare class ReactCLI extends BaseCLI {
     protected wrapContent(options: WrapOptions, framework: SupportedFrameworks, errors: string[], warnings: string[]): Promise<{
         filesUpdated: string[];
     }>;
+    protected setupSetupProjectCommand(): void;
     protected setupStageCommand(): void;
     protected setupTranslateCommand(): void;
     protected setupValidateCommand(): void;

package/dist/cli/react.js

@@ -21,6 +21,7 @@ export class ReactCLI extends BaseCLI {
         super(command, library, additionalModules);
     }
     init() {
+        this.setupSetupProjectCommand();
         this.setupStageCommand();
         this.setupTranslateCommand();
         this.setupGenerateSourceCommand();
@@ -32,6 +33,15 @@ export class ReactCLI extends BaseCLI {
     wrapContent(options, framework, errors, warnings) {
         return wrapContentReact(options, pkg, framework, errors, warnings);
     }
+    setupSetupProjectCommand() {
+        attachAdditionalReactTranslateFlags(attachTranslateFlags(this.program
+            .command('setup')
+            .description('Upload source files and setup the project for translation'))).action(async (options) => {
+            displayHeader('Uploading source files and setting up project...');
+            await this.handleSetupProject(options);
+            logger.endCommand('Done!');
+        });
+    }
     setupStageCommand() {
         attachAdditionalReactTranslateFlags(attachTranslateFlags(this.program
             .command('stage')

package/dist/console/logger.d.ts

@@ -1,5 +1,13 @@
 import type { SpinnerResult, ProgressResult } from '@clack/prompts';
 export type LogFormat = 'default' | 'json';
+/**
+ * GT_LOG_FORMAT: default | json.
+ * - If default, logs will be pretty-printed using @clack/prompts.
+ * - If json, logs will be written in JSON format to the console.
+ * GT_LOG_FILE: If specified, logs will be written to the file.
+ * GT_LOG_LEVEL: The level of logs to write. If not specified, defaults to 'info'.
+ * - Valid levels: debug, info, warn, error.
+ */
 declare class Logger {
     private static instance;
     private pinoLogger;

package/dist/console/logger.js

@@ -59,6 +59,14 @@ class MockProgress {
         this.logger.info(`[Progress] ${msg} (${this.current}/${this.max})`);
     }
 }
+/**
+ * GT_LOG_FORMAT: default | json.
+ * - If default, logs will be pretty-printed using @clack/prompts.
+ * - If json, logs will be written in JSON format to the console.
+ * GT_LOG_FILE: If specified, logs will be written to the file.
+ * GT_LOG_LEVEL: The level of logs to write. If not specified, defaults to 'info'.
+ * - Valid levels: debug, info, warn, error.
+ */
 class Logger {
     static instance;
     pinoLogger = null;
@@ -67,12 +75,19 @@ class Logger {
     constructor() {
         // Read configuration from environment variables
         const format = (process.env.GT_LOG_FORMAT || 'default').toLowerCase();
+        const logFile = process.env.GT_LOG_FILE;
+        const logLevel = process.env.GT_LOG_LEVEL || 'info';
         if (format !== 'default' && format !== 'json') {
             console.error('Invalid log format');
             process.exit(1);
         }
-        const logFile = process.env.GT_LOG_FILE;
-        const logLevel = process.env.GT_LOG_LEVEL || 'info';
+        if (logLevel !== 'debug' &&
+            logLevel !== 'info' &&
+            logLevel !== 'warn' &&
+            logLevel !== 'error') {
+            console.error('Invalid log level');
+            process.exit(1);
+        }
         this.logFormat = format;
         const transports = [];
         // Console output (stdout)

package/dist/console/logging.d.ts

@@ -1,3 +1,4 @@
+import { FileToUpload } from 'generaltranslation/types';
 export declare function logErrorAndExit(message: string): never;
 export declare function exitSync(code: number): never;
 export declare function displayHeader(introString?: string): void;
@@ -41,3 +42,7 @@ export declare function warnHasUnwrappedExpression(file: string, id: string, unw
 export declare function warnNonStaticExpression(file: string, attrName: string, value: string): void;
 export declare function warnTemplateLiteral(file: string, value: string): void;
 export declare function warnTernary(file: string): void;
+/**
+ * Helper: Log all collected files
+ */
+export declare function logCollectedFiles(files: FileToUpload[], reactComponents?: number): void;

package/dist/console/logging.js

@@ -2,6 +2,7 @@ import { text, select, confirm, isCancel, cancel, multiselect, } from '@clack/pr
 import chalk from 'chalk';
 import { getCLIVersion } from '../utils/packageJson.js';
 import { logger } from './logger.js';
+import { TEMPLATE_FILE_NAME } from '../utils/constants.js';
 export function logErrorAndExit(message) {
     logger.error(message);
     return exitSync(1);
@@ -151,3 +152,18 @@ export function warnTernary(file) {
     logger.warn(`Found ternary expression in ${chalk.cyan(file)}. ` +
         chalk.white('A Branch component may be more appropriate here.'));
 }
+/**
+ * Helper: Log all collected files
+ */
+export function logCollectedFiles(files, reactComponents) {
+    logger.message(chalk.cyan('Files found in project:') +
+        '\n' +
+        files
+            .map((file) => {
+            if (file.fileName === TEMPLATE_FILE_NAME) {
+                return `- <React Elements>${reactComponents ? ` (${reactComponents})` : ''}`;
+            }
+            return `- ${file.fileName}`;
+        })
+            .join('\n'));
+}

package/dist/formats/files/collectFiles.d.ts

@@ -0,0 +1,6 @@
+import { Settings, SupportedLibraries, TranslateFlags } from '../../types/index.js';
+import type { FileToUpload } from 'generaltranslation/types';
+export declare function collectFiles(options: TranslateFlags, settings: Settings, library: SupportedLibraries): Promise<{
+    files: FileToUpload[];
+    reactComponents: number;
+}>;

package/dist/formats/files/collectFiles.js

@@ -0,0 +1,49 @@
+import { logErrorAndExit } from '../../console/logging.js';
+import { invalidConfigurationError } from '../../console/index.js';
+import { aggregateFiles } from '../../formats/files/translate.js';
+import { aggregateReactTranslations } from '../../translation/stage.js';
+import { hashStringSync } from '../../utils/hash.js';
+import { TEMPLATE_FILE_NAME, TEMPLATE_FILE_ID } from '../../utils/constants.js';
+export async function collectFiles(options, settings, library) {
+    // Aggregate files
+    const allFiles = await aggregateFiles(settings);
+    // Parse for React components
+    let reactComponents = 0;
+    if (library === 'gt-react' || library === 'gt-next') {
+        const updates = await aggregateReactTranslations(options, settings, library);
+        if (updates.length > 0) {
+            if (!options.dryRun &&
+                !settings.publish &&
+                !settings.files?.placeholderPaths.gt) {
+                logErrorAndExit(invalidConfigurationError);
+            }
+            // Convert updates to a file object
+            const fileData = {};
+            const fileMetadata = {};
+            // Convert updates to the proper data format
+            for (const update of updates) {
+                const { source, metadata, dataFormat } = update;
+                metadata.dataFormat = dataFormat; // add the data format to the metadata
+                const { hash, id } = metadata;
+                if (id) {
+                    fileData[id] = source;
+                    fileMetadata[id] = metadata;
+                }
+                else {
+                    fileData[hash] = source;
+                    fileMetadata[hash] = metadata;
+                }
+            }
+            reactComponents = updates.length;
+            allFiles.push({
+                fileName: TEMPLATE_FILE_NAME,
+                content: JSON.stringify(fileData),
+                fileFormat: 'GTJSON',
+                formatMetadata: fileMetadata,
+                fileId: TEMPLATE_FILE_ID,
+                versionId: hashStringSync(JSON.stringify(fileData)),
+            });
+        }
+    }
+    return { files: allFiles, reactComponents };
+}

package/dist/formats/files/fileMapping.js

@@ -4,7 +4,7 @@ import path from 'node:path';
 import { getRelative } from '../../fs/findFilepath.js';
 import { getLocaleProperties } from 'generaltranslation';
 import { replaceLocalePlaceholders } from '../utils.js';
-import { TEMPLATE_FILE_NAME } from '../../cli/commands/stage.js';
+import { TEMPLATE_FILE_NAME } from '../../utils/constants.js';
 /**
  * Creates a mapping between source files and their translated counterparts for each locale
  * @param filePaths - Resolved file paths for different file types

package/dist/fs/createLoadTranslationsFile.d.ts

@@ -1 +1 @@
-export declare function createLoadTranslationsFile(appDirectory: string, translationsDir?: string): Promise<void>;
+export declare function createLoadTranslationsFile(appDirectory: string, translationsDir: string | undefined, locales: string[]): Promise<void>;

package/dist/fs/createLoadTranslationsFile.js

@@ -2,7 +2,7 @@ import fs from 'node:fs';
 import path from 'node:path';
 import { logger } from '../console/logger.js';
 import chalk from 'chalk';
-export async function createLoadTranslationsFile(appDirectory, translationsDir = './public/_gt') {
+export async function createLoadTranslationsFile(appDirectory, translationsDir = './public/_gt', locales) {
     const usingSrcDirectory = fs.existsSync(path.join(appDirectory, 'src'));
     // Calculate the relative path from the loadTranslations.js location to the translations directory
     const loadTranslationsDir = usingSrcDirectory
@@ -29,6 +29,13 @@ export default async function loadTranslations(locale) {
 `;
         await fs.promises.writeFile(filePath, loadTranslationsContent);
         logger.info(`Created ${chalk.cyan('loadTranslations.js')} file at ${chalk.cyan(filePath)}.`);
+        // Create empty JSON files
+        for (const locale of locales) {
+            if (fs.existsSync(path.join(translationsDir, `${locale}.json`))) {
+                continue;
+            }
+            await fs.promises.writeFile(path.join(translationsDir, `${locale}.json`), '{}');
+        }
     }
     else {
         logger.info(`Found ${chalk.cyan('loadTranslations.js')} file at ${chalk.cyan(filePath)}. Skipping creation...`);

package/dist/types/index.d.ts

@@ -41,6 +41,7 @@ export type TranslateFlags = {
     dryRun: boolean;
     saveLocal?: boolean;
     stageTranslations?: boolean;
+    setupProject?: boolean;
     publish?: boolean;
     force?: boolean;
     forceDownload?: boolean;

package/dist/utils/constants.d.ts

@@ -1,2 +1,4 @@
 export declare const GT_DASHBOARD_URL = "https://dash.generaltranslation.com";
 export declare const GT_CONFIG_SCHEMA_URL = "https://assets.gtx.dev/config-schema.json";
+export declare const TEMPLATE_FILE_NAME = "__INTERNAL_GT_TEMPLATE_NAME__";
+export declare const TEMPLATE_FILE_ID: string;

package/dist/utils/constants.js

@@ -1,2 +1,5 @@
+import { hashStringSync } from './hash.js';
 export const GT_DASHBOARD_URL = 'https://dash.generaltranslation.com';
 export const GT_CONFIG_SCHEMA_URL = 'https://assets.gtx.dev/config-schema.json';
+export const TEMPLATE_FILE_NAME = '__INTERNAL_GT_TEMPLATE_NAME__';
+export const TEMPLATE_FILE_ID = hashStringSync(TEMPLATE_FILE_NAME);

package/dist/workflow/PollJobsStep.js

@@ -1,7 +1,7 @@
 import chalk from 'chalk';
 import { WorkflowStep } from './Workflow.js';
 import { logger } from '../console/logger.js';
-import { TEMPLATE_FILE_NAME } from '../cli/commands/stage.js';
+import { TEMPLATE_FILE_NAME } from '../utils/constants.js';
 export class PollTranslationJobsStep extends WorkflowStep {
     gt;
     spinner = null;

package/dist/workflow/SetupStep.d.ts

@@ -11,6 +11,6 @@ export declare class SetupStep extends WorkflowStep<FileReference[], FileReferen
     private files;
     private completed;
     constructor(gt: GT, settings: Settings, timeoutMs: number);
-    run(files: FileReference[]): Promise<FileReference[]>;
+    run(files: FileReference[], force?: boolean): Promise<FileReference[]>;
     wait(): Promise<void>;
 }

package/dist/workflow/SetupStep.js

@@ -15,7 +15,7 @@ export class SetupStep extends WorkflowStep {
         this.settings = settings;
         this.timeoutMs = timeoutMs;
     }
-    async run(files) {
+    async run(files, force = false) {
         this.files = files;
         this.spinner.start('Setting up project...');
         if (files.length === 0) {
@@ -24,6 +24,7 @@ export class SetupStep extends WorkflowStep {
         }
         const result = await this.gt.setupProject(files, {
             locales: this.settings.locales,
+            force,
         });
         if (result.status === 'completed') {
             this.completed = true;

package/dist/workflow/setupProject.d.ts

@@ -0,0 +1,13 @@
+import { Settings, TranslateFlags } from '../types/index.js';
+import { FileToUpload } from 'generaltranslation/types';
+import { BranchData } from '../types/branch.js';
+/**
+ * Sets up a project by uploading files running the setup step
+ * @param files - Array of file objects to upload
+ * @param options - The options for the API call
+ * @param settings - Settings configuration
+ * @returns The branch data
+ */
+export declare function setupProject(files: FileToUpload[], options: TranslateFlags, settings: Settings): Promise<{
+    branchData: BranchData;
+}>;

package/dist/workflow/setupProject.js

@@ -0,0 +1,48 @@
+import { logErrorAndExit } from '../console/logging.js';
+import { gt } from '../utils/gt.js';
+import { UploadStep } from './UploadStep.js';
+import { SetupStep } from './SetupStep.js';
+import { BranchStep } from './BranchStep.js';
+import { logCollectedFiles } from '../console/logging.js';
+/**
+ * Helper: Calculate timeout with validation
+ */
+function calculateTimeout(timeout) {
+    const value = timeout !== undefined ? Number(timeout) : 600;
+    return (Number.isFinite(value) ? value : 600) * 1000;
+}
+/**
+ * Sets up a project by uploading files running the setup step
+ * @param files - Array of file objects to upload
+ * @param options - The options for the API call
+ * @param settings - Settings configuration
+ * @returns The branch data
+ */
+export async function setupProject(files, options, settings) {
+    try {
+        // Log files to be translated
+        logCollectedFiles(files);
+        // Calculate timeout for setup step
+        const timeoutMs = calculateTimeout(options.timeout);
+        // Create workflow with steps
+        const branchStep = new BranchStep(gt, settings);
+        const uploadStep = new UploadStep(gt, settings);
+        const setupStep = new SetupStep(gt, settings, timeoutMs);
+        // first run the branch step
+        const branchData = await branchStep.run();
+        await branchStep.wait();
+        if (!branchData) {
+            return logErrorAndExit('Failed to resolve git branch information.');
+        }
+        // then run the upload step
+        const uploadedFiles = await uploadStep.run({ files, branchData });
+        await uploadStep.wait();
+        // then run the setup step
+        await setupStep.run(uploadedFiles, options.force ?? false);
+        await setupStep.wait();
+        return { branchData };
+    }
+    catch (error) {
+        return logErrorAndExit('Failed to run project setup. ' + error);
+    }
+}

package/dist/workflow/stage.js

@@ -1,8 +1,5 @@
-import chalk from 'chalk';
-import { logErrorAndExit } from '../console/logging.js';
-import { logger } from '../console/logger.js';
+import { logCollectedFiles, logErrorAndExit } from '../console/logging.js';
 import { gt } from '../utils/gt.js';
-import { TEMPLATE_FILE_NAME } from '../cli/commands/stage.js';
 import { UploadStep } from './UploadStep.js';
 import { SetupStep } from './SetupStep.js';
 import { EnqueueStep } from './EnqueueStep.js';
@@ -15,21 +12,6 @@ function calculateTimeout(timeout) {
     const value = timeout !== undefined ? Number(timeout) : 600;
     return (Number.isFinite(value) ? value : 600) * 1000;
 }
-/**
- * Helper: Log files to be translated
- */
-function logFilesToTranslate(files) {
-    logger.message(chalk.cyan('Files found in project:') +
-        '\n' +
-        files
-            .map((file) => {
-            if (file.fileName === TEMPLATE_FILE_NAME) {
-                return `- <React Elements>`;
-            }
-            return `- ${file.fileName}`;
-        })
-            .join('\n'));
-}
 /**
  * Sends multiple files for translation to the API using a workflow pattern
  * @param files - Array of file objects to translate
@@ -40,7 +22,7 @@ function logFilesToTranslate(files) {
 export async function stageFiles(files, options, settings) {
     try {
         // Log files to be translated
-        logFilesToTranslate(files);
+        logCollectedFiles(files);
         // Calculate timeout for setup step
         const timeoutMs = calculateTimeout(options.timeout);
         // Create workflow with steps

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gtx-cli",
-  "version": "2.5.8",
+  "version": "2.5.9",
   "main": "dist/index.js",
   "bin": "dist/main.js",
   "files": [
@@ -93,7 +93,7 @@
     "unified": "^11.0.5",
     "unist-util-visit": "^5.0.0",
     "yaml": "^2.8.0",
-    "generaltranslation": "8.0.2"
+    "generaltranslation": "8.0.3"
   },
   "devDependencies": {
     "@babel/types": "^7.28.4",