gtx-cli 2.5.20 → 2.5.22

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # gtx-cli
 
+## 2.5.22
+
+### Patch Changes
+
+- [#870](https://github.com/generaltranslation/gt/pull/870) [`4291258`](https://github.com/generaltranslation/gt/commit/42912587a51da045c0b578ac71699fda4a8fcc26) Thanks [@fernando-aviles](https://github.com/fernando-aviles)! - Persist style of YAML frontmatter when applying Mintlify OpenAPI postprocessing
+
+## 2.5.21
+
+### Patch Changes
+
+- [#868](https://github.com/generaltranslation/gt/pull/868) [`34499ce`](https://github.com/generaltranslation/gt/commit/34499ce8407d4b96dea1b4db7a92225e8118fc56) Thanks [@fernando-aviles](https://github.com/fernando-aviles)! - Removing `"openapi"` top level config, adding as option under `"options.mintlify.openapi"`. Also adding a `jsonSchema` preset for `openapi`.
+
 ## 2.5.20
 
 ### Patch Changes

package/dist/config/generateSettings.js

@@ -132,23 +132,6 @@ export async function generateSettings(flags, cwd = process.cwd()) {
     };
     // Add additional options if provided
     if (mergedOptions.options) {
-        // Auto-add jsonSchema include paths for configured OpenAPI specs (Mintlify)
-        if (mergedOptions.openapi?.framework === 'mintlify' &&
-            Array.isArray(mergedOptions.openapi.files) &&
-            mergedOptions.openapi.files.length) {
-            const translateFields = mergedOptions.openapi.translateFields?.length &&
-                mergedOptions.openapi.translateFields.length > 0
-                ? mergedOptions.openapi.translateFields
-                : ['$..summary', '$..description'];
-            mergedOptions.options.jsonSchema = mergedOptions.options.jsonSchema || {};
-            for (const specFile of mergedOptions.openapi.files) {
-                if (!mergedOptions.options.jsonSchema[specFile]) {
-                    mergedOptions.options.jsonSchema[specFile] = {
-                        include: translateFields,
-                    };
-                }
-            }
-        }
         if (mergedOptions.options.jsonSchema) {
             for (const fileGlob of Object.keys(mergedOptions.options.jsonSchema)) {
                 const jsonSchema = mergedOptions.options.jsonSchema[fileGlob];

package/dist/config/optionPresets.d.ts

@@ -1,2 +1,3 @@
 import { JsonSchema, YamlSchema } from '../types/index.js';
-export declare function generatePreset(preset: string, type: 'json' | 'yaml'): JsonSchema | YamlSchema;
+export declare function generatePreset(preset: JsonSchema['preset'], type: 'json'): JsonSchema;
+export declare function generatePreset(preset: YamlSchema['preset'], type: 'yaml'): YamlSchema;

package/dist/config/optionPresets.js

@@ -39,6 +39,10 @@ export function generatePreset(preset, type) {
                         },
                     },
                 };
+            case 'openapi':
+                return {
+                    include: ['$..summary', '$..description'],
+                };
             default:
                 return {};
         }

package/dist/types/index.d.ts

@@ -31,10 +31,12 @@ export type Options = {
     }>;
 };
 export type OpenApiConfig = {
-    framework: 'mintlify';
     files: string[];
     translateFields?: string[];
 };
+export type MintlifyOptions = {
+    openapi?: OpenApiConfig;
+};
 export type TranslateFlags = {
     config?: string;
     apiKey?: string;
@@ -149,7 +151,6 @@ export type Settings = {
     parsingOptions: ParsingConfigOptions;
     branchOptions: BranchOptions;
     sharedStaticAssets?: SharedStaticAssetsConfig;
-    openapi?: OpenApiConfig;
 };
 export type BranchOptions = {
     currentBranch?: string;
@@ -164,6 +165,7 @@ export type AdditionalOptions = {
     yamlSchema?: {
         [fileGlob: string]: YamlSchema;
     };
+    mintlify?: MintlifyOptions;
     docsUrlPattern?: string;
     docsImportPattern?: string;
     excludeStaticUrls?: string[];
@@ -189,7 +191,7 @@ export type SharedStaticAssetsConfig = {
     publicPath?: string;
 };
 export type JsonSchema = {
-    preset?: 'mintlify';
+    preset?: 'mintlify' | 'openapi';
     include?: string[];
     composite?: {
         [sourceObjectPath: string]: SourceObjectOptions;

package/dist/utils/processOpenApi.js

@@ -3,7 +3,7 @@ import path from 'node:path';
 import { unified } from 'unified';
 import remarkParse from 'remark-parse';
 import remarkFrontmatter from 'remark-frontmatter';
-import YAML from 'yaml';
+import YAML, { isMap, isScalar } from 'yaml';
 import { logger } from '../console/logger.js';
 import { createFileMapping } from '../formats/files/fileMapping.js';
 const HTTP_METHODS = new Set([
@@ -23,14 +23,13 @@ const HTTP_METHODS = new Set([
  * - Warns on missing/ambiguous references but keeps behavior deterministic.
  */
 export default async function processOpenApi(settings, includeFiles) {
-    if (settings.openapi?.framework !== 'mintlify')
-        return;
-    if (!settings.openapi.files?.length)
+    const openapiConfig = settings.options?.mintlify?.openapi;
+    if (!openapiConfig || !openapiConfig.files?.length)
         return;
     if (!settings.files)
         return;
     const configDir = path.dirname(settings.config);
-    const specAnalyses = buildSpecAnalyses(settings.openapi.files, configDir);
+    const specAnalyses = buildSpecAnalyses(openapiConfig.files, configDir);
     if (!specAnalyses.length)
         return;
     const warnings = new Set();
@@ -185,18 +184,18 @@ function rewriteFrontmatter(content, filePath, locale, specs, fileMapping, warni
     const start = yamlNode.position.start.offset;
     const end = yamlNode.position.end.offset;
     const frontmatterRaw = yamlNode.value || '';
-    let parsed;
-    try {
-        parsed = YAML.parse(frontmatterRaw, { prettyErrors: false }) || {};
-    }
-    catch {
+    const doc = YAML.parseDocument(frontmatterRaw, {
+        prettyErrors: false,
+        keepSourceTokens: true,
+    });
+    if (doc.errors?.length)
         return null;
-    }
-    if (!parsed || typeof parsed !== 'object')
+    if (!isMap(doc.contents))
         return null;
     let changed = false;
-    if (typeof parsed.openapi === 'string') {
-        const parsedValue = parseOpenApiValue(parsed.openapi);
+    const openapiNode = doc.get('openapi', true);
+    if (isScalar(openapiNode) && typeof openapiNode.value === 'string') {
+        const parsedValue = parseOpenApiValue(openapiNode.value);
         if (parsedValue) {
             const matchKey = parsedValue.kind === 'operation'
                 ? {
@@ -209,22 +208,23 @@ function rewriteFrontmatter(content, filePath, locale, specs, fileMapping, warni
                 const descriptor = formatOpenApiDescriptor(parsedValue);
                 const localizedSpecPath = resolveLocalizedSpecPath(spec, locale, fileMapping, configDir, parsedValue.specPath || spec.configPath);
                 const newValue = `${localizedSpecPath} ${descriptor}`.trim();
-                if (newValue !== parsed.openapi) {
-                    parsed.openapi = newValue;
+                if (newValue !== openapiNode.value) {
+                    doc.set('openapi', newValue);
                     changed = true;
                 }
             }
         }
     }
-    if (typeof parsed['openapi-schema'] === 'string') {
-        const parsedValue = parseSchemaValue(parsed['openapi-schema']);
+    const schemaNode = doc.get('openapi-schema', true);
+    if (isScalar(schemaNode) && typeof schemaNode.value === 'string') {
+        const parsedValue = parseSchemaValue(schemaNode.value);
         if (parsedValue) {
             const spec = resolveSpec(parsedValue.specPath, specs, filePath, configDir, warnings, `schema "${parsedValue.schemaName}"`, { type: 'schema', key: parsedValue.schemaName });
             if (spec) {
                 const localizedSpecPath = resolveLocalizedSpecPath(spec, locale, fileMapping, configDir, parsedValue.specPath || spec.configPath);
                 const newValue = `${localizedSpecPath} ${parsedValue.schemaName}`.trim();
-                if (newValue !== parsed['openapi-schema']) {
-                    parsed['openapi-schema'] = newValue;
+                if (newValue !== schemaNode.value) {
+                    doc.set('openapi-schema', newValue);
                     changed = true;
                 }
             }
@@ -232,7 +232,7 @@ function rewriteFrontmatter(content, filePath, locale, specs, fileMapping, warni
     }
     if (!changed)
         return null;
-    const fmString = YAML.stringify(parsed).trimEnd();
+    const fmString = doc.toString().trimEnd();
     const rebuilt = `${content.slice(0, start)}---\n${fmString}\n---${content.slice(end)}`;
     return { changed, content: rebuilt };
 }

package/package.json

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