gtx-cli 2.6.4 → 2.6.5

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # gtx-cli
 
+## 2.6.5
+
+### Patch Changes
+
+- [#971](https://github.com/generaltranslation/gt/pull/971) [`821b0f0`](https://github.com/generaltranslation/gt/commit/821b0f05bab247e4d4c91cabc3ccfd45d672d25f) Thanks [@fernando-aviles](https://github.com/fernando-aviles)! - Adding `experimentalLocalizeRelativeAssets` config option to handle asset paths
+
 ## 2.6.4
 
 ### Patch Changes

package/dist/cli/commands/translate.js

@@ -4,6 +4,7 @@ import { getStagedVersions } from '../../fs/config/updateVersions.js';
 import copyFile from '../../fs/copyFile.js';
 import flattenJsonFiles from '../../utils/flattenJsonFiles.js';
 import localizeStaticUrls from '../../utils/localizeStaticUrls.js';
+import localizeRelativeAssets from '../../utils/localizeRelativeAssets.js';
 import processAnchorIds from '../../utils/processAnchorIds.js';
 import processOpenApi from '../../utils/processOpenApi.js';
 import { noFilesError, noVersionIdError } from '../../console/index.js';
@@ -48,6 +49,13 @@ export async function postProcessTranslations(settings, includeFiles) {
             await localizeStaticUrls(settings, nonDefaultLocales, includeFiles);
         }
     }
+    // Rewrite relative asset URLs in translated md/mdx files
+    if (settings.options?.experimentalLocalizeRelativeAssets) {
+        const nonDefaultLocales = settings.locales.filter((locale) => locale !== settings.defaultLocale);
+        if (nonDefaultLocales.length > 0) {
+            await localizeRelativeAssets(settings, nonDefaultLocales, includeFiles);
+        }
+    }
     const shouldProcessAnchorIds = settings.options?.experimentalLocalizeStaticUrls ||
         settings.options?.experimentalAddHeaderAnchorIds;
     // Add explicit anchor IDs to translated MDX/MD files to preserve navigation

package/dist/cli/flags.js

@@ -29,6 +29,7 @@ export function attachTranslateFlags(command) {
         .option('--experimental-hide-default-locale', 'When localizing static locales, hide the default locale from the path', false)
         .option('--experimental-flatten-json-files', 'Triggering this will flatten the json files into a single file. This is useful for projects that have a lot of json files.', false)
         .option('--experimental-localize-static-imports', 'Triggering this will run a script after the cli tool that localizes all static imports in content files. Currently only supported for md and mdx files.', false)
+        .option('--experimental-localize-relative-assets', 'Triggering this will rewrite relative image asset URLs in translated md/mdx files to valid paths.', false)
         .option('--force', 'Force a retranslation, invalidating all existing cached translations if they exist.', false)
         .option('--force-download', 'Force download and overwrite local files, bypassing gt-lock.json checks.', false)
         .option('--experimental-clear-locale-dirs', 'Clear locale directories before downloading new translations', false)

package/dist/config/generateSettings.js

@@ -127,6 +127,8 @@ export async function generateSettings(flags, cwd = process.cwd()) {
             flags.experimentalLocalizeStaticImports,
         experimentalLocalizeStaticUrls: gtConfig.options?.experimentalLocalizeStaticUrls ||
             flags.experimentalLocalizeStaticUrls,
+        experimentalLocalizeRelativeAssets: gtConfig.options?.experimentalLocalizeRelativeAssets ||
+            flags.experimentalLocalizeRelativeAssets,
         experimentalHideDefaultLocale: gtConfig.options?.experimentalHideDefaultLocale ||
             flags.experimentalHideDefaultLocale,
         experimentalFlattenJsonFiles: gtConfig.options?.experimentalFlattenJsonFiles ||

package/dist/generated/version.d.ts

@@ -1 +1 @@
-export declare const PACKAGE_VERSION = "2.6.4";
+export declare const PACKAGE_VERSION = "2.6.5";

package/dist/generated/version.js

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

package/dist/types/index.d.ts

@@ -24,6 +24,7 @@ export type Options = {
     experimentalHideDefaultLocale?: boolean;
     experimentalFlattenJsonFiles?: boolean;
     experimentalLocalizeStaticImports?: boolean;
+    experimentalLocalizeRelativeAssets?: boolean;
     experimentalAddHeaderAnchorIds?: 'mintlify' | 'default';
     docsImportRewrites?: Array<{
         match: string;
@@ -63,6 +64,7 @@ export type TranslateFlags = SharedFlags & {
     experimentalHideDefaultLocale?: boolean;
     experimentalFlattenJsonFiles?: boolean;
     experimentalLocalizeStaticImports?: boolean;
+    experimentalLocalizeRelativeAssets?: boolean;
     experimentalAddHeaderAnchorIds?: 'mintlify' | 'default';
     excludeStaticUrls?: string[];
     excludeStaticImports?: string[];
@@ -198,6 +200,7 @@ export type AdditionalOptions = {
     clearLocaleDirsExclude?: string[];
     experimentalLocalizeStaticImports?: boolean;
     experimentalLocalizeStaticUrls?: boolean;
+    experimentalLocalizeRelativeAssets?: boolean;
     experimentalAddHeaderAnchorIds?: 'mintlify' | 'default';
     experimentalHideDefaultLocale?: boolean;
     experimentalFlattenJsonFiles?: boolean;

package/dist/utils/localizeRelativeAssets.d.ts

@@ -0,0 +1,8 @@
+import { Settings } from '../types/index.js';
+type RewriteResult = {
+    content: string;
+    hasChanges: boolean;
+};
+export declare function localizeRelativeAssetsForContent(content: string, sourcePath: string, targetPath: string, cwd: string): RewriteResult;
+export default function localizeRelativeAssets(settings: Settings, targetLocales?: string[], includeFiles?: Set<string>): Promise<void>;
+export {};

package/dist/utils/localizeRelativeAssets.js

@@ -0,0 +1,165 @@
+import * as fs from 'fs';
+import path from 'node:path';
+import { unified } from 'unified';
+import remarkParse from 'remark-parse';
+import remarkMdx from 'remark-mdx';
+import remarkFrontmatter from 'remark-frontmatter';
+import remarkStringify from 'remark-stringify';
+import { visit } from 'unist-util-visit';
+import escapeHtmlInTextNodes from 'gt-remark';
+import { createFileMapping } from '../formats/files/fileMapping.js';
+function stripQueryAndHash(url) {
+    const match = url.match(/^[^?#]+/);
+    const base = match ? match[0] : url;
+    const suffix = url.slice(base.length);
+    return { base, suffix };
+}
+function isSkippableUrl(url) {
+    if (!url)
+        return true;
+    if (url.startsWith('/'))
+        return true;
+    if (/^(https?:)?\/\//i.test(url))
+        return true;
+    if (url.startsWith('data:'))
+        return true;
+    if (url.startsWith('#'))
+        return true;
+    if (url.startsWith('mailto:'))
+        return true;
+    if (url.startsWith('tel:'))
+        return true;
+    return false;
+}
+function toPosix(p) {
+    return p.replace(/\\/g, '/');
+}
+function isSubPath(child, parent) {
+    const rel = path.relative(parent, child);
+    return rel === '' || (!rel.startsWith('..') && !path.isAbsolute(rel));
+}
+export function localizeRelativeAssetsForContent(content, sourcePath, targetPath, cwd) {
+    let changed = false;
+    let ast;
+    try {
+        const processor = unified()
+            .use(remarkParse)
+            .use(remarkFrontmatter, ['yaml', 'toml'])
+            .use(remarkMdx);
+        ast = processor.runSync(processor.parse(content));
+    }
+    catch {
+        return { content, hasChanges: false };
+    }
+    const sourceDir = path.dirname(sourcePath);
+    const targetDir = path.dirname(targetPath);
+    const maybeRewrite = (url) => {
+        if (isSkippableUrl(url))
+            return null;
+        const { base, suffix } = stripQueryAndHash(url);
+        if (isSkippableUrl(base))
+            return null;
+        const targetResolved = path.resolve(targetDir, base);
+        if (fs.existsSync(targetResolved)) {
+            return null;
+        }
+        const sourceResolved = path.resolve(sourceDir, base);
+        if (!fs.existsSync(sourceResolved)) {
+            return null;
+        }
+        let newPath;
+        if (isSubPath(sourceResolved, cwd)) {
+            newPath = '/' + toPosix(path.relative(cwd, sourceResolved));
+        }
+        else {
+            const rel = toPosix(path.relative(targetDir, sourceResolved));
+            newPath = rel || toPosix(path.basename(sourceResolved));
+        }
+        if (newPath === base)
+            return null;
+        changed = true;
+        return newPath + suffix;
+    };
+    visit(ast, (node) => {
+        if (node.type === 'image' && typeof node.url === 'string') {
+            const newUrl = maybeRewrite(node.url);
+            if (newUrl)
+                node.url = newUrl;
+            return;
+        }
+        if ((node.type === 'mdxJsxFlowElement' ||
+            node.type === 'mdxJsxTextElement') &&
+            node.name === 'img' &&
+            Array.isArray(node.attributes)) {
+            for (const attr of node.attributes) {
+                if (attr &&
+                    attr.type === 'mdxJsxAttribute' &&
+                    attr.name === 'src' &&
+                    typeof attr.value === 'string') {
+                    const newUrl = maybeRewrite(attr.value);
+                    if (newUrl)
+                        attr.value = newUrl;
+                }
+            }
+        }
+    });
+    try {
+        const s = unified()
+            .use(remarkFrontmatter, ['yaml', 'toml'])
+            .use(remarkMdx)
+            .use(escapeHtmlInTextNodes)
+            .use(remarkStringify, {
+            handlers: {
+                text(node) {
+                    return node.value;
+                },
+            },
+        });
+        const outTree = s.runSync(ast);
+        let out = s.stringify(outTree);
+        if (out.endsWith('\n') && !content.endsWith('\n'))
+            out = out.slice(0, -1);
+        if (content.startsWith('\n') && !out.startsWith('\n'))
+            out = '\n' + out;
+        return { content: out, hasChanges: changed };
+    }
+    catch {
+        return { content, hasChanges: false };
+    }
+}
+export default async function localizeRelativeAssets(settings, targetLocales, includeFiles) {
+    if (!settings.files ||
+        (Object.keys(settings.files.placeholderPaths).length === 1 &&
+            settings.files.placeholderPaths.gt)) {
+        return;
+    }
+    const { resolvedPaths: sourceFiles } = settings.files;
+    const locales = targetLocales || settings.locales;
+    const fileMapping = createFileMapping(sourceFiles, settings.files.placeholderPaths, settings.files.transformPaths, settings.locales, settings.defaultLocale);
+    const cwd = process.cwd();
+    const processPromises = Object.entries(fileMapping)
+        .filter(([locale]) => locales.includes(locale))
+        .map(async ([locale, filesMap]) => {
+        const reverseMap = new Map();
+        for (const [sourcePath, targetPath] of Object.entries(filesMap)) {
+            reverseMap.set(targetPath, sourcePath);
+        }
+        const targetFiles = Object.values(filesMap).filter((p) => (p.endsWith('.md') || p.endsWith('.mdx')) &&
+            (!includeFiles || includeFiles.has(p)));
+        await Promise.all(targetFiles.map(async (targetPath) => {
+            if (!fs.existsSync(targetPath))
+                return;
+            const sourcePath = reverseMap.get(targetPath);
+            if (!sourcePath)
+                return;
+            if (!fs.existsSync(sourcePath))
+                return;
+            const content = await fs.promises.readFile(targetPath, 'utf8');
+            const result = localizeRelativeAssetsForContent(content, sourcePath, targetPath, cwd);
+            if (result.hasChanges) {
+                await fs.promises.writeFile(targetPath, result.content);
+            }
+        }));
+    });
+    await Promise.all(processPromises);
+}

package/package.json

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