gtx-cli 2.6.3 → 2.6.4

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # gtx-cli
 
+## 2.6.4
+
+### Patch Changes
+
+- [#969](https://github.com/generaltranslation/gt/pull/969) [`0fef5cb`](https://github.com/generaltranslation/gt/commit/0fef5cb5266a0aa6ccdf2dc8778ee913eb145b5d) Thanks [@fernando-aviles](https://github.com/fernando-aviles)! - Add flag for Mintlify docs to infer title from source file name when missing title in YAML frontmatter
+
 ## 2.6.3
 
 ### Patch Changes

package/dist/config/generateSettings.js

@@ -118,6 +118,11 @@ export async function generateSettings(flags, cwd = process.cwd()) {
         : { resolvedPaths: {}, placeholderPaths: {}, transformPaths: {} };
     mergedOptions.options = {
         ...(mergedOptions.options || {}),
+        mintlify: {
+            ...(mergedOptions.options?.mintlify || {}),
+            inferTitleFromFilename: gtConfig.options?.mintlify?.inferTitleFromFilename ||
+                mergedOptions.options?.mintlify?.inferTitleFromFilename,
+        },
         experimentalLocalizeStaticImports: gtConfig.options?.experimentalLocalizeStaticImports ||
             flags.experimentalLocalizeStaticImports,
         experimentalLocalizeStaticUrls: gtConfig.options?.experimentalLocalizeStaticUrls ||

package/dist/formats/files/translate.js

@@ -8,6 +8,7 @@ import YAML from 'yaml';
 import { determineLibrary } from '../../fs/determineFramework.js';
 import { isValidMdx } from '../../utils/validateMdx.js';
 import { hashStringSync } from '../../utils/hash.js';
+import { applyMintlifyTitleFallback } from '../../utils/mintlifyTitleFallback.js';
 export const SUPPORTED_DATA_FORMATS = ['JSX', 'ICU', 'I18NEXT'];
 export async function aggregateFiles(settings) {
     // Aggregate all files to translate
@@ -126,13 +127,21 @@ export async function aggregateFiles(settings) {
                         }
                     }
                 }
-                const sanitizedContent = sanitizeFileContent(content);
+                let processedContent = content;
+                let addedMintlifyTitle = false;
+                if (fileType === 'mdx' &&
+                    settings.options?.mintlify?.inferTitleFromFilename) {
+                    const result = applyMintlifyTitleFallback(processedContent, relativePath, settings.defaultLocale);
+                    processedContent = result.content;
+                    addedMintlifyTitle = result.addedTitle;
+                }
+                const sanitizedContent = sanitizeFileContent(processedContent);
                 return {
                     content: sanitizedContent,
                     fileName: relativePath,
                     fileFormat: fileType.toUpperCase(),
                     fileId: hashStringSync(relativePath),
-                    versionId: hashStringSync(content),
+                    versionId: hashStringSync(addedMintlifyTitle ? processedContent : content),
                     locale: settings.defaultLocale,
                 };
             })

package/dist/generated/version.d.ts

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

package/dist/generated/version.js

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

package/dist/types/index.d.ts

@@ -36,6 +36,7 @@ export type OpenApiConfig = {
 };
 export type MintlifyOptions = {
     openapi?: OpenApiConfig;
+    inferTitleFromFilename?: boolean;
 };
 export type SharedFlags = {
     config?: string;

package/dist/utils/mintlifyTitleFallback.d.ts

@@ -0,0 +1,6 @@
+type TitleFallbackResult = {
+    content: string;
+    addedTitle: boolean;
+};
+export declare function applyMintlifyTitleFallback(content: string, fileName: string, defaultLocale?: string): TitleFallbackResult;
+export {};

package/dist/utils/mintlifyTitleFallback.js

@@ -0,0 +1,80 @@
+import path from 'path';
+import YAML from 'yaml';
+const FRONTMATTER_REGEX = /^---\s*\r?\n([\s\S]*?)\r?\n(---|\.\.\.)\s*(?:\r?\n|$)/;
+function toTitleCase(value) {
+    return value
+        .split(' ')
+        .map((word) => {
+        if (!word)
+            return '';
+        return word[0].toUpperCase() + word.slice(1);
+    })
+        .join(' ');
+}
+function deriveTitleFromFilename(fileName, defaultLocale) {
+    const base = path.basename(fileName, path.extname(fileName));
+    if (base.toLowerCase() === 'index') {
+        const parentDir = path.dirname(fileName);
+        if (parentDir === '.' || parentDir === path.sep) {
+            return 'Index';
+        }
+        const parent = path.basename(parentDir);
+        if (parent && defaultLocale && parent === defaultLocale) {
+            return 'Index';
+        }
+        if (parent) {
+            return toTitleCase(parent.replace(/[-_]+/g, ' ').trim());
+        }
+        return 'Index';
+    }
+    const normalized = base.replace(/[-_]+/g, ' ').replace(/\s+/g, ' ').trim();
+    if (!normalized) {
+        return base;
+    }
+    return toTitleCase(normalized);
+}
+function hasMeaningfulTitle(value) {
+    if (value === null || value === undefined) {
+        return false;
+    }
+    if (typeof value === 'string') {
+        return value.trim().length > 0;
+    }
+    return true;
+}
+export function applyMintlifyTitleFallback(content, fileName, defaultLocale) {
+    const inferredTitle = deriveTitleFromFilename(fileName, defaultLocale);
+    if (!inferredTitle) {
+        return { content, addedTitle: false };
+    }
+    const hasBom = content.startsWith('\uFEFF');
+    const contentBody = hasBom ? content.slice(1) : content;
+    const newline = contentBody.includes('\r\n') ? '\r\n' : '\n';
+    const frontmatterMatch = contentBody.match(FRONTMATTER_REGEX);
+    if (frontmatterMatch) {
+        const frontmatterContent = frontmatterMatch[1];
+        let parsed;
+        try {
+            parsed = YAML.parse(frontmatterContent);
+        }
+        catch {
+            return { content, addedTitle: false };
+        }
+        if (parsed && hasMeaningfulTitle(parsed.title)) {
+            return { content, addedTitle: false };
+        }
+        const titleLine = YAML.stringify({ title: inferredTitle }).trimEnd();
+        const headerEndIndex = contentBody.indexOf(newline) + newline.length;
+        const updated = contentBody.slice(0, headerEndIndex) +
+            titleLine +
+            newline +
+            contentBody.slice(headerEndIndex);
+        return { content: (hasBom ? '\uFEFF' : '') + updated, addedTitle: true };
+    }
+    const titleLine = YAML.stringify({ title: inferredTitle }).trimEnd();
+    const frontmatterBlock = `---${newline}${titleLine}${newline}---${newline}${newline}`;
+    return {
+        content: (hasBom ? '\uFEFF' : '') + frontmatterBlock + contentBody,
+        addedTitle: true,
+    };
+}

package/package.json

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