gtx-cli 1.2.0-alpha.1 → 1.2.0-alpha.3

package/dist/cli/base.js

@@ -60,6 +60,8 @@ const supportedFiles_1 = require("../formats/files/supportedFiles");
 const wizard_1 = require("../setup/wizard");
 const packageJson_1 = require("../utils/packageJson");
 const userInput_1 = require("../setup/userInput");
+const installPackage_1 = require("../utils/installPackage");
+const packageManager_1 = require("../utils/packageManager");
 class BaseCLI {
     // Constructor is shared amongst all CLI class types
     constructor(library, additionalModules) {
@@ -112,7 +114,9 @@ class BaseCLI {
                 if (wrap) {
                     (0, console_1.logInfo)(`${chalk_1.default.yellow('[EXPERIMENTAL]')} Running React setup wizard...`);
                     yield this.handleSetupReactCommand(options);
-                    (0, console_1.endCommand)(`Done! We've automatically wrapped all of your JSX components for you.`);
+                    (0, console_1.endCommand)(`Done! Since this wizard is experimental, please review the changes and make modifications as needed.
+Certain aspects of your app may still need manual setup.
+See the docs for more information: https://generaltranslation.com/docs/react/tutorials/quickstart`);
                     ranReactSetup = true;
                 }
             }
@@ -121,7 +125,7 @@ class BaseCLI {
             }
             // Configure gt.config.json
             yield this.handleInitCommand(ranReactSetup);
-            (0, console_1.endCommand)("Done! Take advantage of all of General Translation's features by signing up for a free account! https://generaltranslation.com/signup");
+            (0, console_1.endCommand)('Done! Remember to get an API key and project ID from the dashboard! https://dash.generaltranslation.com');
         }));
     }
     setupConfigureCommand() {
@@ -259,9 +263,20 @@ class BaseCLI {
             (0, setupConfig_1.default)(configFilepath, {
                 defaultLocale,
                 locales,
-                files,
+                files: Object.keys(files).length > 0 ? files : undefined,
             });
             (0, console_1.logSuccess)(`Feel free to edit ${chalk_1.default.cyan(configFilepath)} to customize your translation setup. Docs: https://generaltranslation.com/docs/cli/reference/config`);
+            // Install gtx-cli if not installed
+            const isCLIInstalled = packageJson
+                ? (0, packageJson_1.isPackageInstalled)('gtx-cli', packageJson, true, true)
+                : true; // if no package.json, we can't install it
+            if (!isCLIInstalled) {
+                const packageManager = yield (0, packageManager_1.getPackageManager)();
+                const spinner = (0, console_1.createSpinner)();
+                spinner.start(`Installing gtx-cli as a dev dependency with ${packageManager.name}...`);
+                yield (0, installPackage_1.installPackage)('gtx-cli', packageManager, true);
+                spinner.stop(chalk_1.default.green('Installed gtx-cli.'));
+            }
         });
     }
 }

package/dist/console/logging.d.ts

@@ -22,7 +22,7 @@ export declare function promptText({ message, defaultValue, validate, }: {
     defaultValue?: string;
     validate?: (value: string) => boolean | string;
 }): Promise<string>;
-export declare function promptSelect<T extends string>({ message, options, defaultValue, }: {
+export declare function promptSelect<T>({ message, options, defaultValue, }: {
     message: string;
     options: Array<{
         value: T;

package/dist/setup/wizard.js

@@ -64,31 +64,19 @@ Please let us know what you would like to see supported at https://github.com/ge
         // Check if gt-next or gt-react is installed
         if (frameworkType === 'next-app' &&
             !(0, packageJson_1.isPackageInstalled)('gt-next', packageJson)) {
-            const packageManager = (0, packageManager_1.getPackageManager)();
-            if (packageManager) {
-                const spinner = (0, console_1.createSpinner)('timer');
-                spinner.start('Installing gt-next...');
-                yield (0, installPackage_1.installPackage)('gt-next', packageManager);
-                spinner.stop(chalk_1.default.green('Automatically installed gt-next.'));
-            }
-            else {
-                (0, console_2.logInfo)('Please first install gt-next as a dependency, then re-run this command.');
-                process.exit(0);
-            }
+            const packageManager = yield (0, packageManager_1.getPackageManager)();
+            const spinner = (0, console_1.createSpinner)('timer');
+            spinner.start(`Installing gt-next with ${packageManager.name}...`);
+            yield (0, installPackage_1.installPackage)('gt-next', packageManager);
+            spinner.stop(chalk_1.default.green('Automatically installed gt-next.'));
         }
         else if (['next-pages', 'react', 'redwood', 'vite', 'gatsby'].includes(frameworkType) &&
             !(0, packageJson_1.isPackageInstalled)('gt-react', packageJson)) {
-            const packageManager = (0, packageManager_1.getPackageManager)();
-            if (packageManager) {
-                const spinner = (0, console_1.createSpinner)('timer');
-                spinner.start('Installing gt-react...');
-                yield (0, installPackage_1.installPackage)('gt-react', packageManager);
-                spinner.stop(chalk_1.default.green('Automatically installed gt-react.'));
-            }
-            else {
-                (0, console_2.logInfo)('Please first install gt-react as a dependency, then re-run this command.');
-                process.exit(0);
-            }
+            const packageManager = yield (0, packageManager_1.getPackageManager)();
+            const spinner = (0, console_1.createSpinner)('timer');
+            spinner.start(`Installing gt-react with ${packageManager.name}...`);
+            yield (0, installPackage_1.installPackage)('gt-react', packageManager);
+            spinner.stop(chalk_1.default.green('Automatically installed gt-react.'));
         }
         // ----- Create a starter gt.config.json file -----
         (0, generateSettings_1.generateSettings)(options);
@@ -125,9 +113,7 @@ Please let us know what you would like to see supported at https://github.com/ge
             // Wrap all JSX elements in the src directory with a <T> tag, with unique ids
             const { filesUpdated: filesUpdatedNext } = yield (0, scanForContent_2.default)(mergeOptions, 'gt-next', errors, warnings);
             filesUpdated = [...filesUpdated, ...filesUpdatedNext];
-            spinner.stop(chalk_1.default.green('Added <T> tags and updated ') +
-                chalk_1.default.bold.cyan(filesUpdatedNext.length) +
-                chalk_1.default.green(' files.'));
+            spinner.stop(chalk_1.default.green(`Success! Added <T> tags and updated ${chalk_1.default.bold.cyan(filesUpdated.length)} files:\n`) + filesUpdated.map((file) => `${chalk_1.default.green('-')} ${file}`).join('\n'));
             if (addWithGTConfig) {
                 // Add the withGTConfig() function to the next.config.js file
                 yield (0, handleInitGT_1.default)(nextConfigPath, errors, warnings, filesUpdated);
@@ -157,9 +143,7 @@ Please let us know what you would like to see supported at https://github.com/ge
             // Wrap all JSX elements in the src directory with a <T> tag, with unique ids
             const { filesUpdated: filesUpdatedReact } = yield (0, scanForContent_1.default)(mergeOptions, 'gt-react', frameworkType, errors, warnings);
             filesUpdated = [...filesUpdated, ...filesUpdatedReact];
-            spinner.stop(chalk_1.default.green('Added <T> tags and updated ') +
-                chalk_1.default.bold.cyan(filesUpdatedReact.length) +
-                chalk_1.default.green(' files.'));
+            spinner.stop(chalk_1.default.green(`Success! Added <T> tags and updated ${chalk_1.default.bold.cyan(filesUpdated.length)} files:\n`) + filesUpdated.map((file) => `${chalk_1.default.green('-')} ${file}`).join('\n'));
             if (errors.length > 0) {
                 (0, console_2.logError)(chalk_1.default.red('Failed to write files:\n') + errors.join('\n'));
             }
@@ -182,8 +166,5 @@ Please let us know what you would like to see supported at https://github.com/ge
         // Format updated files if formatters are available
         if (applyFormatting)
             yield (0, postProcess_2.formatFiles)(filesUpdated, formatter);
-        if (filesUpdated.length > 0) {
-            (0, console_2.logStep)('Please review the changes before committing.');
-        }
     });
 }

package/dist/utils/installPackage.d.ts

@@ -1,2 +1,2 @@
 import { PackageManager } from './packageManager';
-export declare function installPackage(packageName: string, packageManager: PackageManager): Promise<void>;
+export declare function installPackage(packageName: string, packageManager: PackageManager, asDevDependency?: boolean): Promise<void>;

package/dist/utils/installPackage.js

@@ -16,11 +16,14 @@ exports.installPackage = installPackage;
 const chalk_1 = __importDefault(require("chalk"));
 const child_process_1 = require("child_process");
 const console_1 = require("../console");
-function installPackage(packageName, packageManager) {
+function installPackage(packageName, packageManager, asDevDependency) {
     return __awaiter(this, void 0, void 0, function* () {
         return new Promise((resolve, reject) => {
             const command = packageManager.name;
             const args = [packageManager.installCommand, packageName];
+            if (asDevDependency) {
+                args.push(packageManager.devDependencyFlag);
+            }
             const childProcess = (0, child_process_1.spawn)(command, args, {
                 stdio: ['pipe', 'ignore', 'pipe'],
             });

package/dist/utils/packageJson.d.ts

@@ -1,5 +1,5 @@
 export declare function searchForPackageJson(): Record<string, any> | null;
 export declare function getPackageJson(): Record<string, any>;
 export declare function updatePackageJson(packageJson: Record<string, any>): void;
-export declare function isPackageInstalled(packageName: string, packageJson: Record<string, any>, asDevDependency?: boolean): boolean;
+export declare function isPackageInstalled(packageName: string, packageJson: Record<string, any>, asDevDependency?: boolean, checkBoth?: boolean): boolean;
 export declare function getPackageVersion(packageName: string, packageJson: Record<string, any>): string | undefined;

package/dist/utils/packageJson.js

@@ -54,8 +54,10 @@ function updatePackageJson(packageJson) {
         process.exit(1);
     }
 }
-function isPackageInstalled(packageName, packageJson, asDevDependency = false) {
-    const dependencies = asDevDependency
+// check if a package is installed in the package.json file
+function isPackageInstalled(packageName, packageJson, asDevDependency = false, checkBoth = false) {
+    const dependencies = checkBoth
+        ? Object.assign(Object.assign({}, packageJson.devDependencies), packageJson.dependencies) : asDevDependency
         ? packageJson.devDependencies
         : packageJson.dependencies;
     if (!dependencies) {

package/dist/utils/packageManager.d.ts

@@ -6,6 +6,7 @@ export interface PackageManager {
     runScriptCommand: string;
     flags: string;
     forceInstallFlag: string;
+    devDependencyFlag: string;
     registry?: string;
     detect: () => boolean;
     addOverride: (pkgName: string, pkgVersion: string) => Promise<void>;
@@ -18,4 +19,5 @@ export declare const YARN_V2: PackageManager;
 export declare const PNPM: PackageManager;
 export declare const NPM: PackageManager;
 export declare const packageManagers: PackageManager[];
-export declare function getPackageManager(managers?: PackageManager[]): PackageManager | null;
+export declare function _detectPackageManger(managers?: PackageManager[]): PackageManager | null;
+export declare function getPackageManager(): Promise<PackageManager>;

package/dist/utils/packageManager.js

@@ -43,11 +43,13 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.packageManagers = exports.NPM = exports.PNPM = exports.YARN_V2 = exports.YARN_V1 = exports.DENO = exports.BUN = void 0;
+exports._detectPackageManger = _detectPackageManger;
 exports.getPackageManager = getPackageManager;
-// This file is MIT licensed and was adapted from https://github.com/getsentry/sentry-wizard/blob/master/src/utils/package-manager.ts
+// This file is MIT licensed and was adapted from https://github.com/getsentry/sentry-wizard/blob/master/src/utils/package-manager.ts and https://github.com/getsentry/sentry-wizard/blob/master/src/utils/clack/index.ts
 const fs = __importStar(require("fs"));
 const path = __importStar(require("path"));
 const packageJson_1 = require("./packageJson");
+const console_1 = require("../console");
 exports.BUN = {
     name: 'bun',
     label: 'Bun',
@@ -56,6 +58,7 @@ exports.BUN = {
     runScriptCommand: 'bun run',
     flags: '',
     forceInstallFlag: '--force',
+    devDependencyFlag: '--dev',
     detect: () => ['bun.lockb', 'bun.lock'].some((lockFile) => {
         try {
             return fs.existsSync(path.join(process.cwd(), lockFile));
@@ -78,6 +81,7 @@ exports.DENO = {
     runScriptCommand: 'deno task',
     flags: '',
     forceInstallFlag: '--force',
+    devDependencyFlag: '--dev',
     registry: 'npm',
     detect: () => {
         try {
@@ -101,6 +105,7 @@ exports.YARN_V1 = {
     runScriptCommand: 'yarn',
     flags: '--ignore-workspace-root-check',
     forceInstallFlag: '--force',
+    devDependencyFlag: '--dev',
     detect: () => {
         try {
             return fs
@@ -127,6 +132,7 @@ exports.YARN_V2 = {
     runScriptCommand: 'yarn',
     flags: '',
     forceInstallFlag: '--force',
+    devDependencyFlag: '--dev',
     detect: () => {
         try {
             return fs
@@ -152,6 +158,7 @@ exports.PNPM = {
     runScriptCommand: 'pnpm',
     flags: '--ignore-workspace-root-check',
     forceInstallFlag: '--force',
+    devDependencyFlag: '--save-dev',
     detect: () => {
         try {
             return fs.existsSync(path.join(process.cwd(), 'pnpm-lock.yaml'));
@@ -175,6 +182,7 @@ exports.NPM = {
     runScriptCommand: 'npm run',
     flags: '',
     forceInstallFlag: '--force',
+    devDependencyFlag: '--save-dev',
     detect: () => {
         try {
             return fs.existsSync(path.join(process.cwd(), 'package-lock.json'));
@@ -190,7 +198,7 @@ exports.NPM = {
     }),
 };
 exports.packageManagers = [exports.NPM, exports.YARN_V1, exports.YARN_V2, exports.PNPM, exports.BUN, exports.DENO];
-function getPackageManager(managers) {
+function _detectPackageManger(managers) {
     const foundPackageMangers = (managers !== null && managers !== void 0 ? managers : exports.packageManagers).filter((packageManager) => packageManager.detect());
     // Only consider a package manager detected if we found exactly one.
     // If we find more than one, we should not make any assumptions.
@@ -199,3 +207,27 @@ function getPackageManager(managers) {
     }
     return null;
 }
+// Get the package manager for the current project
+// Uses a global cache to avoid prompting the user multiple times
+function getPackageManager() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const globalWizard = global;
+        if (globalWizard._gt_wizard_cached_package_manager) {
+            return globalWizard._gt_wizard_cached_package_manager;
+        }
+        const detectedPackageManager = _detectPackageManger();
+        if (detectedPackageManager) {
+            globalWizard._gt_wizard_cached_package_manager = detectedPackageManager;
+            return detectedPackageManager;
+        }
+        const selectedPackageManager = yield (0, console_1.promptSelect)({
+            message: 'Please select your package manager.',
+            options: exports.packageManagers.map((packageManager) => ({
+                value: packageManager,
+                label: packageManager.label,
+            })),
+        });
+        globalWizard._gt_wizard_cached_package_manager = selectedPackageManager;
+        return selectedPackageManager;
+    });
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gtx-cli",
-  "version": "1.2.0-alpha.1",
+  "version": "1.2.0-alpha.3",
   "type": "commonjs",
   "main": "dist/index.js",
   "bin": "dist/main.js",