@prantlf/jsonlint 10.1.0 → 11.0.0

package/LICENSE

@@ -1,7 +1,7 @@
 MIT License
 
 Copyright (c) 2012-2018 Zachary Carter
-Copyright (c) 2019      Ferdinand Prantl
+Copyright (c) 2019-2022 Ferdinand Prantl
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,20 +1,18 @@
 # JSON Lint
 
-[![NPM version](https://badge.fury.io/js/%40prantlf%2Fjsonlint.svg)](https://badge.fury.io/js/%40prantlf%2Fjsonlint)
-[![Build Status](https://travis-ci.com/prantlf/jsonlint.svg?branch=master)](https://travis-ci.com/prantlf/jsonlint)
-[![codecov](https://codecov.io/gh/prantlf/jsonlint/branch/master/graph/badge.svg)](https://codecov.io/gh/prantlf/jsonlint)
-[![Dependency Status](https://david-dm.org/prantlf/jsonlint.svg)](https://david-dm.org/prantlf/jsonlint)
-[![devDependency Status](https://david-dm.org/prantlf/jsonlint/dev-status.svg)](https://david-dm.org/prantlf/jsonlint#info=devDependencies)
-[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
+[![Latest version](https://img.shields.io/npm/v/@prantlf/jsonlint)
+ ![Dependency status](https://img.shields.io/librariesio/release/npm/@prantlf/jsonlint)
+](https://www.npmjs.com/package/@prantlf/jsonlint)
+[![Code coverage](https://codecov.io/gh/prantlf/jsonlint/branch/master/graph/badge.svg)](https://codecov.io/gh/prantlf/jsonlint)
 
-A [JSON]/[JSON5] parser and validator with a command-line client. A [pure JavaScript version] of the service provided at [jsonlint.com].
+A [JSON]/CJSON/[JSON5] parser, validator and pretty-printer with a command-line client. A [pure JavaScript version] of the service provided at [jsonlint.com].
 
 This is a fork of the original package with the following enhancements:
 
 * Handles multiple files on the command line (by Greg Inman).
 * Walks directories recursively (by Paul Vollmer).
 * Provides 100% compatible interface to the native `JSON.parse` method.
-* Optionally recognizes JavaScript-style comments and single quoted strings.
+* Optionally recognizes JavaScript-style comments (CJSON) and single quoted strings (JSON5).
 * Optionally ignores trailing commas and reports duplicate object keys as an error.
 * Supports [JSON Schema] drafts 04, 06 and 07.
 * Offers pretty-printing including comment-stripping and object keys without quotes (JSON5).
@@ -30,6 +28,7 @@ Integration to the favourite task loaders for JSON file validation is provided b
 
 * [`Grunt`] - see [`@prantlf/grunt-jsonlint`]
 * [`Gulp`] - see [`@prantlf/gulp-jsonlint`]
+* [`Rollup`] - see [`rollup-plugin-jsonlint`]
 
 ## Synopsis
 
@@ -103,6 +102,11 @@ By default, `jsonlint` will either report a syntax error with details or pretty-
       --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
 
@@ -184,7 +188,7 @@ const validate = compile('string with JSON schema', {
 
 ### Pretty-Printing
 
-You can parse a JSON string to an array of tokens and print it back to a string with some changes applied. It can be unification of whitespace or tripping comments, for example. (Raw token values must be enabled when tokenizing the JSON input.)
+You can parse a JSON string to an array of tokens and print it back to a string with some changes applied. It can be unification of whitespace, reformatting or stripping comments, for example. (Raw token values must be enabled when tokenizing the JSON input.)
 
 ```js
 const { tokenize } = require('@prantlf/jsonlint')
@@ -201,7 +205,10 @@ The [`print`](#pretty-printing) method accepts an object `options` as the second
 | --------------------------- | ------------------------------------------------------- |
 | `indent`                    | count of spaces or the specific characters to be used as an indentation unit |
 | `pruneComments`             | will omit all tokens with comments                      |
-| `stripObjectKeys` | will not print quotes around object keys which are JavaScript identifier names |
+| `stripObjectKeys`           | will not print quotes around object keys which are JavaScript identifier names |
+| `enforceDoubleQuotes`       | will surround all strings with double quotes            |
+| `enforceSingleQuotes`       | will surround all strings with single quotes            |
+| `trimTrailingCommas`        | will omit all trailing commas after the last object entry or array item |
 
 ```js
 // Just concatenate the tokens to produce the same output as was the input.
@@ -220,6 +227,12 @@ print(tokens, { indent: 2 })
 print(tokens, { indent: '  ', pruneComments: true })
 // Print to multiple lines with indentation enabled and JSON5 object keys.
 print(tokens, { indent: '\t', stripObjectKeys: true })
+// Print to multiple lines with indentation enabled, unify JSON5 formatting.
+print(tokens, {
+  indent: '    ',
+  enforceDoubleQuotes: true,
+  trimTrailingCommas: true
+})
 ```
 
 ### Tokenizing
@@ -228,7 +241,10 @@ The method `tokenize` has the same prototype as the method [`parse`](#module-int
 
 ```js
 const { tokenize } = require('@prantlf/jsonlint')
-const tokens = tokenize('{"flag":true /* default */}', { ignoreComments: true }))
+const tokens = tokenize('{"flag":true /* default */}', {
+  ignoreComments: true,
+  rawTokens: true
+}))
 // Returns the following array:
 // [
 //   { type: 'symbol',     raw: '{',      value: '{' },
@@ -253,15 +269,13 @@ If you want to retain comments or whitespace for pretty-printing, for example, s
 
 ### Performance
 
-This is a part of an output from the [parser benchmark], when parsing a 4.2 KB formatted string ([package.json](./package.json)) with Node.js 10.15.3:
+This is a part of an output from the [parser benchmark], when parsing a 4.2 KB formatted string ([package.json](./package.json)) with Node.js 12.14.0:
 
-    the built-in parser x 68,212 ops/sec ±0.86% (87 runs sampled)
-    the pure jju parser x 10,234 ops/sec ±1.08% (89 runs sampled)
-    the extended jju parser x 10,210 ops/sec ±1.26% (88 runs sampled)
-    the tokenizable jju parser x 8,832 ops/sec ±0.92% (89 runs sampled)
-    the tokenizing jju parser x 7,911 ops/sec ±1.05% (86 runs sampled)
+    jsonlint using native JSON.parse x 97,109 ops/sec ±0.81% (93 runs sampled)
+    jsonlint using hand-coded parser x 7,256 ops/sec ±0.54% (90 runs sampled)
+    jsonlint using tokenising parser x 6,387 ops/sec ±0.44% (88 runs sampled)
 
-A custom JSON parser is [a lot slower] than the built-in one. However, it is more important to have a [clear error reporting] than the highest speed in scenarios like parsing configuration files. Extending the parser with the support for comments and single-quoted strings does not affect the performance. Making the parser collect tokens and their locations decreases the performance a bit.
+A custom JSON parser is [a lot slower] than the built-in one. However, it is more important to have a [clear error reporting] than the highest speed in scenarios like parsing configuration files. (For better error-reporting, the speed can be preserved by using the native parser initially and re-parsing with another parser only in case of failure.) Features like comments or JSON5 are also helpful in configuration files. Tokens preserve the complete input and can be used for pretty-printing without losing the comments.
 
 ### Error Handling
 
@@ -303,7 +317,7 @@ ${reason}`)
 
 ## License
 
-Copyright (C) 2012-2019 Zachary Carter, Ferdinand Prantl
+Copyright (C) 2012-2022 Zachary Carter, Ferdinand Prantl
 
 Licensed under the [MIT License].
 
@@ -316,8 +330,10 @@ Licensed under the [MIT License].
 [UMD]: https://github.com/umdjs/umd
 [`Grunt`]: https://gruntjs.com/
 [`Gulp`]: http://gulpjs.com/
+[`Rollup`]: https://rollupjs.org/
 [`@prantlf/grunt-jsonlint`]: https://www.npmjs.com/package/@prantlf/grunt-jsonlint
 [`@prantlf/gulp-jsonlint`]: https://www.npmjs.com/package/@prantlf/gulp-jsonlint
+[`rollup-plugin-jsonlint`]: https://www.npmjs.com/package/rollup-plugin-jsonlint
 [7x faster than the custom parser]: ./benchmarks/results/performance.md#results
 [parser benchmark]: ./benchmarks#json-parser-comparison
 [a lot slower]: ./benchmarks/results/performance.md#results

package/lib/cli.js

@@ -1,19 +1,19 @@
 #!/usr/bin/env node
 
-var fs = require('fs')
-var path = require('path')
-var parser = require('./jsonlint')
-var formatter = require('./formatter')
-var printer = require('./printer')
-var sorter = require('./sorter')
-var validator = require('./validator')
-var pkg = require('../package')
+const fs = require('fs')
+const path = require('path')
+const parser = require('./jsonlint')
+const formatter = require('./formatter')
+const printer = require('./printer')
+const sorter = require('./sorter')
+const validator = require('./validator')
+const pkg = require('../package')
 
 function collectExtensions (extension) {
   return extension.split(',')
 }
 
-var options = require('commander')
+const commander = require('commander')
   .name('jsonlint')
   .usage('[options] [<file or directory> ...]')
   .description(pkg.description)
@@ -34,6 +34,9 @@ var options = require('commander')
   .option('-P, --pretty-print-invalid', 'force pretty-printing even for invalid input')
   .option('--prune-comments', 'omit comments from the prettified output')
   .option('--strip-object-keys', 'strip quotes from object keys if possible (JSON5)')
+  .option('--enforce-double-quotes', 'surrounds all strings with double quotes')
+  .option('--enforce-single-quotes', 'surrounds all strings with single quotes (JSON5)')
+  .option('--trim-trailing-commas', 'omit trailing commas from objects and arrays (JSON5)')
   .version(pkg.version, '-v, --version')
   .on('--help', () => {
     console.log()
@@ -44,6 +47,8 @@ var options = require('commander')
   })
   .parse(process.argv)
 
+const options = commander.opts()
+
 function logNormalError (error, file) {
   console.log('File:', file)
   console.error(error.message)
@@ -55,7 +60,7 @@ function logCompactError (error, file) {
 }
 
 function parse (source, file) {
-  var parserOptions, parsed, formatted
+  let parserOptions, parsed, formatted
   try {
     parserOptions = {
       mode: options.mode,
@@ -65,13 +70,13 @@ function parse (source, file) {
       allowDuplicateObjectKeys: options.duplicateKeys
     }
     if (options.validate) {
-      var validate
+      let validate
       try {
-        var schema = fs.readFileSync(path.normalize(options.validate), 'utf8')
+        const schema = fs.readFileSync(path.normalize(options.validate), 'utf8')
         parserOptions.environment = options.environment
         validate = validator.compile(schema, parserOptions)
       } catch (error) {
-        var message = 'Loading the JSON schema failed: "' +
+        const message = 'Loading the JSON schema failed: "' +
           options.validate + '".\n' + error.message
         throw new Error(message)
       }
@@ -81,12 +86,15 @@ function parse (source, file) {
     }
     if (options.prettyPrint) {
       parserOptions.rawTokens = true
-      var tokens = parser.tokenize(source, parserOptions)
+      const tokens = parser.tokenize(source, parserOptions)
       // TODO: Support sorting tor the tokenized input too.
       return printer.print(tokens, {
         indent: options.indent,
         pruneComments: options.pruneComments,
-        stripObjectKeys: options.stripObjectKeys
+        stripObjectKeys: options.stripObjectKeys,
+        enforceDoubleQuotes: options.enforceDoubleQuotes,
+        enforceSingleQuotes: options.enforceSingleQuotes,
+        trimTrailingCommas: options.trimTrailingCommas
       })
     }
     if (options.sortKeys) {
@@ -126,7 +134,7 @@ function parse (source, file) {
 
 function processFile (file) {
   file = path.normalize(file)
-  var source = parse(fs.readFileSync(file, 'utf8'), file)
+  const source = parse(fs.readFileSync(file, 'utf8'), file)
   if (options.inPlace) {
     fs.writeFileSync(file, source)
   } else {
@@ -137,23 +145,23 @@ function processFile (file) {
 }
 
 function processSources (src, checkExtension) {
-  var extensions = options.extensions.map(function (extension) {
+  const extensions = options.extensions.map(function (extension) {
     return '.' + extension
   })
-  var srcStat
+  let srcStat
   try {
     srcStat = fs.statSync(src)
     if (srcStat.isFile()) {
       if (checkExtension) {
-        var ext = path.extname(src)
+        const ext = path.extname(src)
         if (extensions.indexOf(ext) < 0) {
           return
         }
       }
       processFile(src)
     } else if (srcStat.isDirectory()) {
-      var sources = fs.readdirSync(src)
-      for (var i = 0; i < sources.length; i++) {
+      const sources = fs.readdirSync(src)
+      for (let i = 0; i < sources.length; i++) {
         processSources(path.join(src, sources[i]), true)
       }
     }
@@ -163,20 +171,20 @@ function processSources (src, checkExtension) {
 }
 
 function main () {
-  var files = options.args
-  var source = ''
+  const files = commander.args
+  let source = ''
   if (files.length) {
-    for (var i = 0; i < files.length; i++) {
+    for (let i = 0; i < files.length; i++) {
       processSources(files[i], false)
     }
   } else {
-    var stdin = process.openStdin()
+    const stdin = process.openStdin()
     stdin.setEncoding('utf8')
     stdin.on('data', function (chunk) {
       source += chunk.toString('utf8')
     })
     stdin.on('end', function () {
-      var parsed = parse(source, '<stdin>')
+      const parsed = parse(source, '<stdin>')
       if (!options.quiet) {
         console.log(parsed)
       }

package/lib/formatter.js

@@ -1,7 +1,7 @@
 (function (global, factory) {
-  // eslint-disable-next-line no-unused-expressions
+  // eslint-disable-next-line no-unused-expressions, multiline-ternary
   typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports)
-  // eslint-disable-next-line no-undef
+  // eslint-disable-next-line no-undef, multiline-ternary
     : typeof define === 'function' && define.amd ? define('jsonlint-formatter', ['exports'], factory)
     // eslint-disable-next-line no-undef
       : (global = global || self, factory(global.jsonlintFormatter = {}))
@@ -21,15 +21,17 @@
   }
 
   function format (json, indent) {
-    var i = 0
-    var length = 0
-    var indentString = indent !== undefined
+    let i = 0
+    let length = 0
+    const indentString = indent !== undefined
       ? typeof indent === 'number'
-        ? ' '.repeat(indent) : indent : '  '
-    var outputString = ''
-    var indentLevel = 0
-    var inString
-    var currentChar
+        ? new Array(indent + 1).join(' ')
+        : indent
+      : '  '
+    let outputString = ''
+    let indentLevel = 0
+    let inString
+    let currentChar
 
     for (i = 0, length = json.length; i < length; i += 1) {
       currentChar = json.charAt(i)

package/lib/jsonlint.d.ts

@@ -90,6 +90,9 @@ declare module '@prantlf/jsonlint/lib/printer' {
     indent?: number | string
     pruneComments?: boolean
     stripObjectKeys?: boolean
+    enforceDoubleQuotes?: boolean
+    enforceSingleQuotes?: boolean
+    trimTrailingCommas?: boolean
   }
 
   /**