@prantlf/jsonlint 11.5.0 → 11.7.0

package/README.md

@@ -12,6 +12,7 @@ This is a fork of the original project ([zaach/jsonlint](https://github.com/zaac
 * 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 ignores the leading UTF-8 byte-order mark (BOM).
 * 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.
@@ -129,6 +130,7 @@ Usage: `jsonlint [options] [<file, directory, pattern> ...]`
     -c, --compact                compact error display
     -M, --mode [mode]            set other parsing flags according to a format
                                   type (default: "json")
+    -B, --bom                    ignore the leading UTF-8 byte-order mark
     -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
@@ -136,6 +138,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
@@ -156,7 +159,7 @@ Usage: `jsonlint [options] [<file, directory, pattern> ...]`
     -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.
+Patterns are case-sensitive and have to use slashes as directory separators.
 A pattern to exclude from processing starts with "!".
 
 Parsing mode can be "cjson" or "json5" to enable other flags automatically.
@@ -193,6 +196,7 @@ The configuration is an object with the following properties, described above, w
 | indent | |
 | compact | |
 | mode | |
+| bom | |
 | comments | |
 | single-quoted-strings | singleQuotedStrings |
 | trailing-commas | trailingCommas |
@@ -250,6 +254,7 @@ The `parse` method offers more detailed [error information](#error-handling), th
 
 | Option                     | Description                                 |
 | -------------------------- | ------------------------------------------- |
+| `ignoreBOM`                | ignores the leading UTF-8 byte-order mark (boolean) |
 | `ignoreComments`           | ignores single-line and multi-line JavaScript-style comments during parsing as another "whitespace" (boolean) |
 | `ignoreTrailingCommas`     | ignores trailing commas in objects and arrays (boolean)      |
 | `allowSingleQuotedStrings` | accepts strings delimited by single-quotes too (boolean)     |

package/lib/cli.js

@@ -26,12 +26,14 @@ const commander = require('commander')
   .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')
+  .option('-B, --bom', 'ignore the leading UTF-8 byte-order mark')
   .option('-C, --comments', 'recognize and ignore JavaScript-style comments')
   .option('-S, --single-quoted-strings', 'support single quotes as string delimiters')
   .option('-T, --trailing-commas', 'ignore trailing commas in objects and arrays')
   .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')
@@ -48,7 +50,7 @@ const commander = require('commander')
   .on('--help', () => {
     console.log()
     console.log('You can use BASH patterns for including and excluding files (only files).')
-    console.log('Patterns are case-sensitive and have to use slashes as a path separators.')
+    console.log('Patterns are case-sensitive and have to use slashes as directory separators.')
     console.log('A pattern to exclude from processing starts with "!".')
     console.log()
     console.log('Parsing mode can be "cjson" or "json5" to enable other flags automatically.')
@@ -134,6 +136,7 @@ function processContents (source, file) {
   try {
     parserOptions = {
       mode: options.mode,
+      ignoreBOM: options.bom,
       ignoreComments: options.comments,
       ignoreTrailingCommas: options.trailingCommas,
       allowSingleQuotedStrings: options.singleQuotedStrings,
@@ -218,9 +221,8 @@ function ensureLineBreak (parsed, source) {
 
 function checkContents (file, source, parsed) {
   const { createTwoFilesPatch, structuredPatch } = require('diff')
-  const structured = structuredPatch(`${file}.orig`, file, source, parsed, '', '', { context: 3 })
+  const structured = structuredPatch(`${file}.orig`, file, source, parsed, '', '', { context: options.context })
   const length = structured.hunks && structured.hunks.length
-  const diff = createTwoFilesPatch(`${file}.orig`, file, source, parsed, '', '', { context: 3 })
   if (length > 0) {
     const hunk = length === 1 ? 'hunk differs' : 'hunks differ'
     const message = `${length} ${hunk}`
@@ -232,6 +234,7 @@ function checkContents (file, source, parsed) {
       console.error(message)
     }
     if (!options.quiet) {
+      const diff = createTwoFilesPatch(`${file}.orig`, file, source, parsed, '', '', { context: options.context })
       console.log(diff)
     }
     if (options.continue) {
@@ -253,10 +256,10 @@ function diffContents (file, source, parsed) {
   const compact = options.quiet || options.compact
   let diff, length
   if (compact) {
-    diff = structuredPatch(`${file}.orig`, file, source, parsed, '', '', { context: 3 })
+    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: 3 })
+    diff = createTwoFilesPatch(`${file}.orig`, file, source, parsed, '', '', { context: options.context })
     length = diff.split(/\r?\n/).length - 4
   }
   if (length > 0) {

package/lib/jsonlint.d.ts

@@ -1,6 +1,7 @@
 type ParseMode = 'json' | 'cjson' | 'json5'
 
 interface ParseOptions {
+  ignoreBOM?: boolean
   ignoreComments?: boolean
   ignoreTrailingCommas?: boolean
   allowSingleQuotedStrings?: boolean
@@ -27,6 +28,7 @@ interface ParseOptions {
 declare function parse (input: string, reviverOrOptions?: Function | ParseOptions): object
 
 interface TokenizeOptions {
+  ignoreBOM?: boolean
   ignoreComments?: boolean
   ignoreTrailingCommas?: boolean
   allowSingleQuotedStrings?: boolean
@@ -58,6 +60,7 @@ declare module '@prantlf/jsonlint/lib/validator' {
   type Environment = 'json-schema-draft-04' | 'json-schema-draft-06' | 'json-schema-draft-07'
 
   interface CompileOptions {
+    ignoreBOM?: boolean
     ignoreComments?: boolean
     ignoreTrailingCommas?: boolean
     allowSingleQuotedStrings?: boolean

package/lib/jsonlint.js

@@ -84,6 +84,12 @@ function isDecDigit (x) {
   return x >= '0' && x <= '9'
 }
 
+function isBOM (x) {
+  // This catches EFBBBF (UTF-8 BOM) because the buffer-to-string
+  // conversion in `fs.readFileSync()` translates it to FEFF (UTF-16 BOM).
+  return x.charCodeAt(0) === 0xFEFF
+}
+
 const unescapeMap = {
   '\'': '\'',
   '"': '"',
@@ -103,6 +109,7 @@ function parseInternal (input, options) {
   }
 
   const json5 = options.mode === 'json5'
+  const ignoreBOM = options.ignoreBOM
   const ignoreComments = options.ignoreComments || options.mode === 'cjson' || json5
   const ignoreTrailingCommas = options.ignoreTrailingCommas || json5
   const allowSingleQuotedStrings = options.allowSingleQuotedStrings || json5
@@ -289,6 +296,14 @@ function parseInternal (input, options) {
     }
   }
 
+  function skipBOM () {
+    if (isBOM(input)) {
+      startToken && startToken()
+      ++position
+      endToken && endToken('bom')
+    }
+  }
+
   function skipWhiteSpace () {
     let insideWhiteSpace
     function startWhiteSpace () {
@@ -683,6 +698,9 @@ function parseInternal (input, options) {
     fail()
   }
 
+  if (ignoreBOM) {
+    skipBOM()
+  }
   skipWhiteSpace()
   let returnValue = parseGeneric()
   if (returnValue !== undefined || position < inputLength) {
@@ -929,7 +947,7 @@ const isSafari = typeof navigator !== 'undefined' && /Safari/.test(navigator.use
 const oldNode = typeof process !== 'undefined' && process.version.startsWith('v4.')
 
 function needsCustomParser (options) {
-  return options.ignoreComments || options.ignoreTrailingCommas ||
+  return options.ignoreBOM || options.ignoreComments || options.ignoreTrailingCommas ||
   options.allowSingleQuotedStrings || options.allowDuplicateObjectKeys === false ||
   options.mode === 'cjson' || options.mode === 'json5' || isSafari || oldNode
 }

package/lib/validator.js

@@ -148,6 +148,7 @@
     const ajv = createAjv(environment)
     const parseOptions = {
       mode: options.mode,
+      ignoreBOM: options.ignoreBOM,
       ignoreComments: options.ignoreComments,
       ignoreTrailingCommas: options.ignoreTrailingCommas,
       allowSingleQuotedStrings: options.allowSingleQuotedStrings,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prantlf/jsonlint",
-  "version": "11.5.0",
+  "version": "11.7.0",
   "description": "JSON/CJSON/JSON5 parser, syntax and schema validator and pretty-printer.",
   "author": "Ferdinand Prantl <prantlf@gmail.com> (http://prantl.tk)",
   "contributors": [
@@ -16,7 +16,7 @@
       "url": "https://github.com/prantlf/jsonlint/blob/master/LICENSE"
     }
   ],
-  "homepage": "http://prantlf.github.com/jsonlint/",
+  "homepage": "http://prantlf.github.io/jsonlint/",
   "repository": {
     "type": "git",
     "url": "https://github.com/prantlf/jsonlint.git"
@@ -76,28 +76,28 @@
   },
   "dependencies": {
     "ajv": "6.12.6",
-    "commander": "9.2.0",
+    "commander": "9.4.0",
     "cosmiconfig": "7.0.1",
-    "diff": "5.0.0",
-    "fast-glob": "3.2.11"
+    "diff": "5.1.0",
+    "fast-glob": "3.2.12"
   },
   "devDependencies": {
     "@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",
+    "@types/node": "18.7.21",
+    "@typescript-eslint/eslint-plugin": "5.38.0",
+    "@typescript-eslint/parser": "5.38.0",
+    "eslint": "8.24.0",
     "eslint-config-standard": "17.0.0",
     "eslint-plugin-import": "2.26.0",
-    "eslint-plugin-n": "15.2.0",
-    "eslint-plugin-promise": "6.0.0",
-    "http-server": "14.1.0",
+    "eslint-plugin-n": "15.3.0",
+    "eslint-plugin-promise": "6.0.1",
+    "http-server": "14.1.1",
     "js-yaml": "4.1.0",
     "nyc": "15.1.0",
-    "terser": "5.13.1",
+    "terser": "5.15.0",
     "test": "0.6.0",
-    "typescript": "4.6.4"
+    "typescript": "4.8.3"
   },
   "keywords": [
     "json",