gtx-cli 2.0.8 → 2.0.9

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # gtx-cli
 
+## 2.0.9
+
+### Patch Changes
+
+- [#497](https://github.com/generaltranslation/gt/pull/497) [`0f44ba0`](https://github.com/generaltranslation/gt/commit/0f44ba0eb1b31f339a43854efe4c64ca2df7e4ca) Thanks [@ErnestM1234](https://github.com/ErnestM1234)! - feat: add customizability for localize static url
+
 ## 2.0.8
 
 ### Patch Changes

package/dist/config/generateSettings.js

@@ -60,6 +60,10 @@ export async function generateSettings(options, cwd = process.cwd()) {
         gtConfig.projectId !== projectIdEnv) {
         logErrorAndExit(`Project ID mismatch between ${chalk.green(gtConfig.projectId)} and ${chalk.green(projectIdEnv)}! Please use the same projectId in all configs.`);
     }
+    if (options.options?.docsUrlPattern &&
+        !options.options?.docsUrlPattern.includes('[locale]')) {
+        logErrorAndExit('Failed to localize static urls: URL pattern must include "[locale]" to denote the location of the locale');
+    }
     // merge options
     const mergedOptions = { ...gtConfig, ...options };
     // merge locales

package/dist/types/index.d.ts

@@ -98,6 +98,7 @@ export type AdditionalOptions = {
     jsonSchema?: {
         [fileGlob: string]: JsonSchema;
     };
+    docsUrlPattern?: string;
 };
 export type JsonSchema = {
     preset?: 'mintlify';

package/dist/utils/localizeStaticUrls.js

@@ -30,23 +30,28 @@ export default async function localizeStaticUrls(settings) {
             // Get file content
             const fileContent = fs.readFileSync(filePath, 'utf8');
             // Localize the file
-            const localizedFile = localizeStaticUrlsForFile(fileContent, settings.defaultLocale, locale, settings.experimentalHideDefaultLocale || false);
+            const localizedFile = localizeStaticUrlsForFile(fileContent, settings.defaultLocale, locale, settings.experimentalHideDefaultLocale || false, settings.options?.docsUrlPattern);
             // Write the localized file to the target path
             await fs.promises.writeFile(filePath, localizedFile);
         }));
     }));
 }
-// Assumption: we will be seeing localized paths in the source files: (docs/en/ -> docs/ja/)
-function localizeStaticUrlsForFile(file, defaultLocale, targetLocale, hideDefaultLocale) {
+// Naive find and replace, in the future, construct an AST
+function localizeStaticUrlsForFile(file, defaultLocale, targetLocale, hideDefaultLocale, pattern = '/[locale]' // eg /docs/[locale] or /[locale]
+) {
+    if (!pattern.startsWith('/')) {
+        pattern = '/' + pattern;
+    }
     // 1. Search for all instances of:
+    const patternHead = pattern.split('[locale]')[0];
     let regex;
     if (hideDefaultLocale) {
         // Match complete markdown links: `](/docs/...)` or `](/docs)`
-        regex = new RegExp(`\\]\\(/docs(?:/([^)]*))?\\)`, 'g');
+        regex = new RegExp(`\\]\\(${patternHead}(?:/([^)]*))?\\)`, 'g');
     }
     else {
         // Match complete markdown links with default locale: `](/docs/${defaultLocale}/...)` or `](/docs/${defaultLocale})`
-        regex = new RegExp(`\\]\\(/docs/${defaultLocale}(?:/([^)]*))?\\)`, 'g');
+        regex = new RegExp(`\\]\\(${patternHead}${defaultLocale}(?:/([^)]*))?\\)`, 'g');
     }
     const matches = file.match(regex);
     if (!matches) {
@@ -64,14 +69,14 @@ function localizeStaticUrlsForFile(file, defaultLocale, targetLocale, hideDefaul
             }
             // Add target locale to the path
             if (!pathContent || pathContent === '') {
-                return `](/docs/${targetLocale})`;
+                return `](${patternHead}${targetLocale})`;
             }
-            return `](/docs/${targetLocale}/${pathContent})`;
+            return `](${patternHead}${targetLocale}/${pathContent})`;
         }
         else {
             // For non-hideDefaultLocale, replace defaultLocale with targetLocale
             // pathContent contains everything after the default locale (no leading slash if present)
-            return `](/docs/${targetLocale}${pathContent ? '/' + pathContent : ''})`;
+            return `](${patternHead}${targetLocale}${pathContent ? '/' + pathContent : ''})`;
         }
     });
     return localizedFile;

package/package.json

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