fix: Prevent sorting of required array properties (#167)

Author: thim81

openapi-format.js

@@ -150,7 +150,13 @@ async function openapiSort(oaObj, options) {
           // Deep sort list of properties
           let sortedObj = JSON.parse(JSON.stringify(node)); // Deep copy of the object
           for (let keyRes in sortedObj) {
-            sortedObj[keyRes] = prioritySort(sortedObj[keyRes], sortSet[this.key]);
+            if (
+              typeof sortedObj[keyRes] === 'object' &&
+              !Array.isArray(sortedObj[keyRes]) &&
+              sortedObj[keyRes] !== null
+            ) {
+              sortedObj[keyRes] = prioritySort(sortedObj[keyRes], sortSet[this.key]);
+            }
           }
           this.update(sortedObj);
         } else {

package-lock.json

@@ -16,7 +16,7 @@ const tests = !localTesting
   ? fs.readdirSync(__dirname).filter(file => {
       return fs.statSync(path.join(__dirname, file)).isDirectory() && !file.startsWith('_');
     })
-  : ['yaml-filter-unused-components-path'];
+  : ['yaml-sort-required'];
 
 describe('openapi-format tests', () => {
   let consoleLogSpy, consoleWarnSpy;

test/test.js

@@ -0,0 +1,9 @@
+openapi: 3.0.3
+components:
+  properties:
+    type: object
+    required:
+      - datetime
+    properties:
+      datetime:
+        type: string

test/yaml-sort-required/input.yaml

@@ -0,0 +1,4 @@
+verbose: true
+sort: true
+output: output.yaml
+

test/yaml-sort-required/options.yaml

@@ -0,0 +1,9 @@
+openapi: 3.0.3
+components:
+  properties:
+    type: object
+    required:
+      - datetime
+    properties:
+      datetime:
+        type: string