gtx-cli 2.5.49 → 2.6.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # gtx-cli
 
+## 2.6.0
+
+### Minor Changes
+
+- [#958](https://github.com/generaltranslation/gt/pull/958) [`c64d5d1`](https://github.com/generaltranslation/gt/commit/c64d5d1bc7fda78294e09b93c4a4e08d576409fc) Thanks [@pie575](https://github.com/pie575)! - CLI New Default Workflow
+
 ## 2.5.49
 
 ### Patch Changes

package/README.md

@@ -1,67 +1,39 @@
 <p align="center">
-  <a href="https://generaltranslation.com" target="_blank">
-    <img src="https://generaltranslation.com/gt-logo-light.svg" alt="General Translation" width="100" height="100">
+  <a href="https://generaltranslation.com/docs/cli">
+    <picture>
+      <source media="(prefers-color-scheme: dark)" srcset="https://generaltranslation.com/gt-logo-dark.svg">
+      <source media="(prefers-color-scheme: light)" srcset="https://generaltranslation.com/gt-logo-light.svg">
+      <img alt="General Translation" src="https://generaltranslation.com/gt-logo-light.svg" width="100" height="100">
+    </picture>
   </a>
 </p>
 
-# gtx-cli: General Purpose CLI Tool for General Translation
+<p align="center">
+  <a href="https://generaltranslation.com/docs/cli"><strong>Documentation</strong></a> · <a href="https://github.com/generaltranslation/gt/issues">Report Bug</a>
+</p>
 
-gtx-cli is a command-line tool used to interface with General Translation's AI-powered i18n platform.
+# gtx-cli
 
-See our [docs](https://generaltranslation.com/docs) for more information including guides, examples, and API references.
+Command-line tool for General Translation's i18n platform.
 
 ## Installation
 
 ```bash
-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
+npm install gtx-cli --save-dev
 ```
 
-### Init
-
-For more details, check out the [init command documentation](https://generaltranslation.com/docs/cli/init).
+## Quick Start
 
-This command sets up your `gt.config.json` file.
-You will need to run this command in order to run the translate command.
+Set up your project:
 
 ```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.
+Generate translations:
 
 ```bash
 npx gtx-cli translate
 ```
 
-## Documentation
-
-Full documentation, including guides, examples, and API references, can be found at [General Translation Docs](generaltranslation.com/docs).
-
-## Contributing
-
-We welcome any contributions to our libraries. Please submit a pull request!
+See the [full documentation](https://generaltranslation.com/docs/cli) for guides and API reference.

package/dist/cli/base.d.ts

@@ -1,5 +1,5 @@
 import { Command } from 'commander';
-import { Settings, ReactFrameworkObject, SupportedLibraries, SetupOptions, TranslateFlags } from '../types/index.js';
+import { Settings, SupportedLibraries, TranslateFlags } from '../types/index.js';
 export type UploadOptions = {
     config?: string;
     apiKey?: string;
@@ -28,7 +28,6 @@ export declare class BaseCLI {
     protected setupInitCommand(): void;
     protected setupConfigureCommand(): void;
     protected handleUploadCommand(settings: Settings & UploadOptions): Promise<void>;
-    protected handleSetupReactCommand(options: SetupOptions, frameworkObject: ReactFrameworkObject): Promise<void>;
-    protected handleInitCommand(ranReactSetup: boolean): Promise<void>;
+    protected handleInitCommand(ranReactSetup: boolean, useDefaults?: boolean): Promise<void>;
     protected handleLoginCommand(options: LoginOptions): Promise<void>;
 }

package/dist/cli/base.js

@@ -207,18 +207,34 @@ export class BaseCLI {
                 logger.endCommand('Once installed, Locadex will open a PR to your repository. See the docs for more information: https://generaltranslation.com/docs/locadex');
             }
             else {
+                // Get framework display info for the defaults message
+                const frameworkDisplayName = framework.type === 'react'
+                    ? getFrameworkDisplayName(framework)
+                    : null;
+                const library = framework.type === 'react'
+                    ? getReactFrameworkLibrary(framework)
+                    : null;
+                // Build defaults description based on detected framework
+                const defaultsDescription = framework.type === 'react'
+                    ? `${library} & GTProvider, ${frameworkDisplayName}, Files saved locally in ./public/_gt`
+                    : 'Files saved locally in ./public/_gt';
+                // Ask if user wants to use defaults
+                const useDefaults = await promptConfirm({
+                    message: `Would you like to use the recommended General Translation defaults? ${chalk.dim(`(${defaultsDescription})`)}`,
+                    defaultValue: true,
+                });
                 let ranReactSetup = false;
                 // so that people can run init in non-js projects
                 if (framework.type === 'react') {
-                    const frameworkDisplayName = getFrameworkDisplayName(framework);
-                    const library = getReactFrameworkLibrary(framework);
-                    const wrap = await promptConfirm({
-                        message: `${frameworkDisplayName} detected. Would you like to install ${library} and add the GTProvider? See the docs for more information: https://generaltranslation.com/docs/react/tutorials/quickstart`,
-                        defaultValue: true,
-                    });
+                    const wrap = useDefaults
+                        ? true
+                        : await promptConfirm({
+                            message: `Would you like to install ${library} and add the GTProvider? See the docs for more information: https://generaltranslation.com/docs/react/tutorials/quickstart`,
+                            defaultValue: true,
+                        });
                     if (wrap) {
                         logger.info(`${chalk.yellow('[EXPERIMENTAL]')} Configuring project...`);
-                        await this.handleSetupReactCommand(options, framework);
+                        await handleSetupReactCommand(options, framework, useDefaults);
                         logger.endCommand(`Done! Since this wizard is experimental, please review the changes and make modifications as needed.
 \nNext step: start internationalizing! See the docs for more information: https://generaltranslation.com/docs/react/tutorials/quickstart`);
                         ranReactSetup = true;
@@ -228,7 +244,7 @@ export class BaseCLI {
                     logger.startCommand('Setting up project config...');
                 }
                 // Configure gt.config.json
-                await this.handleInitCommand(ranReactSetup);
+                await this.handleInitCommand(ranReactSetup, useDefaults);
                 logger.endCommand('Done! Check out our docs for more information on how to use General Translation: https://generaltranslation.com/docs');
             }
         });
@@ -269,12 +285,9 @@ export class BaseCLI {
         // Process all file types at once with a single call
         await upload(sourceFiles, placeholderPaths, transformPaths, dataFormat, settings);
     }
-    async handleSetupReactCommand(options, frameworkObject) {
-        await handleSetupReactCommand(options, frameworkObject);
-    }
     // Wizard for configuring gt.config.json
-    async handleInitCommand(ranReactSetup) {
-        const { defaultLocale, locales } = await getDesiredLocales();
+    async handleInitCommand(ranReactSetup, useDefaults = false) {
+        const { defaultLocale, locales } = await getDesiredLocales(); // Locales should still be asked for even if using defaults
         const packageJson = await searchForPackageJson();
         const isUsingGTNext = packageJson
             ? isPackageInstalled('gt-next', packageJson)
@@ -288,6 +301,8 @@ export class BaseCLI {
         const usingCDN = await (async () => {
             if (!isUsingGT)
                 return false;
+            if (useDefaults)
+                return false; // Default to local
             const selectedValue = await promptSelect({
                 message: `Would you like to save translation files locally or use the General Translation CDN to store them?`,
                 options: [
@@ -300,10 +315,12 @@ export class BaseCLI {
         })();
         // 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 store your translation files?',
-                defaultValue: './public/_gt',
-            })
+            ? useDefaults
+                ? './public/_gt'
+                : await promptText({
+                    message: 'What is the path to the directory where you would like to store your translation files?',
+                    defaultValue: './public/_gt',
+                })
             : null;
         // Determine final translations directory with fallback
         const finalTranslationsDir = translationsDir?.trim() || './public/_gt';
@@ -317,18 +334,20 @@ 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.'
             : `Do you have any additional files in this project to translate? For example, Markdown files for docs. ${chalk.dim('(To continue without selecting press Enter)')}`;
-        const fileExtensions = await promptMultiSelect({
-            message,
-            options: [
-                { value: 'json', label: FILE_EXT_TO_EXT_LABEL.json },
-                { value: 'md', label: FILE_EXT_TO_EXT_LABEL.md },
-                { value: 'mdx', label: FILE_EXT_TO_EXT_LABEL.mdx },
-                { value: 'ts', label: FILE_EXT_TO_EXT_LABEL.ts },
-                { value: 'js', label: FILE_EXT_TO_EXT_LABEL.js },
-                { value: 'yaml', label: FILE_EXT_TO_EXT_LABEL.yaml },
-            ],
-            required: !isUsingGT,
-        });
+        const fileExtensions = useDefaults && isUsingGT
+            ? [] // Skip for GT projects when using defaults
+            : await promptMultiSelect({
+                message,
+                options: [
+                    { value: 'json', label: FILE_EXT_TO_EXT_LABEL.json },
+                    { value: 'md', label: FILE_EXT_TO_EXT_LABEL.md },
+                    { value: 'mdx', label: FILE_EXT_TO_EXT_LABEL.mdx },
+                    { value: 'ts', label: FILE_EXT_TO_EXT_LABEL.ts },
+                    { value: 'js', label: FILE_EXT_TO_EXT_LABEL.js },
+                    { value: 'yaml', label: FILE_EXT_TO_EXT_LABEL.yaml },
+                ],
+                required: !isUsingGT,
+            });
         const files = {};
         for (const fileExtension of fileExtensions) {
             const paths = await promptText({
@@ -370,10 +389,12 @@ See https://generaltranslation.com/en/docs/next/guides/local-tx`);
         }
         // Set credentials
         if (!areCredentialsSet()) {
-            const loginQuestion = await promptConfirm({
-                message: `Would you like the wizard to automatically generate a ${isUsingGT ? 'development' : 'production'} API key and project ID for you?`,
-                defaultValue: true,
-            });
+            const loginQuestion = useDefaults
+                ? true
+                : await promptConfirm({
+                    message: `Would you like the wizard to automatically generate a ${isUsingGT ? 'development' : 'production'} API key and project ID for you?`,
+                    defaultValue: true,
+                });
             if (loginQuestion) {
                 const settings = await generateSettings({});
                 const keyType = isUsingGT ? 'development' : 'production';

package/dist/generated/version.d.ts

@@ -1 +1 @@
-export declare const PACKAGE_VERSION = "2.5.49";
+export declare const PACKAGE_VERSION = "2.6.0";

package/dist/generated/version.js

@@ -1,2 +1,2 @@
 // This file is auto-generated. Do not edit manually.
-export const PACKAGE_VERSION = '2.5.49';
+export const PACKAGE_VERSION = '2.6.0';

package/dist/setup/wizard.d.ts

@@ -1,3 +1,3 @@
 import { SetupOptions } from '../types/index.js';
 import { ReactFrameworkObject } from '../types/index.js';
-export declare function handleSetupReactCommand(options: SetupOptions, frameworkObject: ReactFrameworkObject): Promise<void>;
+export declare function handleSetupReactCommand(options: SetupOptions, frameworkObject: ReactFrameworkObject, useDefaults?: boolean): Promise<void>;

package/dist/setup/wizard.js

@@ -15,35 +15,39 @@ import { loadConfig } from '../fs/config/loadConfig.js';
 import { addVitePlugin } from '../react/parse/addVitePlugin/index.js';
 import { exitSync } from '../console/logging.js';
 import { getFrameworkDisplayName } from './frameworkUtils.js';
-export async function handleSetupReactCommand(options, frameworkObject) {
+export async function handleSetupReactCommand(options, frameworkObject, useDefaults = false) {
     const frameworkDisplayName = getFrameworkDisplayName(frameworkObject);
     // Ask user for confirmation using inquirer
-    const answer = await promptConfirm({
-        message: chalk.yellow(`This wizard will configure your ${frameworkDisplayName} project for internationalization with GT. If your project is already using a different i18n library, this wizard may cause issues.
+    if (!useDefaults) {
+        const answer = await promptConfirm({
+            message: chalk.yellow(`This wizard will configure your ${frameworkDisplayName} project for internationalization with GT. If your project is already using a different i18n library, this wizard may cause issues.
 
 Make sure you have committed or stashed any changes. Do you want to continue?`),
-        defaultValue: true,
-        cancelMessage: 'Operation cancelled. You can re-run this wizard with: npx gtx-cli setup',
-    });
-    if (!answer) {
-        logger.info('Operation cancelled. You can re-run this wizard with: npx gtx-cli setup');
-        exitSync(0);
+            defaultValue: true,
+            cancelMessage: 'Operation cancelled. You can re-run this wizard with: npx gtx-cli setup',
+        });
+        if (!answer) {
+            logger.info('Operation cancelled. You can re-run this wizard with: npx gtx-cli setup');
+            exitSync(0);
+        }
     }
-    const frameworkType = await promptSelect({
-        message: 'Which framework are you using?',
-        options: [
-            { value: 'next-app', label: chalk.blue('Next.js App Router') },
-            { value: 'next-pages', label: chalk.green('Next.js Pages Router') },
-            { value: 'vite', label: chalk.cyan('Vite + React') },
-            { value: 'gatsby', label: chalk.magenta('Gatsby') },
-            { value: 'react', label: chalk.yellow('React') },
-            { value: 'redwood', label: chalk.red('RedwoodJS') },
-            { value: 'other', label: chalk.dim('Other') },
-        ],
-        defaultValue: frameworkObject?.name || 'other',
-    });
+    const frameworkType = useDefaults && frameworkObject?.name
+        ? frameworkObject.name
+        : await promptSelect({
+            message: 'Which framework are you using?',
+            options: [
+                { value: 'next-app', label: chalk.blue('Next.js App Router') },
+                { value: 'next-pages', label: chalk.green('Next.js Pages Router') },
+                { value: 'vite', label: chalk.cyan('Vite + React') },
+                { value: 'gatsby', label: chalk.magenta('Gatsby') },
+                { value: 'react', label: chalk.yellow('React') },
+                { value: 'redwood', label: chalk.red('RedwoodJS') },
+                { value: 'other', label: chalk.dim('Other') },
+            ],
+            defaultValue: frameworkObject?.name || 'other',
+        });
     if (frameworkType === 'other') {
-        logger.error(`Sorry, the wizard doesn't currently support other React frameworks. 
+        logger.error(`Sorry, the wizard doesn't currently support other React frameworks.
 Please let us know what you would like to see added at https://github.com/generaltranslation/gt/issues`);
         exitSync(0);
     }
@@ -130,10 +134,12 @@ Please let us know what you would like to see added at https://github.com/genera
     if (!formatter || filesUpdated.length === 0) {
         return;
     }
-    const applyFormatting = await promptConfirm({
-        message: `Would you like the wizard to auto-format the modified files? ${chalk.dim(`(${formatter})`)}`,
-        defaultValue: true,
-    });
+    const applyFormatting = useDefaults
+        ? true
+        : await promptConfirm({
+            message: `Would you like the wizard to auto-format the modified files? ${chalk.dim(`(${formatter})`)}`,
+            defaultValue: true,
+        });
     // Format updated files if formatters are available
     if (applyFormatting)
         await formatFiles(filesUpdated, formatter);

package/package.json

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