gtx-cli 2.0.22 → 2.0.23

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # gtx-cli
 
+## 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,6 +17,8 @@ export type TranslateOptions = {
     experimentalHideDefaultLocale?: boolean;
     experimentalFlattenJsonFiles?: boolean;
     experimentalLocalizeStaticImports?: boolean;
+    excludeStaticUrls?: string[];
+    excludeStaticImports?: string[];
 };
 export type LoginOptions = {
     keyType?: 'development' | 'production';

package/dist/config/generateSettings.js

@@ -109,10 +109,14 @@ export async function generateSettings(options, cwd = process.cwd()) {
         : undefined;
     mergedOptions = {
         ...mergedOptions,
-        experimentalLocalizeStaticImports: gtConfig.options?.experimentalLocalizeStaticImports,
-        experimentalLocalizeStaticUrls: gtConfig.options?.experimentalLocalizeStaticUrls,
-        experimentalHideDefaultLocale: gtConfig.options?.experimentalHideDefaultLocale,
-        experimentalFlattenJsonFiles: gtConfig.options?.experimentalFlattenJsonFiles,
+        experimentalLocalizeStaticImports: gtConfig.options?.experimentalLocalizeStaticImports ||
+            options.experimentalLocalizeStaticImports,
+        experimentalLocalizeStaticUrls: gtConfig.options?.experimentalLocalizeStaticUrls ||
+            options.experimentalLocalizeStaticUrls,
+        experimentalHideDefaultLocale: gtConfig.options?.experimentalHideDefaultLocale ||
+            options.experimentalHideDefaultLocale,
+        experimentalFlattenJsonFiles: gtConfig.options?.experimentalFlattenJsonFiles ||
+            options.experimentalFlattenJsonFiles,
     };
     // Add additional options if provided
     if (mergedOptions.options) {

package/dist/formats/json/utils.js

@@ -2,8 +2,8 @@ import { getLocaleProperties } from 'generaltranslation';
 import { exit, logError } from '../../console/logging.js';
 import { JSONPath } from 'jsonpath-plus';
 import { flattenJson } from './flattenJson.js';
-import micromatch from 'micromatch';
 import path from 'node:path';
+import micromatch from 'micromatch';
 const { isMatch } = micromatch;
 // Find the matching source item in an array
 // where the key matches the identifying locale property

package/dist/types/index.d.ts

@@ -108,6 +108,8 @@ export type AdditionalOptions = {
     };
     docsUrlPattern?: string;
     docsImportPattern?: string;
+    excludeStaticUrls?: string[];
+    excludeStaticImports?: string[];
     docsHideDefaultLocaleImport?: boolean;
     copyFiles?: string[];
     experimentalLocalizeStaticImports?: boolean;

package/dist/utils/localizeStaticImports.js

@@ -1,6 +1,8 @@
 import * as fs from 'fs';
 import { createFileMapping } from '../formats/files/fileMapping.js';
 import { logError } from '../console/logging.js';
+import micromatch from 'micromatch';
+const { isMatch } = micromatch;
 /**
  * Localizes static imports in content files.
  * Currently only supported for md and mdx files. (/docs/ -> /[locale]/docs/)
@@ -31,38 +33,58 @@ 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);
+            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);
         }));
     }));
 }
 // Naive find and replace, in the future, construct an AST
-function localizeStaticImportsForFile(file, defaultLocale, targetLocale, hideDefaultLocale, pattern = '/[locale]' // eg /docs/[locale] or /[locale]
-) {
+function localizeStaticImportsForFile(file, defaultLocale, targetLocale, hideDefaultLocale, pattern = '/[locale]', // eg /docs/[locale] or /[locale]
+exclude = []) {
     if (!pattern.startsWith('/')) {
         pattern = '/' + pattern;
     }
     // 1. Search for all instances of:
     const patternHead = pattern.split('[locale]')[0];
+    // Escape special regex characters and remove trailing slash if present
+    const escapedPatternHead = patternHead
+        .replace(/[.*+?^${}()|[\]\\]/g, '\\$&')
+        .replace(/\/$/, '');
     let regex;
     if (hideDefaultLocale) {
-        const trimmedPatternHead = patternHead.endsWith('/')
-            ? patternHead.slice(0, -1)
-            : patternHead;
-        // Match complete markdown links: `import { Foo } from '@/docs/[locale]/foo.md'`
-        regex = new RegExp(`import\\s+(.*?)\\s+from\\s+(["'])${trimmedPatternHead}(.*?)\\2`, 'g');
+        // Match complete import statements: `import { Foo } from '/docs/foo.md'`
+        regex = new RegExp(`import\\s+(.*?)\\s+from\\s+(["'])${escapedPatternHead}(?:/([^"']*?))?\\2`, 'g');
     }
     else {
-        // Match complete markdown links with default locale: `import { Foo } from '@/docs/${defaultLocale}/foo.md'`
-        regex = new RegExp(`import\\s+(.*?)\\s+from\\s+(["'])${patternHead}${defaultLocale}(.*?)\\2`, 'g');
+        // Match complete import statements with default locale: `import { Foo } from '/docs/${defaultLocale}/foo.md'`
+        regex = new RegExp(`import\\s+(.*?)\\s+from\\s+(["'])${escapedPatternHead}/${defaultLocale}(?:/([^"']*?))?\\2`, 'g');
     }
     const matches = file.match(regex);
     if (!matches) {
         return file;
     }
+    exclude = exclude.map((pattern) => pattern.replace(/\[locale\]/g, defaultLocale));
     // 2. Replace the default locale with the target locale in all matched instances
     const localizedFile = file.replace(regex, (match, bindings, quoteType, pathContent) => {
+        // Check if this path should be excluded from localization
+        if (exclude.length > 0) {
+            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
+            }
+        }
         // get the quote type
         quoteType = match.match(/["']/)?.[0] || '"';
         if (!quoteType) {
@@ -81,12 +103,12 @@ function localizeStaticImportsForFile(file, defaultLocale, targetLocale, hideDef
             if (!pathContent || pathContent === '') {
                 return `import ${bindings} from ${quoteType}${patternHead}${targetLocale}${quoteType}`;
             }
-            return `import ${bindings} from ${quoteType}${patternHead}${targetLocale}${pathContent}${quoteType}`;
+            return `import ${bindings} from ${quoteType}${patternHead}${targetLocale}/${pathContent}${quoteType}`;
         }
         else {
             // For non-hideDefaultLocale, replace defaultLocale with targetLocale
             // pathContent contains everything after the default locale (no leading slash if present)
-            return `import ${bindings} from ${quoteType}${patternHead}${targetLocale}${pathContent}${quoteType}`;
+            return `import ${bindings} from ${quoteType}${patternHead}${targetLocale}${pathContent ? '/' + pathContent : ''}${quoteType}`;
         }
     });
     return localizedFile;

package/dist/utils/localizeStaticUrls.js

@@ -1,5 +1,7 @@
 import * as fs from 'fs';
 import { createFileMapping } from '../formats/files/fileMapping.js';
+import micromatch from 'micromatch';
+const { isMatch } = micromatch;
 /**
  * Localizes static urls in content files.
  * Currently only supported for md and mdx files. (/docs/ -> /[locale]/docs/)
@@ -30,16 +32,16 @@ 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);
-            const localizedFileHrefs = localizeStaticHrefsForFile(localizedFile, settings.defaultLocale, locale, settings.experimentalHideDefaultLocale || false, settings.options?.docsUrlPattern);
+            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);
         }));
     }));
 }
 // Naive find and replace, in the future, construct an AST
-function localizeStaticUrlsForFile(file, defaultLocale, targetLocale, hideDefaultLocale, pattern = '/[locale]' // eg /docs/[locale] or /[locale]
-) {
+function localizeStaticUrlsForFile(file, defaultLocale, targetLocale, hideDefaultLocale, pattern = '/[locale]', // eg /docs/[locale] or /[locale]
+exclude = []) {
     if (!pattern.startsWith('/')) {
         pattern = '/' + pattern;
     }
@@ -62,8 +64,26 @@ function localizeStaticUrlsForFile(file, defaultLocale, targetLocale, hideDefaul
     if (!matches) {
         return file;
     }
+    exclude = exclude.map((pattern) => pattern.replace(/\[locale\]/g, defaultLocale));
     // 2. Replace the default locale with the target locale in all matched instances
     const localizedFile = file.replace(regex, (match, pathContent) => {
+        if (exclude.length > 0) {
+            // Check if this path should be excluded from localization
+            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
+            }
+        }
         if (hideDefaultLocale) {
             // For hideDefaultLocale, check if path already has target locale
             if (pathContent) {
@@ -81,13 +101,14 @@ function localizeStaticUrlsForFile(file, defaultLocale, targetLocale, hideDefaul
         else {
             // For non-hideDefaultLocale, replace defaultLocale with targetLocale
             // pathContent contains everything after the default locale (no leading slash if present)
-            return `](${patternHead}${targetLocale}${pathContent ? '/' + pathContent : ''})`;
+            const result = `](${patternHead}${targetLocale}${pathContent ? '/' + pathContent : ''})`;
+            return result;
         }
     });
     return localizedFile;
 }
-function localizeStaticHrefsForFile(file, defaultLocale, targetLocale, hideDefaultLocale, pattern = '/[locale]' // eg /docs/[locale] or /[locale]
-) {
+function localizeStaticHrefsForFile(file, defaultLocale, targetLocale, hideDefaultLocale, pattern = '/[locale]', // eg /docs/[locale] or /[locale]
+exclude = []) {
     if (!pattern.startsWith('/')) {
         pattern = '/' + pattern;
     }
@@ -110,8 +131,21 @@ function localizeStaticHrefsForFile(file, defaultLocale, targetLocale, hideDefau
     if (!matches) {
         return file;
     }
+    exclude = exclude.map((pattern) => pattern.replace(/\[locale\]/g, defaultLocale));
     // 2. Replace the default locale with the target locale in all matched instances
     const localizedFile = file.replace(regex, (match, pathContent) => {
+        // Check if this path should be excluded from localization
+        if (exclude.length > 0) {
+            let matchPath = patternHead;
+            if (pathContent) {
+                matchPath = hideDefaultLocale
+                    ? `${patternHead}${pathContent}`
+                    : `${patternHead}${defaultLocale}/${pathContent}`;
+            }
+            if (exclude.some((pattern) => isMatch(matchPath, pattern))) {
+                return match; // Don't localize excluded paths
+            }
+        }
         if (hideDefaultLocale) {
             // For hideDefaultLocale, check if path already has target locale
             if (pathContent) {

package/package.json

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