@prantlf/jsonlint 11.2.0 → 11.4.0

package/README.md

@@ -14,13 +14,15 @@ 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].
-* Reports errors with rich additional information. From the schema validation too.
-* Implements JavaScript modules using [UMD] to work everywhere.
+* Reports errors with rich additional information. From the JSON Schema validation too.
+* Consumes configuration from both command line and [configuration files](configuration).
+* Implements JavaScript modules using [UMD] to work in Node.js, in a browser, everywhere.
 * Depends on up-to-date npm modules with no installation warnings.
-* Small size - 18.2 kB minified, 6.3 kB gzipped.
+* Small size - 18.7 kB minified, 6.54 kB gzipped, 5.16 kB brotlied.
 
 **Note:** In comparison with the original project, this package exports only the `parse` method; not the `Parser` object.
 
@@ -52,9 +54,11 @@ Example of an error message:
 
 ## Command-line Interface
 
-Install `jsonlint` with `npm`` globally to be able to use the command-line interface in any directory:
+Install `jsonlint` with `npm`, `pnpm`  or `yarn` globally to be able to use the command-line interface in any directory:
 
-    npm i @prantlf/jsonlint -g
+    npm i -g @prantlf/jsonlint
+    pnpm i -g @prantlf/jsonlint
+    yarn add --global @prantlf/jsonlint
 
 Validate a single file:
 
@@ -64,64 +68,147 @@ or pipe the JSON input into `stdin`:
 
     cat myfile.json | jsonlint
 
-or process all `.json` files in a directory:
+or process all `.json` files in a directory and rewriting them with the pretty-printed output:
 
-    jsonlint mydir
+    jsonlint --in-place --pretty-print mydir
 
 By default, `jsonlint` will either report a syntax error with details or pretty-print the source if it is valid.
 
-### Options
-
-    $ jsonlint -h
-
-    Usage: jsonlint [options] [<file, directory, pattern> ...]
-
-    JSON parser, syntax and schema validator and pretty-printer.
-
-    Options:
-      -s, --sort-keys              sort object keys (not when prettifying)
-      -E, --extensions [ext]       file extensions to process for directory walk
-                                   (default: ["json","JSON"])
-      -i, --in-place               overwrite the input files
-      -t, --indent [num|char]      number of spaces or specific characters
-                                   to use for indentation (default: 2)
-      -c, --compact                compact error display
-      -M, --mode [mode]            set other parsing flags according to a format
-                                   type (default: "json")
-      -C, --comments               recognize and ignore JavaScript-style comments
-      -S, --single-quoted-strings  support single quotes as string delimiters
-      -T, --trailing-commas        ignore trailing commas in objects and arrays
-      -D, --no-duplicate-keys      report duplicate object keys as an error
-      -V, --validate [file]        JSON schema file to use for validation
-      -e, --environment [env]      which specification of JSON Schema the
-                                   validation file uses
-      -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
-      -p, --pretty-print           prettify the input instead of stringifying
-                                   the parsed object
-      -P, --pretty-print-invalid   force pretty-printing even for invalid input
-      -r, --trailing-newline       ensure a line break at the end of the output
-      -R, --no-trailing-newline    ensure no line break at the end of the output
-      --prune-comments             omit comments from the prettified output
-      --strip-object-keys          strip quotes from object keys if possible
-                                   (JSON5)
-      --enforce-double-quotes      surrounds all strings with double quotes
-      --enforce-single-quotes      surrounds all strings with single quotes
-                                   (JSON5)
-      --trim-trailing-commas       omit trailing commas from objects and arrays
-                                   (JSON5)
-      -v, --version                output the version number
-      -h, --help                   output usage information
-
-    You can use BASH patterns for including and excluding files (only files).
-    Patterns are case-sensitive and have to use slashes as a path separators.
-    A pattern to exclude from processing starts with "!".
-
-    Parsing mode can be "cjson" or "json5" to enable other flags automatically.
-    If no files or directories are specified, stdin will be parsed. Environments
-    for JSON schema validation are "json-schema-draft-04", "json-schema-draft-06"
-    or "json-schema-draft-07". If not specified, it will be auto-detected.
+A more complex example: check all JSON files in a Node.js project, except for dependencies in `node_modules`, allow comments (CJSON) and trailing commas, forbid duplicated object keys, print processed files names on the console, print errors on a single line and if an error occurs, continue with other files:
+
+    jsonlint --comments --trailing-commas --no-duplicate-keys \
+      --log-files --compact --continue '**/*.json' '!**/node_modules'
+
+The same parameters can be passed from a configuration file:
+
+```json
+{
+  "comments": true,
+  "trailing-commas": true,
+  "duplicate-keys": false,
+  "log-files": true,
+  "compact": true,
+  "continue": true,
+  "patterns": ["**/*.json", "!**/node_modules"]
+}
+```
+
+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> ...]`
+
+#### Options
+
+    -f, --config [file]          read options from a custom configuration file
+    -F, --no-config              disable searching for configuration file
+    -s, --sort-keys              sort object keys (not when prettifying)
+    -E, --extensions [ext]       file extensions to process for directory walk
+                                  (default: ["json","JSON"])
+    -i, --in-place               overwrite the input files
+    -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
+    -M, --mode [mode]            set other parsing flags according to a format
+                                  type (default: "json")
+    -C, --comments               recognize and ignore JavaScript-style comments
+    -S, --single-quoted-strings  support single quotes as string delimiters
+    -T, --trailing-commas        ignore trailing commas in objects and arrays
+    -D, --no-duplicate-keys      report duplicate object keys as an error
+    -V, --validate [file]        JSON schema file to use for validation
+    -e, --environment [env]      which specification of JSON Schema the
+                                  validation file uses
+    -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
+    -p, --pretty-print           prettify the input instead of stringifying
+                                  the parsed object
+    -P, --pretty-print-invalid   force pretty-printing even for invalid input
+    -r, --trailing-newline       ensure a line break at the end of the output
+    -R, --no-trailing-newline    ensure no line break at the end of the output
+    --prune-comments             omit comments from the prettified output
+    --strip-object-keys          strip quotes from object keys if possible
+                                  (JSON5)
+    --enforce-double-quotes      surrounds all strings with double quotes
+    --enforce-single-quotes      surrounds all strings with single quotes
+                                  (JSON5)
+    --trim-trailing-commas       omit trailing commas from objects and arrays
+                                  (JSON5)
+    -v, --version                output the version number
+    -h, --help                   output usage information
+
+You can use BASH patterns for including and excluding files (only files).
+Patterns are case-sensitive and have to use slashes as a path separators.
+A pattern to exclude from processing starts with "!".
+
+Parsing mode can be "cjson" or "json5" to enable other flags automatically.
+If no files or directories are specified, stdin will be parsed. Environments
+for JSON schema validation are "json-schema-draft-04", "json-schema-draft-06"
+or "json-schema-draft-07". If not specified, it will be auto-detected.
+
+### Configuration
+
+In addition to the command line parameters, the options can be supplied from the following files:
+
+    package.json, key jsonlint
+    .jsonlintrc
+    .jsonlintrc.json
+    .jsonlintrc.yaml
+    .jsonlintrc.yml
+    .jsonlintrc.js
+    .jsonlintrc.cjs
+    jsonlint.config.js
+    jsonlint.config.cjs
+
+The automatic search for one of the following locations above can be disabled by the command-line parameter `-F|--no-config`. A concrete configuration file can be specified by the command-line parameter `-f|--config [file]`. Parameters from the command line will have higher priority than parameters from a configuration file.
+
+The configuration is an object with the following properties, described above, which can be entered either in the kebab-case or in the camel-case:
+
+| Parameter | Alias |
+| --------- | ----- |
+| patterns | |
+| sort-keys | sortKeys |
+| extensions | |
+| in-place | inPlace |
+| indent | |
+| compact | |
+| mode | |
+| comments | |
+| single-quoted-strings | singleQuotedStrings |
+| trailing-commas | trailingCommas |
+| duplicate-keys | duplicateKeys |
+| validate | |
+| environment | |
+| log-files | logFiles |
+| quiet | |
+| continue | |
+| pretty-print | prettyPrint |
+| pretty-print-invalid | prettyPrintInvalid |
+| trailing-newline | trailingNewline'
+| prune-comments | pruneComments |
+| strip-object-keys | stripObjectKeys |
+| enforce-double-quotes | enforceDoubleQuotes |
+| enforce-single-quotes | enforceSingleQuotes |
+| trim-trailing-commas | trimTrailingCommas |
+
+The parameter `config` will be ignored in configuration files. The extra parameter `patterns` can be set to an array of strings with paths or patterns instead of putting them to the command line.
 
 ## Module Interface
 

package/lib/cli.js

@@ -16,9 +16,12 @@ const commander = require('commander')
   .name('jsonlint')
   .usage('[options] [<file, directory, pattern> ...]')
   .description(description)
+  .option('-f, --config [file]', 'read options from a custom configuration file')
+  .option('-F, --no-config', 'disable searching for configuration files')
   .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('-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')
@@ -54,9 +57,57 @@ const commander = require('commander')
   })
   .parse(process.argv)
 
-const options = commander.opts()
+const paramNames = {
+  'trailing-commas': 'trailingCommas',
+  'single-quoted-strings': 'singleQuotedStrings',
+  'duplicate-keys': 'duplicateKeys',
+  'pretty-print': 'prettyPrint',
+  'prune-comments': 'pruneComments',
+  'strip-object-keys': 'stripObjectKeys',
+  'enforce-double-quotes': 'enforceDoubleQuotes',
+  'enforce-single-quotes': 'enforceSingleQuotes',
+  'trim-trailing-commas': 'trimTrailingCommas',
+  'sort-keys': 'sortKeys',
+  'pretty-print-invalid': 'prettyPrintInvalid',
+  'log-files': 'logFiles',
+  'in-place': 'inPlace',
+  'trailing-newline': 'trailingNewline'
+}
+
+const params = commander.opts()
+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() || {}
+  options = mergeOptions({}, convertConfig(config), params)
+}
+
 const extensions = options.extensions.map(extension => '.' + extension)
 
+function convertConfig (config) {
+  const result = {}
+  for (const key in config) {
+    const name = paramNames[key] || key
+    result[name] = config[key]
+  }
+  return result
+}
+
+function mergeOptions (target, ...sources) {
+  for (const source of sources) {
+    for (const key in source) {
+      if (target[key] == null) {
+        target[key] = source[key]
+      }
+    }
+  }
+  return target
+}
+
 function logNormalError (error, file) {
   if (process.exitCode > 0) {
     console.log()
@@ -147,24 +198,49 @@ 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 } = require('diff')
+  const diff = createTwoFilesPatch(`${file}.orig`, file, source, parsed, '', '', { context: 3 })
+  if (diff.split(/\r?\n/).length > 4) {
+    const err = new Error('Formatted output differs')
+    if (options.compact) {
+      logCompactError(err, file)
+    } else {
+      logNormalError(err, file)
+    }
+    console.log(diff)
+    if (options.continue) {
+      process.exitCode = 1
+    } else {
+      process.exit(1)
+    }
+  }
+}
+
 function processFile (file) {
   file = normalize(file)
   if (options.logFiles) {
     console.log(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'
-    }
-    writeFileSync(file, source)
+    writeFileSync(file, ensureLineBreak(parsed, source))
+  } else if (options.check) {
+    checkContents(file, source, ensureLineBreak(parsed, source))
   } else {
     if (!(options.quiet || options.logFiles)) {
-      console.log(source)
+      console.log(parsed)
     }
   }
 }
@@ -207,7 +283,10 @@ function processPatterns (patterns) {
 }
 
 function main () {
-  const { args: files } = commander
+  let { args: files } = commander
+  if (!files.length) {
+    files = options.patterns || []
+  }
   if (files.length) {
     const dynamic = files.some(file => isDynamicPattern(file))
     if (dynamic) {
@@ -225,11 +304,14 @@ function main () {
       source += chunk.toString('utf8')
     })
     stdin.on('end', () => {
+      const file = '<stdin>'
       if (options.logFiles) {
-        console.log('<stdin>')
+        console.log(file)
       }
-      const parsed = processContents(source, '<stdin>')
-      if (!(options.quiet || options.logFiles)) {
+      const parsed = processContents(source, file)
+      if (options.check) {
+        checkContents(file, source, ensureLineBreak(parsed, source))
+      } else if (!(options.quiet || options.logFiles)) {
         console.log(parsed)
       }
     })

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prantlf/jsonlint",
-  "version": "11.2.0",
+  "version": "11.4.0",
   "description": "JSON/CJSON/JSON5 parser, syntax and schema validator and pretty-printer.",
   "author": "Ferdinand Prantl <prantlf@gmail.com> (http://prantl.tk)",
   "contributors": [
@@ -45,7 +45,7 @@
     "build": "npm run compile && npm run compile:tests",
     "compile": "node scripts/bundle-jsonlint && terser -o web/jsonlint.min.js --source-map \"filename='jsonlint.js',url='jsonlint.min.js.map',includeSources=true\" lib/jsonlint.js && terser -o web/validator.min.js --source-map \"filename='validator.js',url='validator.min.js.map',includeSources=true\" lib/validator.js && terser -o web/formatter.min.js --source-map \"filename='formatter.js',url='formatter.min.js.map',includeSources=true\" lib/formatter.js && terser -o web/sorter.min.js --source-map \"filename='sorter.js',url='sorter.min.js.map',includeSources=true\" lib/sorter.js && terser -o web/printer.min.js --source-map \"filename='printer.js',url='printer.min.js.map',includeSources=true\" lib/printer.js && node scripts/bundle-schema-drafts && terser -o web/schema-drafts.min.js --source-map \"filename='schema-drafts.js',url='schema-drafts.min.js.map',includeSources=true\" lib/schema-drafts.js && terser -o web/ajv.min.js --source-map \"filename='ajv.js',url='ajv.min.js.map',includeSources=true\" node_modules/ajv/dist/ajv.bundle.js",
     "compile:tests": "tsc --lib es6 test/typings.test.ts",
-    "test": "nyc --silent node test/typings.test.js && nyc --silent --no-clean node test/parse1 && nyc --silent --no-clean node test/parse1 --native-parser && nyc --silent --no-clean node test/parse2 && nyc --silent --no-clean node test/parse3 && nyc --silent --no-clean node test/parse4 && nyc --silent --no-clean node test/parse5 && nyc --silent --no-clean node test/portable && nyc --silent --no-clean node test/tokenize && nyc --silent --no-clean node test/print && nyc --silent --no-clean node lib/cli package.json test/recursive && nyc --silent --no-clean node lib/cli -sq test/passes/hasOwnProperty.json && nyc --silent --no-clean node lib/cli -s -e json-schema-draft-04 -V test/passes/3.schema.json test/passes/3.json && nyc --silent --no-clean node lib/cli -C test/passes/comments.txt && nyc --silent --no-clean node lib/cli -pS test/passes/strings.txt && nyc --silent --no-clean node lib/cli -M json5 test/passes/json5.text && nyc --silent --no-clean node lib/cli -v && nyc --silent --no-clean node lib/cli -h && nyc --silent --no-clean node lib/cli -Pc test/fails/10.json || nyc report",
+    "test": "nyc --silent node test/typings.test.js && nyc --silent --no-clean node test/parse1 && nyc --silent --no-clean node test/parse1 --native-parser && nyc --silent --no-clean node test/parse2 && nyc --silent --no-clean node test/parse3 && nyc --silent --no-clean node test/parse4 && nyc --silent --no-clean node test/parse5 && nyc --silent --no-clean node test/portable && nyc --silent --no-clean node test/tokenize && nyc --silent --no-clean node test/print && nyc --silent --no-clean node lib/cli package.json test/recursive && nyc --silent --no-clean node lib/cli -sq test/passes/hasOwnProperty.json && nyc --silent --no-clean node lib/cli -s -e json-schema-draft-04 -V test/passes/3.schema.json test/passes/3.json && nyc --silent --no-clean node lib/cli -C test/passes/comments.txt && nyc --silent --no-clean node lib/cli -pS test/passes/strings.txt && nyc --silent --no-clean node lib/cli -M json5 test/passes/json5.text && nyc --silent --no-clean node lib/cli -v && nyc --silent --no-clean node lib/cli -h && nyc --silent --no-clean node lib/cli -Pc test/fails/10.json || nyc --silent --no-clean node lib/cli -f test/.jsonrc.yml 'test/**/*.json' '!**/fails' && nyc report",
     "start": "http-server -c 5",
     "web": "npm run web:sync && npm run web:deploy",
     "web:clone": "test ! -d ../jsonlint-pages && git clone --single-branch --branch gh-pages `git remote get-url origin` ../jsonlint-pages",
@@ -77,14 +77,16 @@
   "dependencies": {
     "ajv": "6.12.6",
     "commander": "9.2.0",
+    "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",