feat: Add jsonlint options for formatting and object key sorting

Author: prantlf

README.md

@@ -13,6 +13,7 @@ This is a fork of the original package with the following enhancements:
 * Optionally recognizes JavaScript-style comments and single quoted strings.
 * Optionally ignores trailing commas and reports duplicate object keys as an error.
 * Prefers using the 8x faster native JSON parser, if possible.
+* Optionally reformats the output JSON and sorts object keys alphabetically.
 * Depends on up-to-date npm modules with no installation warnings.
 
 ## Usage
@@ -55,11 +56,16 @@ gulp.src('./src/*.json')
 Options can be passed as keys in an object to the `jsonlint` function. The following are their defaults:
 
     jsonlint({
+        // parsing
         mode: 'json',
         ignoreComments: false,
         ignoreTrailingCommas: false,
         allowSingleQuotedStrings: false,
         allowDuplicateObjectKeys: true,
+        // formatting
+        format: false,
+        indent: 2,
+        sortKeys: false
     })
 
 * `mode`, when set to "cjson" or "json5", enables some other flags automatically
@@ -68,6 +74,10 @@ Options can be passed as keys in an object to the `jsonlint` function. The follo
 * `allowSingleQuotedStrings`, when `true` single quotes will be accepted as alternative delimiters for strings
 * `allowDuplicateObjectKeys`, when `false` duplicate keys in objects will be reported as an error
 
+* `format`, when `true` `JSON.stringify` will be used to format the JavaScript (if it is valid)
+* `indent`, the value passed to `JSON.stringify`, it can be the number of spaces, or string like "\t"
+* `sortKeys`, when `true` keys of objects in the output JSON will be sorted alphabetically (`format` has to be set to `true` too)
+
 ### jsonlint.reporter(customReporter)
 
 #### customReporter(file)

index.js

@@ -3,6 +3,7 @@
 var mapStream = require('map-stream');
 var colors = require('ansi-colors');
 var jsonlint = require('@prantlf/jsonlint');
+var sorter = require('@prantlf/jsonlint/lib/sorter');
 var through = require('through2');
 var PluginError = require('plugin-error');
 var log = require('fancy-log');
@@ -23,7 +24,10 @@ var jsonLintPlugin = function (options) {
         ignoreComments: false,
         ignoreTrailingCommas: false,
         allowSingleQuotedStrings: false,
-        allowDuplicateObjectKeys: true
+        allowDuplicateObjectKeys: true,
+        format: false,
+        indent: 2,
+        sortKeys: false
     }, options);
 
     return mapStream(function (file, cb) {
@@ -35,11 +39,17 @@ var jsonLintPlugin = function (options) {
                             options.mode === 'cjson' || options.mode === 'json5',
             ignoreTrailingCommas: options.ignoreTrailingCommas || options.mode === 'json5',
             allowSingleQuotedStrings: options.allowSingleQuotedStrings || options.mode === 'json5',
-            allowDuplicateObjectKeys: options.allowDuplicateObjectKeys,
-            limitedErrorInfo: !(options.ignoreComments || options.cjson || options.allowSingleQuotedStrings)
+            allowDuplicateObjectKeys: options.allowDuplicateObjectKeys
         };
         try {
-            jsonlint.parse(String(file.contents), parserOptions);
+            var parsedData = jsonlint.parse(String(file.contents), parserOptions);
+            if (options.format) {
+                if (options.sortKeys) {
+                  parsedData = sorter.sortObject(parsedData);
+                }
+                var formatted = JSON.stringify(parsedData, null, options.indent) + '\n';
+                file.contents = new Buffer(formatted);
+            }
         }
         catch (err) {
             errorMessage = err.message;

test/fixtures/comments.json

@@ -1,5 +1,6 @@
 /* Commented configuration */
 {
+    "key2": 2,
     // String parameter
-    "key": "value"
+    "key1": 1
 }

test/main.js

@@ -46,6 +46,21 @@ function parseInvalidFile (filePath, done, options) {
     stream.end();
 }
 
+function formatValidFile (filePath, done, options, newContent) {
+    var file = getFile(filePath);
+    var stream = jsonLintPlugin(options);
+
+    stream.on('data', function (f) {
+        should.exist(f);
+        should.exist(f.contents);
+        String(f.contents).should.equal(newContent + '\n');
+    });
+
+    stream.once('end', done);
+    stream.write(file);
+    stream.end();
+}
+
 describe('gulp-jsonlint', function () {
     it('should pass file through', function (done) {
         var cbCounter = 0;
@@ -172,4 +187,20 @@ describe('gulp-jsonlint', function () {
             mode: 'json5'
         });
     });
+
+    it('can format the output', function (done) {
+        formatValidFile('fixtures/json5.json', done, {
+            mode: 'json5',
+            format: true
+        }, '{\n  "key": "value"\n}');
+    });
+
+    it('can sort object keys in the output', function (done) {
+        formatValidFile('fixtures/comments.json', done, {
+            ignoreComments: true,
+            format: true,
+            indent: 0,
+            sortKeys: true
+        }, '{"key1":1,"key2":2}');
+    });
 });