@prantlf/jsonlint 11.3.0 → 11.6.0

package/README.md

@@ -14,6 +14,7 @@ This is a fork of the original project ([zaach/jsonlint](https://github.com/zaac
 * Provides 100% compatible interface to the native `JSON.parse` method.
 * Optionally recognizes JavaScript-style comments (CJSON) and single quoted strings (JSON5).
 * Optionally ignores trailing commas and reports duplicate object keys as an error.
+* Optionally checks that also the expected format matches, including sorted object keys.
 * Supports [JSON Schema] drafts 04, 06 and 07.
 * Offers pretty-printing including comment-stripping and object keys without quotes (JSON5).
 * Prefers the native JSON parser if possible to run [7x faster than the custom parser].
@@ -92,6 +93,23 @@ The same parameters can be passed from a configuration file:
 }
 ```
 
+The input can be checked not only to be a valid JSON, but also to be formatted according to the coding standard. For example, check that there is a trailing li break in each JSON file, in addition to alphabetically sorted keys and no duplicate keys:
+
+    $ jsonlint -ksDr *.json
+
+    File: package.json
+    Formatted output differs
+    ===================================================================
+    --- package.json.orig
+    +++ package.json
+    @@ -105,4 +105,4 @@
+        "lint",
+        "jsonlint"
+      ]
+    -}
+    +}
+    
+
 ### Usage
 
 Usage: `jsonlint [options] [<file, directory, pattern> ...]`
@@ -104,6 +122,8 @@ Usage: `jsonlint [options] [<file, directory, pattern> ...]`
     -E, --extensions [ext]       file extensions to process for directory walk
                                   (default: ["json","JSON"])
     -i, --in-place               overwrite the input files
+    -j, --diff                   print difference instead of writing the output
+    -k, --check                  check that the input is equal to the output
     -t, --indent [num|char]      number of spaces or specific characters
                                   to use for indentation (default: 2)
     -c, --compact                compact error display
@@ -116,6 +136,7 @@ Usage: `jsonlint [options] [<file, directory, pattern> ...]`
     -V, --validate [file]        JSON schema file to use for validation
     -e, --environment [env]      which specification of JSON Schema the
                                   validation file uses
+    -x, --context [num]          line count used as the diff context (default: 3)
     -l, --log-files              print only the parsed file names to stdout
     -q, --quiet                  do not print the parsed json to stdout
     -n, --continue               continue with other files if an error occurs
@@ -168,6 +189,8 @@ The configuration is an object with the following properties, described above, w
 | sort-keys | sortKeys |
 | extensions | |
 | in-place | inPlace |
+| diff | |
+| check | |
 | indent | |
 | compact | |
 | mode | |

package/lib/cli.js

@@ -3,7 +3,6 @@
 const { readdirSync, readFileSync, statSync, writeFileSync } = require('fs')
 const { extname, join, normalize } = require('path')
 const { isDynamicPattern, sync } = require('fast-glob')
-const { cosmiconfigSync } = require('cosmiconfig')
 const { parse, tokenize } = require('./jsonlint')
 const { format } = require('./formatter')
 const { print } = require('./printer')
@@ -22,6 +21,8 @@ const commander = require('commander')
   .option('-s, --sort-keys', 'sort object keys (not when prettifying)')
   .option('-E, --extensions [ext]', 'file extensions to process for directory walk', collectValues, ['json', 'JSON'])
   .option('-i, --in-place', 'overwrite the input files')
+  .option('-j, --diff', 'print difference instead of writing the output')
+  .option('-k, --check', 'check that the input is equal to the output')
   .option('-t, --indent [num|char]', 'number of spaces or specific characters to use for indentation', 2)
   .option('-c, --compact', 'compact error display')
   .option('-M, --mode [mode]', 'set other parsing flags according to a format type', 'json')
@@ -31,6 +32,7 @@ const commander = require('commander')
   .option('-D, --no-duplicate-keys', 'report duplicate object keys as an error')
   .option('-V, --validate [file]', 'JSON schema file to use for validation')
   .option('-e, --environment [env]', 'which specification of JSON Schema the validation file uses')
+  .option('-x, --context [num]', 'line count used as the diff context', 3)
   .option('-l, --log-files', 'print only the parsed file names to stdout')
   .option('-q, --quiet', 'do not print the parsed json to stdout')
   .option('-n, --continue', 'continue with other files if an error occurs')
@@ -79,6 +81,7 @@ let options
 if (params.config === false) {
   options = params
 } else {
+  const { cosmiconfigSync } = require('cosmiconfig')
   const configurator = cosmiconfigSync('jsonlint')
   const { config = {} } = (params.config && configurator.load(params.config)) ||
     configurator.search() || {}
@@ -86,6 +89,7 @@ if (params.config === false) {
 }
 
 const extensions = options.extensions.map(extension => '.' + extension)
+let reported
 
 function convertConfig (config) {
   const result = {}
@@ -107,11 +111,17 @@ function mergeOptions (target, ...sources) {
   return target
 }
 
-function logNormalError (error, file) {
-  if (process.exitCode > 0) {
+function separateBlocks () {
+  if (reported) {
     console.log()
+  } else {
+    reported = true
   }
-  console.log('File:', file)
+}
+
+function logNormalError (error, file) {
+  separateBlocks()
+  console.info('File:', file)
   console.error(error.message)
 }
 
@@ -197,24 +207,96 @@ function processContents (source, file) {
   }
 }
 
+function ensureLineBreak (parsed, source) {
+  const lines = source.split(/\r?\n/)
+  const newLine = !lines[lines.length - 1]
+  if (options.trailingNewline === true ||
+      (options.trailingNewline !== false && newLine)) {
+    parsed += '\n'
+  }
+  return parsed
+}
+
+function checkContents (file, source, parsed) {
+  const { createTwoFilesPatch, structuredPatch } = require('diff')
+  const structured = structuredPatch(`${file}.orig`, file, source, parsed, '', '', { context: options.context })
+  const length = structured.hunks && structured.hunks.length
+  if (length > 0) {
+    const hunk = length === 1 ? 'hunk differs' : 'hunks differ'
+    const message = `${length} ${hunk}`
+    if (options.compact) {
+      console.error(`${file}: ${message}`)
+    } else {
+      separateBlocks()
+      console.info('File:', file)
+      console.error(message)
+    }
+    if (!options.quiet) {
+      const diff = createTwoFilesPatch(`${file}.orig`, file, source, parsed, '', '', { context: options.context })
+      console.log(diff)
+    }
+    if (options.continue) {
+      process.exitCode = 1
+    } else {
+      process.exit(1)
+    }
+  } else {
+    if (options.compact) {
+      console.info(`${file}: no difference`)
+    } else if (options.logFiles) {
+      console.info(file)
+    }
+  }
+}
+
+function diffContents (file, source, parsed) {
+  const { createTwoFilesPatch, structuredPatch } = require('diff')
+  const compact = options.quiet || options.compact
+  let diff, length
+  if (compact) {
+    diff = structuredPatch(`${file}.orig`, file, source, parsed, '', '', { context: options.context })
+    length = diff.hunks && diff.hunks.length
+  } else {
+    diff = createTwoFilesPatch(`${file}.orig`, file, source, parsed, '', '', { context: options.context })
+    length = diff.split(/\r?\n/).length - 4
+  }
+  if (length > 0) {
+    if (compact) {
+      const hunk = length === 1 ? 'hunk differs' : 'hunks differ'
+      console.info(`${file}: ${length} ${hunk}`)
+    } else {
+      separateBlocks()
+      console.info('File:', file)
+      console.log(diff)
+    }
+  } else {
+    if (options.compact) {
+      console.info(`${file}: no difference`)
+    } else if (options.logFiles) {
+      console.info(file)
+    }
+  }
+}
+
 function processFile (file) {
   file = normalize(file)
-  if (options.logFiles) {
-    console.log(file)
+  if (options.logFiles && !(options.compact || options.check || options.diff)) {
+    console.info(file)
   }
-  const original = readFileSync(file, 'utf8')
-  let source = processContents(original, file)
+  const source = readFileSync(file, 'utf8')
+  const parsed = processContents(source, file)
   if (options.inPlace) {
-    const lines = original.split(/\r?\n/)
-    const newLine = !lines[lines.length - 1]
-    if (options.trailingNewline === true ||
-        (options.trailingNewline !== false && newLine)) {
-      source += '\n'
+    if (options.logFiles && options.compact) {
+      console.info(file)
     }
-    writeFileSync(file, source)
+    writeFileSync(file, ensureLineBreak(parsed, source))
+  } else if (options.check) {
+    checkContents(file, source, ensureLineBreak(parsed, source))
+  } else if (options.diff) {
+    diffContents(file, source, ensureLineBreak(parsed, source))
   } else {
     if (!(options.quiet || options.logFiles)) {
-      console.log(source)
+      console.log(parsed)
     }
   }
 }
@@ -237,21 +319,21 @@ function processSource (src, checkExtension) {
       }
     }
   } catch ({ message }) {
-    console.log('WARN', message)
+    console.warn('WARN', message)
   }
 }
 
 function processPatterns (patterns) {
   const files = sync(patterns, { onlyFiles: true })
   if (!files.length) {
-    console.log('no files found')
+    console.error('no files found')
     process.exit(1)
   }
   for (const file of files) {
     try {
       processFile(file)
     } catch ({ message }) {
-      console.log('WARN', message)
+      console.warn('WARN', message)
     }
   }
 }
@@ -278,12 +360,22 @@ function main () {
       source += chunk.toString('utf8')
     })
     stdin.on('end', () => {
-      if (options.logFiles) {
-        console.log('<stdin>')
+      const file = '<stdin>'
+      if (options.logFiles && !(options.compact || options.check || options.diff)) {
+        console.info(file)
       }
-      const parsed = processContents(source, '<stdin>')
-      if (!(options.quiet || options.logFiles)) {
-        console.log(parsed)
+      const parsed = processContents(source, file)
+      if (options.check) {
+        checkContents(file, source, ensureLineBreak(parsed, source))
+      } else if (options.diff) {
+        diffContents(file, source, ensureLineBreak(parsed, source))
+      } else {
+        if (options.logFiles && options.compact) {
+          console.info(file)
+        }
+        if (!(options.quiet || options.logFiles)) {
+          console.log(parsed)
+        }
       }
     })
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prantlf/jsonlint",
-  "version": "11.3.0",
+  "version": "11.6.0",
   "description": "JSON/CJSON/JSON5 parser, syntax and schema validator and pretty-printer.",
   "author": "Ferdinand Prantl <prantlf@gmail.com> (http://prantl.tk)",
   "contributors": [
@@ -77,15 +77,16 @@
   "dependencies": {
     "ajv": "6.12.6",
     "commander": "9.2.0",
-    "cosmiconfig": "^7.0.1",
+    "cosmiconfig": "7.0.1",
+    "diff": "5.0.0",
     "fast-glob": "3.2.11"
   },
   "devDependencies": {
-    "@semantic-release/changelog": "^6.0.1",
-    "@semantic-release/git": "^10.0.1",
-    "@types/node": "17.0.30",
-    "@typescript-eslint/eslint-plugin": "5.21.0",
-    "@typescript-eslint/parser": "5.21.0",
+    "@semantic-release/changelog": "6.0.1",
+    "@semantic-release/git": "10.0.1",
+    "@types/node": "17.0.31",
+    "@typescript-eslint/eslint-plugin": "5.22.0",
+    "@typescript-eslint/parser": "5.22.0",
     "eslint": "8.14.0",
     "eslint-config-standard": "17.0.0",
     "eslint-plugin-import": "2.26.0",