Allow sorting schema properties by name

defaultSort.json

@@ -5,12 +5,12 @@
   "put": ["operationId", "summary", "description", "parameters", "requestBody", "responses"],
   "patch": ["operationId", "summary", "description", "parameters", "requestBody", "responses"],
   "delete": ["operationId", "summary", "description", "parameters", "requestBody", "responses"],
-  "parameters": ["name", "in", "description", "required", "schema"],
+  "parameters[*]": ["name", "in", "description", "required", "schema"],
   "requestBody": ["description", "required", "content"],
-  "responses": ["description", "headers", "content", "links"],
+  "responses[*]": ["description", "headers", "content", "links"],
   "content": [],
   "components": ["parameters", "schemas"],
   "schema": ["description", "type", "items", "properties", "format", "example", "default"],
-  "schemas": ["description", "type", "items", "properties", "format", "example", "default"],
-  "properties": ["description", "type", "items", "format", "example", "default", "enum"]
+  "schemas[*]": ["description", "type", "items", "properties", "format", "example", "default"],
+  "properties[*]": ["description", "type", "items", "format", "example", "default", "enum"]
 }

openapi-format.js

@@ -48,53 +48,42 @@ async function openapiSort(oaObj, options) {
   // Recursive traverse through OpenAPI document
   traverse(jsonObj).forEach(function (node) {
 
-    if (typeof node === 'object') {
-
-      // Components sorting by alphabet
-      if (this.parent && this.parent.key && this.path[0] === 'components' && this.parent.key === 'components'
-        && sortComponentsSet.length > 0 && sortComponentsSet.includes(this.key)
-      ) {
-        // debugStep = 'Component sorting by alphabet'
-        let sortedObj = JSON.parse(JSON.stringify(node)); // Deep copy of the schema object
-        node = prioritySort(sortedObj, []);
-        this.update(node);
-      }
+    if (typeof node !== 'object') {
+      return;
+    }
 
-      // Generic sorting
-      if (sortSet.hasOwnProperty(this.key) && Array.isArray(sortSet[this.key])) {
+    // Components sorting by alphabet
+    if (this.parent && this.parent.key && this.path[0] === 'components' && this.parent.key === 'components'
+      && sortComponentsSet.length > 0 && sortComponentsSet.includes(this.key)
+    ) {
+      // debugStep = 'Component sorting by alphabet'
+      let sortedObj = JSON.parse(JSON.stringify(node)); // Deep copy of the schema object
+      node = prioritySort(sortedObj, []);
+      this.update(node);
+    }
 
-        if (Array.isArray(node)) {
-          // debugStep = 'Generic sorting - array'
-          // Deep sort array of properties
-          let sortedObj = JSON.parse(JSON.stringify(node)); // Deep copy of the schema object
-          for (let i = 0; i < sortedObj.length; i++) {
-            sortedObj[i] = prioritySort(sortedObj[i], sortSet[this.key]);
-          }
-          this.update(sortedObj);
-
-        } else if ((this.key === 'responses' || this.key === 'schemas' || this.key === 'properties')
-          && (this.parent && this.parent.key !== 'properties' && this.parent.key !== 'value' && this.path[1] !== 'examples')
-        ) {
-          // debugStep = 'Generic sorting - responses/schemas/properties'
-          // 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]);
-          }
-          this.update(sortedObj);
-        } else {
-          if (this.path[0] === 'components' && this.path[1] === 'examples' && this.path[3] === 'value') {
-            // debugStep = 'Generic sorting - skip nested components>examples'
-            // Skip nested components>examples values
-          } else {
-            // debugStep = 'Generic sorting - properties'
-            // Sort list of properties
-            this.update(prioritySort(node, sortSet[this.key]));
-          }
+    // Generic sorting
+    if (sortSet.hasOwnProperty(this.key) && Array.isArray(sortSet[this.key])) {
 
-        }
+      if (this.path[0] === 'components' && this.path[1] === 'examples' && this.path[3] === 'value') {
+          // debugStep = 'Generic sorting - skip nested components>examples'
+          // Skip nested components>examples values
+      } else {
+        // debugStep = 'Generic sorting - properties'
+        // Sort list of properties
+        this.update(prioritySort(node, sortSet[this.key]));
       }
     }
+
+    if (!this.parent || (this.path[0] === 'components' && this.path[1] === 'examples' && this.path[3] === 'value')) {
+      return;
+    }
+
+    // Nested sorting
+    let globKey = this.parent.key + "[*]";
+    if (sortSet.hasOwnProperty(globKey) && Array.isArray(sortSet[globKey])) {
+      this.update(prioritySort(node, sortSet[globKey]));
+    }
   });
 
   // Process root level

test/__utils__/test-utils.js

@@ -3,49 +3,47 @@ const sy = require("@stoplight/yaml");
 const {exec} = require("child_process");
 const path = require("path");
 
-async function loadTest(folder, inputType = 'yaml', outType = 'yaml') {
-  let input, outputBefore, outputAfter = {}
+async function loadRawTest(folder, inputType = 'yaml', outType = 'yaml') {
+  let input = outputBefore = outputAfter = '{}'
   const testPath = `./test/${folder}`
   const inputFile = `input.${inputType}`
   const inputPath = `./test/${folder}/${inputFile}`
   const outputFile = `output.${outType}`
   const outputPath = `./test/${folder}/${outputFile}`
 
   try {
-    if (outType === 'json') {
-      input = JSON.parse(fs.readFileSync(inputPath, 'utf8'));
-    } else {
-      input = sy.parse(fs.readFileSync(inputPath, 'utf8'));
-    }
+    input = fs.readFileSync(inputPath, 'utf8');
   } catch (err) {
     // File not found = {} will be used
   }
 
   try {
-    if (outType === 'json') {
-      outputBefore = JSON.parse(fs.readFileSync(outputPath, 'utf8'));
-    } else {
-      outputBefore = sy.parse(fs.readFileSync(outputPath, 'utf8'));
-    }
+    outputBefore = fs.readFileSync(outputPath, 'utf8');
   } catch (err) {
     // File not found = {} will be used
   }
 
   let result = await cli([`${inputFile}`, `--configFile options.yaml`], testPath);
 
   try {
-    if (outType === 'json') {
-      outputAfter = JSON.parse(fs.readFileSync(outputPath, 'utf8'));
-    } else {
-      outputAfter = sy.parse(fs.readFileSync(outputPath, 'utf8'));
-    }
+    outputAfter = fs.readFileSync(outputPath, 'utf8');
   } catch (err) {
     //
   }
 
   return {result: result, input: input, outputBefore: outputBefore, outputAfter: outputAfter}
 }
 
+async function loadTest(folder, inputType = 'yaml', outType = 'yaml') {
+  let raw = await loadRawTest(folder, inputType, outType)
+
+  raw.input = (inputType === 'json') ? JSON.parse(raw.input) : sy.parse(raw.input);
+  raw.outputBefore = (outType === 'json') ? JSON.parse(raw.outputBefore) : sy.parse(raw.outputBefore);
+  raw.outputAfter = (outType === 'json') ? JSON.parse(raw.outputAfter) : sy.parse(raw.outputAfter);
+
+  return raw
+}
+
 function cli(args, cwd) {
   return new Promise(resolve => {
     exec(
@@ -64,6 +62,7 @@ function cli(args, cwd) {
 }
 
 module.exports = {
+  loadRawTest: loadRawTest,
   loadTest: loadTest,
   cli: cli
 };

test/json-custom-yaml/customSort.json

@@ -5,12 +5,12 @@
   "put": ["operationId", "summary", "description", "parameters", "requestBody", "responses"],
   "patch": ["operationId", "summary", "description", "parameters", "requestBody", "responses"],
   "delete": ["operationId", "summary", "description", "parameters", "requestBody", "responses"],
-  "parameters": ["required", "schema", "name", "in", "description"],
+  "parameters[*]": ["required", "schema", "name", "in", "description"],
   "requestBody": ["description", "headers", "content", "links"],
-  "responses": ["description", "headers", "content", "links"],
+  "responses[*]": ["description", "headers", "content", "links"],
   "content": [],
   "components": ["parameters", "schemas"],
-  "Schema": ["description", "type", "items", "properties", "format", "example", "default"],
-  "schemas": ["description", "type", "items", "properties", "format", "example", "default"],
-  "properties": ["description", "type", "items", "format", "example", "default", "enum"]
+  "schema": ["description", "type", "items", "properties", "format", "example", "default"],
+  "schemas[*]": ["description", "type", "items", "properties", "format", "example", "default"],
+  "properties[*]": ["description", "type", "items", "format", "example", "default", "enum"]
 }

test/json-custom/customSort.json

@@ -5,12 +5,12 @@
   "put": ["operationId", "summary", "description", "parameters", "requestBody", "responses"],
   "patch": ["operationId", "summary", "description", "parameters", "requestBody", "responses"],
   "delete": ["operationId", "summary", "description", "parameters", "requestBody", "responses"],
-  "parameters": ["required", "schema", "name", "in", "description"],
+  "parameters[*]": ["required", "schema", "name", "in", "description"],
   "requestBody": ["description", "headers", "content", "links"],
-  "responses": ["description", "headers", "content", "links"],
+  "responses[*]": ["description", "headers", "content", "links"],
   "content": [],
   "components": ["parameters", "schemas"],
-  "Schema": ["description", "type", "items", "properties", "format", "example", "default"],
-  "schemas": ["description", "type", "items", "properties", "format", "example", "default"],
-  "properties": ["description", "type", "items", "format", "example", "default", "enum"]
+  "schema": ["description", "type", "items", "properties", "format", "example", "default"],
+  "schemas[*]": ["description", "type", "items", "properties", "format", "example", "default"],
+  "properties[*]": ["description", "type", "items", "format", "example", "default", "enum"]
 }

test/json-sort-properties/customSort.json

@@ -0,0 +1,18 @@
+{
+  "root": ["openapi", "info", "servers", "paths", "components", "tags", "x-tagGroups", "externalDocs"],
+  "get": ["operationId", "summary", "description", "parameters", "requestBody", "responses"],
+  "post": ["operationId", "summary", "description", "parameters", "requestBody", "responses"],
+  "put": ["operationId", "summary", "description", "parameters", "requestBody", "responses"],
+  "patch": ["operationId", "summary", "description", "parameters", "requestBody", "responses"],
+  "delete": ["operationId", "summary", "description", "parameters", "requestBody", "responses"],
+  "parameters": ["name"],
+  "parameters[*]": ["name", "in", "description", "required", "schema"],
+  "requestBody": ["description", "required", "content"],
+  "responses[*]": ["description", "headers", "content", "links"],
+  "content": [],
+  "components": ["parameters", "schemas"],
+  "schema": ["description", "type", "items", "properties", "format", "example", "default"],
+  "schemas[*]": ["description", "type", "items", "properties", "format", "example", "default"],
+  "properties[*]": ["description", "type", "items", "format", "example", "default", "enum"],
+  "properties": []
+}