Improvement: Added safe checks for invalid YAML (#177)

Author: thim81

CHANGELOG.md

@@ -1,5 +1,8 @@
 ## unreleased
 
+- Improvement: Added safe checks for invalid YAML
+- CLI - Fix relative path generation in $ref when splitting document (#175)
+
 ## [1.27.3] - 2025-07-30
 
 - Convert: convert nullable for anyOf oneOf to 3.1 (#172)

test/util-file.test.js

@@ -448,7 +448,6 @@ describe('openapi-format CLI file tests', () => {
     });
 
     test('should handle null when extracting OpenAPI info', () => {
-      const mockOpenApi = require('./__utils__/mockOpenApi.json');
       const result = analyzeOpenApi(null);
 
       expect(result).toEqual({
@@ -463,5 +462,36 @@ describe('openapi-format CLI file tests', () => {
         tags: []
       });
     });
+
+    test('should ignore null path items when extracting OpenAPI info', () => {
+      const mockOpenApi = {
+        openapi: '3.0.0',
+        info: {title: 'x', version: '1'},
+        paths: {
+          '/pets': {
+            get: {
+              responses: {
+                200: {description: 'ok'}
+              }
+            }
+          },
+          '/empty': null
+        }
+      };
+
+      const result = analyzeOpenApi(mockOpenApi);
+
+      expect(result).toEqual({
+        flags: [],
+        tags: [],
+        operationIds: [],
+        paths: ['/pets', '/empty'],
+        methods: ['GET'],
+        operations: ['GET::/pets'],
+        responseContent: [],
+        requestContent: [],
+        flagValues: []
+      });
+    });
   });
 });

utils/file.js

@@ -359,47 +359,51 @@ function analyzeOpenApi(oaObj) {
       paths.push(path);
       const pathItem = oaObj.paths[path];
 
-      Object.keys(pathItem).forEach(method => {
-        methods.add(method.toUpperCase());
-        const operation = pathItem[method];
-        operations.push(`${method.toUpperCase()}::${path}`);
-
-        if (operation?.tags && Array.isArray(operation.tags)) {
-          operation.tags.forEach(tag => {
-            if (tag.startsWith('x-')) {
-              flags.add(tag);
-            } else {
-              tags.add(tag);
+      if (pathItem && typeof pathItem === 'object') {
+        Object.keys(pathItem).forEach(method => {
+          methods.add(method.toUpperCase());
+          const operation = pathItem[method];
+          operations.push(`${method.toUpperCase()}::${path}`);
+
+          if (operation && typeof operation === 'object') {
+            if (operation?.tags && Array.isArray(operation.tags)) {
+              operation.tags.forEach(tag => {
+                if (tag.startsWith('x-')) {
+                  flags.add(tag);
+                } else {
+                  tags.add(tag);
+                }
+              });
+            }
+
+            if (operation?.operationId) {
+              operationIds.push(operation.operationId);
             }
-          });
-        }
-
-        if (operation?.operationId) {
-          operationIds.push(operation.operationId);
-        }
-
-        if (operation?.requestBody?.content) {
-          Object.keys(operation.requestBody.content).forEach(contentType => {
-            requestContent.add(contentType);
-          });
-        }
-
-        if (operation?.responses) {
-          Object.values(operation.responses).forEach(response => {
-            if (response?.content) {
-              Object.keys(response.content).forEach(contentType => {
-                responseContent.add(contentType);
+
+            if (operation?.requestBody?.content) {
+              Object.keys(operation.requestBody.content).forEach(contentType => {
+                requestContent.add(contentType);
               });
             }
-          });
-        }
 
-        Object.keys(operation).forEach(key => {
-          if (key.startsWith('x-')) {
-            flagValues.add(`${key}: ${operation[key]}`);
+            if (operation?.responses) {
+              Object.values(operation.responses).forEach(response => {
+                if (response?.content) {
+                  Object.keys(response.content).forEach(contentType => {
+                    responseContent.add(contentType);
+                  });
+                }
+              });
+            }
+
+            Object.keys(operation).forEach(key => {
+              if (key.startsWith('x-')) {
+                flagValues.add(`${key}: ${operation[key]}`);
+              }
+            });
           }
         });
-      });
+      }
     });
   }
 

utils/split.js

@@ -60,7 +60,11 @@ async function writeComponents(components, options) {
       const filePath = path.join(fileDir, `${componentName}.${ext}`);
 
       // Update any component references within components
-      const updatedComponent = convertComponentsToRef(components[componentType][componentName], ext, path.join('components', componentType));
+      const updatedComponent = convertComponentsToRef(
+        components[componentType][componentName],
+        ext,
+        path.join('components', componentType)
+      );
 
       // Write each component (schema, parameter, etc.) to its own YAML file
       await writeFile(filePath, updatedComponent, options);