Merge pull request #58 from juanjoDiaz/feature/30/option_to_sort_properties

Option to sort properties

Author: mohsen1

README.md

@@ -65,6 +65,8 @@ Available configurations:
 ##### Rendering Options
 * `useToJSON`: use the toJSON method to render an object as a string as available. Usefull for objects like Date or Mongo's ObjectID that migh make more sense as a strign than as empty objects. True by default.
 
+* `sortPropertiesBy`: use the given sorting function to deeply sort the object properties.
+
 #### `openAtDepth([depth])`
 
 ```js

demo/index.js

@@ -30,8 +30,8 @@ var complex = {
     number: 123,
     anObject: {
         a: 'b',
-        c: 'd',
-        e: 'f\"'
+        e: 'd',
+        c: 'f\"'
     },
     string: 'Hello World',
     url: 'https://github.com/mohsen1/json-formatter-js',
@@ -48,7 +48,8 @@ var examples = [
     { title: 'Empty Object', json: Object.create(null) },
     { title: 'Empty Array', json: [] },
     { title: 'Deep', json: deep },
-    { title: 'Dark', json: complex, config: { theme: 'dark' } }
+    { title: 'Dark', json: complex, config: { theme: 'dark' } },
+    { title: 'Sorted Keys', json: complex, config: { sortPropertiesBy: (a, b) => a > b } }
 ];
 
 var result = document.querySelector('.result');

src/index.ts

@@ -26,6 +26,7 @@ export interface JSONFormatterConfiguration {
   animateClose?: boolean;
   theme?: string;
   useToJSON?: boolean;
+  sortPropertiesBy?: (a: string, b: string) => number;
 };
 
 const _defaultConfig: JSONFormatterConfiguration = {
@@ -35,7 +36,8 @@ const _defaultConfig: JSONFormatterConfiguration = {
   animateOpen: true,
   animateClose: true,
   theme: null,
-  useToJSON: true
+  useToJSON: true,
+  sortPropertiesBy: null
 };
 
 
@@ -202,7 +204,10 @@ export default class JSONFormatter {
   */
   private get keys(): string[] {
     if (this.isObject) {
-      return Object.keys(this.json).map((key)=> key ? key : '""');
+      const keys = Object.keys(this.json).map((key)=> key ? key : '""')
+      return (!this.isArray && this.config.sortPropertiesBy)
+        ? keys.sort(this.config.sortPropertiesBy)
+        : keys;
     } else {
       return [];
     }