gtx-cli 2.0.23-alpha.0 → 2.0.24

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # gtx-cli
 
+## 2.0.24
+
+### Patch Changes
+
+- [#552](https://github.com/generaltranslation/gt/pull/552) [`65acf00`](https://github.com/generaltranslation/gt/commit/65acf0085a2b2c89f46b6b4685d94815a16467e6) Thanks [@brian-lou](https://github.com/brian-lou)! - Remove wizard auto-add T components
+
+## 2.0.23
+
+### Patch Changes
+
+- [#539](https://github.com/generaltranslation/gt/pull/539) [`b88e468`](https://github.com/generaltranslation/gt/commit/b88e4684be9cd82a7d23e38fc893c2a8b7f0165f) Thanks [@ErnestM1234](https://github.com/ErnestM1234)! - feat: add ability to exclude import paths and url paths from localization
+
 ## 2.0.22
 
 ### Patch Changes

package/dist/cli/base.d.ts

@@ -17,7 +17,8 @@ export type TranslateOptions = {
     experimentalHideDefaultLocale?: boolean;
     experimentalFlattenJsonFiles?: boolean;
     experimentalLocalizeStaticImports?: boolean;
-    experimentalExcludeStaticUrls?: string[];
+    excludeStaticUrls?: string[];
+    excludeStaticImports?: string[];
 };
 export type LoginOptions = {
     keyType?: 'development' | 'production';

package/dist/setup/wizard.js

@@ -1,13 +1,12 @@
 import { detectFormatter } from '../hooks/postProcess.js';
-import { createSpinner, logMessage, promptSelect } from '../console/logging.js';
-import { logInfo, logError, logSuccess, logStep, logWarning, } from '../console/logging.js';
+import { createSpinner, promptSelect } from '../console/logging.js';
+import { logInfo, logError, logStep, logWarning } from '../console/logging.js';
 import chalk from 'chalk';
 import { promptConfirm } from '../console/logging.js';
 import findFilepath from '../fs/findFilepath.js';
 import { formatFiles } from '../hooks/postProcess.js';
 import { handleInitGT } from '../next/parse/handleInitGT.js';
 import { getPackageJson, isPackageInstalled } from '../utils/packageJson.js';
-import { wrapContentReact } from '../react/parse/wrapContent.js';
 import { wrapContentNext } from '../next/parse/wrapContent.js';
 import { getPackageManager } from '../utils/packageManager.js';
 import { installPackage } from '../utils/installPackage.js';
@@ -86,75 +85,28 @@ Please let us know what you would like to see supported at https://github.com/ge
             logError('No next.config.[js|ts|mjs|mts] file found.');
             process.exit(1);
         }
-        const addGTProvider = await promptConfirm({
-            message: 'Do you want the setup wizard to automatically add the GTProvider component?',
-            defaultValue: true,
-        });
-        const addWithGTConfig = await promptConfirm({
-            message: `Do you want to automatically add withGTConfig() to your ${nextConfigPath}?`,
-            defaultValue: true,
-        });
-        const includeTId = await promptConfirm({
-            message: 'Do you want to include an unique id for each <T> tag?',
-            defaultValue: true,
-        });
         const mergeOptions = {
             ...options,
-            disableIds: !includeTId,
+            disableIds: true,
             disableFormatting: true,
-            skipTs: false,
-            addGTProvider,
+            skipTs: true,
+            addGTProvider: true,
         };
         const spinner = createSpinner();
         spinner.start('Wrapping JSX content with <T> tags...');
         // Wrap all JSX elements in the src directory with a <T> tag, with unique ids
         const { filesUpdated: filesUpdatedNext } = await wrapContentNext(mergeOptions, 'gt-next', errors, warnings);
         filesUpdated = [...filesUpdated, ...filesUpdatedNext];
-        spinner.stop(chalk.green(`Success! Added <T> tags and updated ${chalk.bold.cyan(filesUpdated.length)} files:\n`) + filesUpdated.map((file) => `${chalk.green('-')} ${file}`).join('\n'));
-        if (addWithGTConfig) {
-            // Read tsconfig.json if it exists
-            const tsconfigPath = findFilepath(['tsconfig.json']);
-            const tsconfigJson = tsconfigPath ? loadConfig(tsconfigPath) : undefined;
-            // Add the withGTConfig() function to the next.config.js file
-            await handleInitGT(nextConfigPath, errors, warnings, filesUpdated, packageJson, tsconfigJson);
-            logStep(chalk.green(`Added withGTConfig() to your ${nextConfigPath} file.`));
-        }
-        if (errors.length > 0) {
-            logError(chalk.red('Failed to write files:\n') + errors.join('\n'));
-        }
-        logSuccess(chalk.green(`Success! All JSX content has been wrapped with <T> tags${includeTId ? ' and unique ids.' : '.'}`));
-        logMessage(`To translate strings, see the docs on useGT and getGT: https://generaltranslation.com/docs/next/api/strings/getGT`);
+        spinner.stop(chalk.green(`Success! Updated ${chalk.bold.cyan(filesUpdated.length)} files:\n`) + filesUpdated.map((file) => `${chalk.green('-')} ${file}`).join('\n'));
+        // Read tsconfig.json if it exists
+        const tsconfigPath = findFilepath(['tsconfig.json']);
+        const tsconfigJson = tsconfigPath ? loadConfig(tsconfigPath) : undefined;
+        // Add the withGTConfig() function to the next.config.js file
+        await handleInitGT(nextConfigPath, errors, warnings, filesUpdated, packageJson, tsconfigJson);
+        logStep(chalk.green(`Added withGTConfig() to your ${nextConfigPath} file.`));
     }
-    else {
-        let addGTProvider = false;
-        if (frameworkType === 'next-pages') {
-            addGTProvider = await promptConfirm({
-                message: 'Do you want the setup wizard to automatically add the GTProvider component?',
-                defaultValue: true,
-            });
-        }
-        const includeTId = await promptConfirm({
-            message: 'Do you want to include an unique id for each <T> tag?',
-            defaultValue: true,
-        });
-        const mergeOptions = {
-            ...options,
-            disableIds: !includeTId,
-            disableFormatting: true,
-            skipTs: false,
-            addGTProvider,
-        };
-        const spinner = createSpinner();
-        spinner.start('Wrapping JSX content with <T> tags...');
-        // Wrap all JSX elements in the src directory with a <T> tag, with unique ids
-        const { filesUpdated: filesUpdatedReact } = await wrapContentReact(mergeOptions, 'gt-react', frameworkType, errors, warnings);
-        filesUpdated = [...filesUpdated, ...filesUpdatedReact];
-        spinner.stop(chalk.green(`Success! Added <T> tags and updated ${chalk.bold.cyan(filesUpdated.length)} files:\n`) + filesUpdated.map((file) => `${chalk.green('-')} ${file}`).join('\n'));
-        if (errors.length > 0) {
-            logError(chalk.red('Failed to write files:\n') + errors.join('\n'));
-        }
-        logSuccess(chalk.green(`Success! All JSX content has been wrapped with <T> tags${includeTId ? ' and unique ids.' : '.'}`));
-        logMessage(`To translate strings, see the docs on useGT: https://generaltranslation.com/docs/react/api/strings/useGT`);
+    if (errors.length > 0) {
+        logError(chalk.red('Failed to write files:\n') + errors.join('\n'));
     }
     if (warnings.length > 0) {
         logWarning(chalk.yellow('Warnings encountered:') +

package/dist/types/index.d.ts

@@ -108,14 +108,14 @@ export type AdditionalOptions = {
     };
     docsUrlPattern?: string;
     docsImportPattern?: string;
+    excludeStaticUrls?: string[];
+    excludeStaticImports?: string[];
     docsHideDefaultLocaleImport?: boolean;
     copyFiles?: string[];
     experimentalLocalizeStaticImports?: boolean;
     experimentalLocalizeStaticUrls?: boolean;
     experimentalHideDefaultLocale?: boolean;
     experimentalFlattenJsonFiles?: boolean;
-    experimentalExcludeStaticUrls?: string[];
-    experimentalExcludeStaticImports?: string[];
 };
 export type JsonSchema = {
     preset?: 'mintlify';

package/dist/utils/localizeStaticImports.js

@@ -33,7 +33,7 @@ export default async function localizeStaticImports(settings) {
             // Get file content
             const fileContent = await fs.promises.readFile(filePath, 'utf8');
             // Localize the file
-            const localizedFile = localizeStaticImportsForFile(fileContent, settings.defaultLocale, locale, settings.options?.docsHideDefaultLocaleImport || false, settings.options?.docsImportPattern, settings.options?.experimentalExcludeStaticImports);
+            const localizedFile = localizeStaticImportsForFile(fileContent, settings.defaultLocale, locale, settings.options?.docsHideDefaultLocaleImport || false, settings.options?.docsImportPattern, settings.options?.excludeStaticImports);
             // Write the localized file to the target path
             await fs.promises.writeFile(filePath, localizedFile);
         }));
@@ -69,12 +69,18 @@ exclude = []) {
     const localizedFile = file.replace(regex, (match, bindings, quoteType, pathContent) => {
         // Check if this path should be excluded from localization
         if (exclude.length > 0) {
-            let matchPath = patternHead;
+            let matchPath = '';
+            // let matchPath = patternHead;
             if (pathContent) {
                 matchPath = hideDefaultLocale
                     ? `${patternHead}${pathContent}`
                     : `${patternHead}${defaultLocale}/${pathContent}`;
             }
+            else {
+                matchPath = hideDefaultLocale
+                    ? `${patternHead}`
+                    : `${patternHead}${defaultLocale}`;
+            }
             if (exclude.some((pattern) => isMatch(matchPath, pattern))) {
                 return match; // Don't localize excluded paths
             }

package/dist/utils/localizeStaticUrls.js

@@ -32,8 +32,8 @@ export default async function localizeStaticUrls(settings) {
             // Get file content
             const fileContent = await fs.promises.readFile(filePath, 'utf8');
             // Localize the file
-            const localizedFile = localizeStaticUrlsForFile(fileContent, settings.defaultLocale, locale, settings.experimentalHideDefaultLocale || false, settings.options?.docsUrlPattern, settings.options?.experimentalExcludeStaticUrls);
-            const localizedFileHrefs = localizeStaticHrefsForFile(localizedFile, settings.defaultLocale, locale, settings.experimentalHideDefaultLocale || false, settings.options?.docsUrlPattern, settings.options?.experimentalExcludeStaticUrls);
+            const localizedFile = localizeStaticUrlsForFile(fileContent, settings.defaultLocale, locale, settings.experimentalHideDefaultLocale || false, settings.options?.docsUrlPattern, settings.options?.excludeStaticUrls);
+            const localizedFileHrefs = localizeStaticHrefsForFile(localizedFile, settings.defaultLocale, locale, settings.experimentalHideDefaultLocale || false, settings.options?.docsUrlPattern, settings.options?.excludeStaticUrls);
             // Write the localized file to the target path
             await fs.promises.writeFile(filePath, localizedFileHrefs);
         }));
@@ -69,12 +69,17 @@ exclude = []) {
     const localizedFile = file.replace(regex, (match, pathContent) => {
         if (exclude.length > 0) {
             // Check if this path should be excluded from localization
-            let matchPath = patternHead;
+            let matchPath = '';
             if (pathContent) {
                 matchPath = hideDefaultLocale
                     ? `${patternHead}${pathContent}`
                     : `${patternHead}${defaultLocale}/${pathContent}`;
             }
+            else {
+                matchPath = hideDefaultLocale
+                    ? `${patternHead}`
+                    : `${patternHead}${defaultLocale}`;
+            }
             if (exclude.some((pattern) => isMatch(matchPath, pattern))) {
                 return match; // Don't localize excluded paths
             }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gtx-cli",
-  "version": "2.0.23-alpha.0",
+  "version": "2.0.24",
   "main": "dist/index.js",
   "bin": "dist/main.js",
   "files": [