@prantlf/jsonlint 14.0.3 → 15.0.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.
@@ -120,7 +120,15 @@ Usage: `jsonlint [options] [--] [<file, directory, pattern> ...]`
 
     -f, --config <file>          read options from a custom configuration file
     -F, --no-config              disable searching for configuration files
+    --ignore-proto-key           ignore occurrences of "__proto__" object key
+    --ignore-prototype-keys      ignore all keys from "Object.prototype"
     -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 +162,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
 
@@ -192,7 +201,13 @@ The configuration is an object with the following properties, described above, w
 | Parameter | Alias |
 | --------- | ----- |
 | patterns | |
+| ignore-proto-key | ignoreProtoKey |
+| ignore-prototype-keys | ignorePrototypeKeys |
 | 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 | |
@@ -263,6 +278,8 @@ The `parse` method offers more detailed [error information](#error-handling), th
 | `ignoreTrailingCommas`     | ignores trailing commas in objects and arrays (boolean)      |
 | `allowSingleQuotedStrings` | accepts strings delimited by single-quotes too (boolean)     |
 | `allowDuplicateObjectKeys` | allows reporting duplicate object keys as an error (boolean) |
+| `ignoreProtoKey` | ignore occurrences of the `__proto__` object key (boolean) |
+| `ignorePrototypeKeys` | ignore all keys from `Object.prototype` (boolean) |
 | `mode`                     | sets multiple options according to the type of input data (string) |
 | `reviver`                  | converts object and array values (function) |
 
@@ -428,7 +445,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')
@@ -17,7 +17,15 @@ Usage: jsonlint [options] [--] [<file, directory, pattern> ...]
 Options:
   -f, --config <file>          read options from a custom configuration file
   -F, --no-config              disable searching for configuration files
+  --ignore-proto-key           ignore occurrences of "__proto__" object key
+  --ignore-prototype-keys      ignore all keys from "Object.prototype"
   -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 +59,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
 
@@ -82,9 +91,27 @@ for (let i = 2, l = argv.length; i < l; ++i) {
         case 'F':
           params.config = false
           return
+        case 'ignore-proto-key':
+          params.ignoreProtoKey = flag
+          return
+        case 'ignore-prototype-keys':
+          params.ignorePrototypeKeys = flag
+          return
         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 +127,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 +176,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 +217,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)
@@ -216,6 +246,8 @@ for (let i = 2, l = argv.length; i < l; ++i) {
 }
 
 const paramNames = {
+  'ignore-proto-key': 'ignoreProtoKey',
+  'ignore-prototype-keys': 'ignorePrototypeKeys',
   'trailing-commas': 'trailingCommas',
   'single-quoted-strings': 'singleQuotedStrings',
   'duplicate-keys': 'duplicateKeys',
@@ -226,6 +258,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,20 +319,23 @@ 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
+      allowDuplicateObjectKeys: params.duplicateKeys,
+      ignoreProtoKey: params.ignoreProtoKey,
+      ignorePrototypeKeys: params.ignorePrototypeKeys
     }
     if (params.validate.length) {
       const schemas = params.validate.map((file, index) => {
@@ -329,8 +368,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 +441,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 +473,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 +548,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
           }