@prantlf/jsonlint 14.0.2 → 14.1.0

package/LICENSE

@@ -1,7 +1,7 @@
 MIT License
 
 Copyright (c) 2012-2018 Zachary Carter
-Copyright (c) 2019-2023 Ferdinand Prantl
+Copyright (c) 2019-2024 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

@@ -21,7 +21,7 @@ This is a fork of the original project ([zaach/jsonlint](https://github.com/zaac
 * Offers pretty-printing including comment-stripping and object keys without quotes (JSON5).
 * Prefers the native JSON parser if possible to run [10x faster than the custom parser].
 * Reports errors with rich additional information. From the JSON Schema validation too.
-* Consumes configuration from both command line and [configuration files](configuration).
+* 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.4 kB minified, 6.45 kB gzipped, 5.05 kB brotlied.
@@ -121,6 +121,12 @@ Usage: `jsonlint [options] [--] [<file, directory, pattern> ...]`
     -f, --config <file>          read options from a custom configuration file
     -F, --no-config              disable searching for configuration files
     -s, --sort-keys              sort object keys (not when prettifying)
+    --sort-keys-ignore-case      sort object keys ignoring the letter case
+    --sort-keys-locale <id>      locale identifier to sort object keys with
+                                 (or "default" for the system default)
+    --sort-keys-case-first <id>  order if only letter case is different
+                                 ("upper", "lower" and "false" are allowed)
+    --sort-keys-numeric          sort by numbers recognised in object keys
     -E, --extensions <ext...>    file extensions to process for directory walk
                                  (default: json, JSON)
     -i, --in-place               overwrite the input files
@@ -154,6 +160,7 @@ Usage: `jsonlint [options] [--] [<file, directory, pattern> ...]`
     --enforce-double-quotes      surrounds all strings with double quotes
     --enforce-single-quotes      surrounds all strings with single quotes
     --trim-trailing-commas       omit trailing commas from objects and arrays
+    --succeed-with-no-files      succeed (exit code 0) if no files were found
     -v, --version                output the version number
     -h, --help                   display help for command
 
@@ -193,6 +200,10 @@ The configuration is an object with the following properties, described above, w
 | --------- | ----- |
 | patterns | |
 | sort-keys | sortKeys |
+| sort-keys-ignore-case | sortKeysIgnoreCase |
+| sort-keys-locale | sortKeysLocale |
+| sort-keys-case-first | sortKeysCaseFirst |
+| sort-keys-numeric | sortKeysNumeric |
 | extensions | |
 | in-place | inPlace |
 | diff | |
@@ -428,7 +439,7 @@ ${reason}`)
 
 ## License
 
-Copyright (C) 2012-2023 Zachary Carter, Ferdinand Prantl
+Copyright (C) 2012-2024 Zachary Carter, Ferdinand Prantl
 
 Licensed under the [MIT License].
 

package/lib/cli.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 
-const { readdirSync, readFileSync, statSync, writeFileSync } = require('fs')
-const { extname, join } = require('path')
+const { readdirSync, readFileSync, statSync, writeFileSync } = require('node:fs')
+const { extname, join } = require('node:path')
 const { isDynamicPattern, sync } = require('fast-glob')
 const { parse, tokenize } = require('./jsonlint')
 const { format } = require('./formatter')
@@ -18,6 +18,12 @@ Options:
   -f, --config <file>          read options from a custom configuration file
   -F, --no-config              disable searching for configuration files
   -s, --sort-keys              sort object keys (not when prettifying)
+  --sort-keys-ignore-case      sort object keys ignoring the letter case
+  --sort-keys-locale <id>      locale identifier to sort object keys with
+                               (or "default" for the system default)
+  --sort-keys-case-first <id>  order if only letter case is different
+                               ("upper", "lower" and "false" are allowed)
+  --sort-keys-numeric          sort by numbers recognised in object keys
   -E, --extensions <ext...>    file extensions to process for directory walk
                                (default: json, JSON)
   -i, --in-place               overwrite the input files
@@ -51,6 +57,7 @@ Options:
   --enforce-double-quotes      surrounds all strings with double quotes
   --enforce-single-quotes      surrounds all strings with single quotes
   --trim-trailing-commas       omit trailing commas from objects and arrays
+  --succeed-with-no-files      succeed (exit code 0) if no files were found
   -v, --version                output the version number
   -h, --help                   display help for command
 
@@ -85,6 +92,18 @@ for (let i = 2, l = argv.length; i < l; ++i) {
         case 's': case 'sort-keys':
           params.sortKeys = flag
           return
+        case 'sort-keys-ignore-case':
+          params.sortKeysIgnoreCase = flag
+          return
+        case 'sort-keys-locale':
+          params.sortKeysLocale = match[4] || argv[++i]
+          return
+        case 'sort-keys-case-first':
+          params.sortKeysCaseFirst = match[4] || argv[++i]
+          return
+        case 'sort-keys-numeric':
+          params.sortKeysNumeric = flag
+          return
         case 'E': case 'extensions':
           arg = match[4] || argv[++i]
           params.extensions.push(...arg.split(','))
@@ -100,7 +119,7 @@ for (let i = 2, l = argv.length; i < l; ++i) {
           return
         case 't': case 'indent':
           arg = match[4] || argv[++i]
-          if (arg.trim().length > 0 && !isNaN(+arg)) arg = +arg
+          if (arg.trim().length > 0 && !Number.isNaN(+arg)) arg = +arg
           params.indent = arg
           return
         case 'c': case 'compact':
@@ -149,7 +168,7 @@ for (let i = 2, l = argv.length; i < l; ++i) {
           return
         case 'x': case 'context':
           arg = match[4] || argv[++i]
-          if (isNaN(+arg)) {
+          if (Number.isNaN(+arg)) {
             throw new Error(`invalid diff context: "${arg}"`)
           }
           params.indent = +arg
@@ -190,6 +209,9 @@ for (let i = 2, l = argv.length; i < l; ++i) {
         case 'trim-trailing-commas':
           params.trimTrailingCommas = flag
           return
+        case 'succeed-with-no-files':
+          params.succeedWithNoFiles = flag
+          return
         case 'v': case 'version':
           console.log(require('../package.json').version)
           process.exit(0)
@@ -226,6 +248,10 @@ const paramNames = {
   'enforce-single-quotes': 'enforceSingleQuotes',
   'trim-trailing-commas': 'trimTrailingCommas',
   'sort-keys': 'sortKeys',
+  'sort-keys-ignore-case': 'sortKeysIgnoreCase',
+  'sort-keys-locale': 'sortKeysLocale',
+  'sort-keys-case-first': 'sortKeysCaseFirst',
+  'sort-keys-numeric': 'sortKeysNumeric',
   'pretty-print-invalid': 'prettyPrintInvalid',
   'log-files': 'logFiles',
   'in-place': 'inPlace',
@@ -283,18 +309,19 @@ function logNormalError (error, file) {
 }
 
 function logCompactError (error, file) {
-  console.error(file + ': line ' + error.location.start.line +
-    ', col ' + error.location.start.column + ', ' + error.reason + '.')
+  console.error(`${file}: line ${error.location.start.line}, col ${error.location.start.column}, ${error.reason}.`)
 }
 
 function processContents (source, file) {
-  let parserOptions, parsed, formatted
+  let parserOptions
+  let parsed
+  let formatted
   try {
     parserOptions = {
       mode: params.mode,
       ignoreBOM: params.bom,
       ignoreComments: params.comments,
-      ignoreTrailingCommas: params.trailingCommas,
+      ignoreTrailingCommas: params.trailingCommas || params.trimTrailingCommas,
       allowSingleQuotedStrings: params.singleQuotedStrings,
       allowDuplicateObjectKeys: params.duplicateKeys
     }
@@ -329,8 +356,29 @@ function processContents (source, file) {
         trimTrailingCommas: params.trimTrailingCommas
       })
     }
+    const sortOptions = {}
+    let sort
     if (params.sortKeys) {
-      parsed = sortObject(parsed)
+      sort = true
+    }
+    if (params.sortKeysIgnoreCase) {
+      sortOptions.ignoreCase = true
+      sort = true
+    }
+    if (params.sortKeysLocale) {
+      sortOptions.locale = params.sortKeysLocale
+      sort = true
+    }
+    if (params.sortKeysCaseFirst) {
+      sortOptions.caseFirst = params.sortKeysCaseFirst
+      sort = true
+    }
+    if (params.sortKeysNumeric) {
+      sortOptions.numeric = true
+      sort = true
+    }
+    if (sort) {
+      parsed = sortObject(parsed, sortOptions)
     }
     return JSON.stringify(parsed, null, params.indent)
   } catch (e) {
@@ -381,7 +429,7 @@ function ensureLineBreak (parsed, source) {
 function checkContents (file, source, parsed) {
   const { createTwoFilesPatch, structuredPatch } = require('diff')
   const structured = structuredPatch(`${file}.orig`, file, source, parsed, '', '', { context: params.context })
-  const length = structured.hunks && structured.hunks.length
+  const length = structured.hunks?.length
   if (length > 0) {
     const hunk = length === 1 ? 'hunk differs' : 'hunks differ'
     const message = `${length} ${hunk}`
@@ -413,10 +461,11 @@ function checkContents (file, source, parsed) {
 function diffContents (file, source, parsed) {
   const { createTwoFilesPatch, structuredPatch } = require('diff')
   const compact = params.quiet || params.compact
-  let diff, length
+  let diff
+  let length
   if (compact) {
     diff = structuredPatch(`${file}.orig`, file, source, parsed, '', '', { context: params.context })
-    length = diff.hunks && diff.hunks.length
+    length = diff.hunks?.length
   } else {
     diff = createTwoFilesPatch(`${file}.orig`, file, source, parsed, '', '', { context: params.context })
     length = diff.split(/\r?\n/).length - 4
@@ -487,7 +536,7 @@ function processPatterns (patterns) {
   const files = sync(patterns, { onlyFiles: true })
   if (!files.length) {
     console.error('no files found')
-    process.exit(1)
+    process.exit(params.succeedWithNoFiles ? 0 : 1)
   }
   for (const file of files) {
     try {

package/lib/formatter.js

@@ -36,7 +36,7 @@
         case '{':
         case '[':
           if (!inString) {
-            outputString += currentChar + '\n' + repeat(indentString, indentLevel + 1)
+            outputString += `${currentChar}\n${repeat(indentString, indentLevel + 1)}`
             indentLevel += 1
           } else {
             outputString += currentChar
@@ -46,14 +46,14 @@
         case ']':
           if (!inString) {
             indentLevel -= 1
-            outputString += '\n' + repeat(indentString, indentLevel) + currentChar
+            outputString += `\n${repeat(indentString, indentLevel)}${currentChar}`
           } else {
             outputString += currentChar
           }
           break
         case ',':
           if (!inString) {
-            outputString += ',\n' + repeat(indentString, indentLevel)
+            outputString += `,\n${repeat(indentString, indentLevel)}`
           } else {
             outputString += currentChar
           }

package/lib/jsonlint.js

@@ -103,6 +103,8 @@ const unescapeMap = {
   '/': '/'
 }
 
+const ownsProperty = Object.prototype.hasOwnProperty
+
 function parseInternal (input, options) {
   if (typeof input !== 'string' || !(input instanceof String)) {
     input = String(input)
@@ -176,7 +178,7 @@ function parseInternal (input, options) {
     let message
     if (position < inputLength) {
       const token = JSON.stringify(input[position])
-      message = 'Unexpected token ' + token
+      message = `Unexpected token ${token}`
     } else {
       message = 'Unexpected end of input'
     }
@@ -220,87 +222,84 @@ function parseInternal (input, options) {
 
   function parseGeneric () {
     if (position < inputLength) {
-      startToken && startToken()
+      startToken?.()
       const char = input[position++]
       if (char === '"' || (char === '\'' && allowSingleQuotedStrings)) {
         const string = parseString(char)
-        endToken && endToken('literal', string)
+        endToken?.('literal', string)
         return string
-      } else if (char === '{') {
-        endToken && endToken('symbol', '{')
+      }if (char === '{') {
+        endToken?.('symbol', '{')
         return parseObject()
-      } else if (char === '[') {
-        endToken && endToken('symbol', '[')
+      }if (char === '[') {
+        endToken?.('symbol', '[')
         return parseArray()
-      } else if (char === '-' || char === '.' || isDecDigit(char) ||
+      }if (char === '-' || char === '.' || isDecDigit(char) ||
                  (json5 && (char === '+' || char === 'I' || char === 'N'))) {
         const number = parseNumber()
-        endToken && endToken('literal', number)
+        endToken?.('literal', number)
         return number
-      } else if (char === 'n') {
+      }if (char === 'n') {
         parseKeyword('null')
-        endToken && endToken('literal', null)
+        endToken?.('literal', null)
         return null
-      } else if (char === 't') {
+      }if (char === 't') {
         parseKeyword('true')
-        endToken && endToken('literal', true)
+        endToken?.('literal', true)
         return true
-      } else if (char === 'f') {
+      }if (char === 'f') {
         parseKeyword('false')
-        endToken && endToken('literal', false)
+        endToken?.('literal', false)
         return false
-      } else {
+      }
         --position
-        endToken && endToken()
+        endToken?.()
         return undefined
-      }
     }
   }
 
   function parseKey () {
     let result
     if (position < inputLength) {
-      startToken && startToken()
+      startToken?.()
       const char = input[position++]
       if (char === '"' || (char === '\'' && allowSingleQuotedStrings)) {
         const string = parseString(char)
-        endToken && endToken('literal', string)
+        endToken?.('literal', string)
         return string
-      } else if (char === '{') {
-        endToken && endToken('symbol', '{')
+      }if (char === '{') {
+        endToken?.('symbol', '{')
         return parseObject()
-      } else if (char === '[') {
-        endToken && endToken('symbol', '[')
+      }if (char === '[') {
+        endToken?.('symbol', '[')
         return parseArray()
-      } else if (char === '.' || isDecDigit(char)) {
+      }if (char === '.' || isDecDigit(char)) {
         const number = parseNumber(true)
-        endToken && endToken('literal', number)
+        endToken?.('literal', number)
         return number
-      } else if ((json5 && Uni.isIdentifierStart(char)) ||
+      }if ((json5 && Uni.isIdentifierStart(char)) ||
                  (char === '\\' && input[position] === 'u')) {
         const rollback = position - 1
         result = parseIdentifier()
         if (result === undefined) {
           position = rollback
-          endToken && endToken()
+          endToken?.()
           return undefined
-        } else {
-          endToken && endToken('literal', result)
-          return result
         }
-      } else {
+          endToken?.('literal', result)
+          return result
+      }
         --position
-        endToken && endToken()
+        endToken?.()
         return undefined
-      }
     }
   }
 
   function skipBOM () {
     if (isBOM(input)) {
-      startToken && startToken()
+      startToken?.()
       ++position
-      endToken && endToken('bom')
+      endToken?.('bom')
     }
   }
 
@@ -336,7 +335,7 @@ function parseInternal (input, options) {
           ++position
         }
         skipComment(input[position++] === '*')
-        endToken && endToken('comment')
+        endToken?.('comment')
       } else {
         --position
         break
@@ -389,29 +388,29 @@ function parseInternal (input, options) {
     while (position < inputLength) {
       skipWhiteSpace()
       const key = parseKey()
-      if (allowDuplicateObjectKeys === false && result[key]) {
-        fail('Duplicate key: "' + key + '"')
+      if (allowDuplicateObjectKeys === false && ownsProperty.call(result, key)) {
+        fail(`Duplicate key: "${key}"`)
       }
       skipWhiteSpace()
-      startToken && startToken()
+      startToken?.()
       let char = input[position++]
-      endToken && endToken('symbol', char)
+      endToken?.('symbol', char)
       if (char === '}' && key === undefined) {
         if (!ignoreTrailingCommas && isNotEmpty) {
           --position
           fail('Trailing comma in object')
         }
         return result
-      } else if (char === ':' && key !== undefined) {
+      }if (char === ':' && key !== undefined) {
         skipWhiteSpace()
-        tokenPath && tokenPath.push(key)
+        tokenPath?.push(key)
         let value = parseGeneric()
-        tokenPath && tokenPath.pop()
+        tokenPath?.pop()
 
-        if (value === undefined) fail('No value found for key "' + key + '"')
+        if (value === undefined) fail(`No value found for key "${key}"`)
         if (typeof key !== 'string') {
           if (!json5 || typeof key !== 'number') {
-            fail('Wrong key type: "' + key + '"')
+            fail(`Wrong key type: "${key}"`)
           }
         }
 
@@ -428,11 +427,10 @@ function parseInternal (input, options) {
         }
 
         skipWhiteSpace()
-        startToken && startToken()
+        startToken?.()
         char = input[position++]
-        endToken && endToken('symbol', char)
+        endToken?.('symbol', char)
         if (char === ',') {
-          continue
         } else if (char === '}') {
           return result
         } else {
@@ -451,13 +449,13 @@ function parseInternal (input, options) {
     const result = []
     while (position < inputLength) {
       skipWhiteSpace()
-      tokenPath && tokenPath.push(result.length)
+      tokenPath?.push(result.length)
       let item = parseGeneric()
-      tokenPath && tokenPath.pop()
+      tokenPath?.pop()
       skipWhiteSpace()
-      startToken && startToken()
+      startToken?.()
       const char = input[position++]
-      endToken && endToken('symbol', char)
+      endToken?.('symbol', char)
       if (item !== undefined) {
         if (reviver) {
           item = reviver(String(result.length), item)
@@ -498,18 +496,18 @@ function parseInternal (input, options) {
       let result
 
       if (isOctal) {
-        result = parseInt(string.replace(/^0o?/, ''), 8)
+        result = Number.parseInt(string.replace(/^0o?/, ''), 8)
       } else {
         result = Number(string)
       }
 
       if (Number.isNaN(result)) {
         --position
-        fail('Bad numeric literal - "' + input.substr(start, position - start + 1) + '"')
+        fail(`Bad numeric literal - "${input.substr(start, position - start + 1)}"`)
       } else if (!json5 && !string.match(/^-?(0|[1-9][0-9]*)(\.[0-9]+)?(e[+-]?[0-9]+)?$/i)) {
         // additional restrictions imposed by json
         --position
-        fail('Non-json numeric literal - "' + input.substr(start, position - start + 1) + '"')
+        fail(`Non-json numeric literal - "${input.substr(start, position - start + 1)}"`)
       } else {
         return result
       }
@@ -523,7 +521,7 @@ function parseInternal (input, options) {
 
     if (char === 'N' && json5) {
       parseKeyword('NaN')
-      return NaN
+      return Number.NaN
     }
 
     if (char === 'I' && json5) {
@@ -608,7 +606,7 @@ function parseInternal (input, options) {
           isHexDigit(input[position + 3]) &&
           isHexDigit(input[position + 4])) {
         // UnicodeEscapeSequence
-        char = String.fromCharCode(parseInt(input.substr(position + 1, 4), 16))
+        char = String.fromCharCode(Number.parseInt(input.substr(position + 1, 4), 16))
         position += 5
       }
 
@@ -639,7 +637,7 @@ function parseInternal (input, options) {
       let char = input[position++]
       if (char === endChar) {
         return result
-      } else if (char === '\\') {
+      }if (char === '\\') {
         if (position >= inputLength) {
           fail()
         }
@@ -662,7 +660,7 @@ function parseInternal (input, options) {
             }
             position++
           }
-          result += String.fromCharCode(parseInt(input.substr(position - count, count), 16))
+          result += String.fromCharCode(Number.parseInt(input.substr(position - count, count), 16))
         } else if (json5 && isOctDigit(char)) {
           let digits
           if (char < '4' && isOctDigit(input[position]) && isOctDigit(input[position + 1])) {
@@ -675,7 +673,7 @@ function parseInternal (input, options) {
             digits = 1
           }
           position += digits - 1
-          result += String.fromCharCode(parseInt(input.substr(position - digits, digits), 8))
+          result += String.fromCharCode(Number.parseInt(input.substr(position - digits, digits), 8))
         } else if (json5) {
           // \X -> x
           result += char
@@ -710,9 +708,8 @@ function parseInternal (input, options) {
         returnValue = reviver('', returnValue)
       }
       return tokenize ? tokens : returnValue
-    } else {
-      fail()
     }
+      fail()
   } else {
     if (position) {
       fail('No data, only a whitespace')
@@ -759,9 +756,9 @@ function pathToPointer (tokens) {
   if (tokens.length === 0) {
     return ''
   }
-  return '/' + tokens
+  return `/${tokens
     .map(escapePointerToken)
-    .join('/')
+    .join('/')}`
 }
 
 function unescapePointerToken (token) {
@@ -825,7 +822,7 @@ function upcomingInput (input, offset) {
 function getPositionContext (input, offset) {
   const past = pastInput(input, offset)
   const upcoming = upcomingInput(input, offset)
-  const pointer = new Array(past.length + 1).join('-') + '^'
+  const pointer = `${new Array(past.length + 1).join('-')}^`
   return {
     excerpt: past + upcoming,
     pointer
@@ -889,13 +886,13 @@ function getLocationOnSpiderMonkey (input, reason) {
 function getTexts (reason, input, offset, line, column) {
   const position = getPositionContext(input, offset)
   const excerpt = position.excerpt
-  let message, pointer
+  let message
+  let pointer
   if (typeof line === 'number') {
     pointer = position.pointer
-    message = 'Parse error on line ' + line + ', column ' +
-      column + ':\n' + excerpt + '\n' + pointer + '\n' + reason
+    message = `Parse error on line ${line}, column ${column}:\n${excerpt}\n${pointer}\n${reason}`
   } else {
-    message = 'Parse error in JSON input:\n' + excerpt + '\n' + reason
+    message = `Parse error in JSON input:\n${excerpt}\n${reason}`
   }
   return {
     message,
@@ -909,7 +906,9 @@ function improveNativeError (input, error) {
   const location = getLocationOnV8(input, reason) ||
     checkUnexpectedEndOnV8(input, reason) ||
     getLocationOnSpiderMonkey(input, reason)
-  let offset, line, column
+  let offset
+  let line
+  let column
   if (location) {
     offset = location.offset
     line = location.line
@@ -940,7 +939,11 @@ function parseNative (input, reviver) {
   try {
     return JSON.parse(input, reviver)
   } catch (error) {
-    throw improveNativeError(input, error)
+    const newError = improveNativeError(input, error)
+    if (error.location) throw newError
+    // If the native error didn't contain location, parse once more
+    // by the custom parser, which always provides the error location.
+    return parseCustom (input, reviver)
   }
 }
 /* globals navigator, process, parseCustom, parseNative */
@@ -957,7 +960,7 @@ function needsCustomParser (options) {
 function getReviver (options) {
   if (typeof options === 'function') {
     return options
-  } else if (options) {
+  }if (options) {
     return options.reviver
   }
 }