@prantlf/jsonlint 15.0.0 → 16.1.0

package/LICENSE

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

@@ -157,12 +157,15 @@ Usage: `jsonlint [options] [--] [<file, directory, pattern> ...]`
     -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
+    --no-strict                  disable the strict schema validation mode
     --prune-comments             omit comments from the prettified output
     --strip-object-keys          strip quotes from object keys if possible
     --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
+    --force-crlf                 makes sure all line breaks are CRLF
     --succeed-with-no-files      succeed (exit code 0) if no files were found
+    --[no-]color                 force or disable colourful output of the diff
     -v, --version                output the version number
     -h, --help                   display help for command
 
@@ -177,8 +180,8 @@ for JSON Schema validation are "draft-04", "draft-06", "draft-07",
 with "json-schema-". JSON Type Definition can be selected by "rfc8927",
 "json-type-definition" or "jtd". If not specified, it will be "draft-07".
 
-If you specify schemas using the "-V" parameter, you will have to separate
-files to test with "--".
+If you specify multiple schemas, either separate them by comma (,) or
+use the "-V" parameter multiple times.
 
 ### Configuration
 
@@ -222,6 +225,8 @@ The configuration is an object with the following properties, described above, w
 | duplicate-keys | duplicateKeys |
 | validate | |
 | environment | |
+| strict | |
+| color | |
 | log-files | logFiles |
 | quiet | |
 | continue | |
@@ -233,6 +238,7 @@ The configuration is an object with the following properties, described above, w
 | enforce-double-quotes | enforceDoubleQuotes |
 | enforce-single-quotes | enforceSingleQuotes |
 | trim-trailing-commas | trimTrailingCommas |
+| force-crlf | forceCrlf |
 
 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.
 
@@ -314,6 +320,12 @@ If you use external definitions in multiple schemas, you have to pass an array o
 const validate = compile(['string with main schema', 'string with a sub-schema'])
 ```
 
+The schema is parsed in the *strict mode* by default. It'll fail with unknown schema keywords, string formats, conflicting property definitions, union types etc. You may need to relax the schema compilation by disabling the strict mode under circumstances:
+
+```js
+const validate = compile('string with JSON Schema', { environment: 'draft-2020-12', strict: false })
+```
+
 ### 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, reformatting or stripping comments, for example. (Raw token values must be enabled when tokenizing the JSON input.)
@@ -337,6 +349,7 @@ The [`print`](#pretty-printing) method accepts an object `options` as the second
 | `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 |
+| `forceCrlf`                 | makes sure all line breaks are CRLF |
 
 ```js
 // Just concatenate the tokens to produce the same output as was the input.
@@ -361,6 +374,34 @@ print(tokens, {
   enforceDoubleQuotes: true,
   trimTrailingCommas: true
 })
+// Same as `print(tokens, {})`, but uses \r\n for line breaks.
+print(tokens, { forceCrlf: true })
+```
+
+Pretty-printing can be also used to preserve the contents of string literal in the output. For example, the following input:
+
+```json
+{ "pattern": "^(?:\\\\x[0-9A-F]{2}|[\u0020-\u007E])+$" }
+```
+
+will be validated and printed out by default:
+
+```json
+{
+  "pattern": "^(?:\\\\x[0-9A-F]{2}|[ -~])+$"
+}
+```
+
+As you see, the escape Unicode sequences were replaced by the corresponding UTF-8 characters. While this saves space and is arguably more readable, you may have a coding standard which requires to represent some characters always by the escaped Unicode sequences. Yu can achieve it by enabling pretty-printing, which preserves the string literals in the input form. Apart from the programmatic way above, it's possible on the command line too:
+
+    jsonlint -p pattern.json
+
+resulting in the following output:
+
+```json
+{
+  "pattern": "^(?:\\\\x[0-9A-F]{2}|[\u0020-\u007E])+$"
+}
 ```
 
 ### Tokenizing
@@ -445,7 +486,7 @@ ${reason}`)
 
 ## License
 
-Copyright (C) 2012-2024 Zachary Carter, Ferdinand Prantl
+Copyright (C) 2012-2026 Zachary Carter, Ferdinand Prantl
 
 Licensed under the [MIT License].
 

package/lib/cli.js

@@ -1,8 +1,9 @@
 #!/usr/bin/env node
 
-const { readdirSync, readFileSync, statSync, writeFileSync } = require('node:fs')
-const { extname, join } = require('node:path')
+const { readdirSync, readFileSync, statSync, writeFileSync } = require('fs')
+const { extname, join } = require('path')
 const { isDynamicPattern, sync } = require('fast-glob')
+const pico = require('picocolors')
 const { parse, tokenize } = require('./jsonlint')
 const { format } = require('./formatter')
 const { print } = require('./printer')
@@ -54,20 +55,38 @@ Options:
   -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
+  --no-strict                  disable the strict schema validation mode
   --prune-comments             omit comments from the prettified output
   --strip-object-keys          strip quotes from object keys if possible
   --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
+  --force-crlf                 makes sure all line breaks are CRLF
   --succeed-with-no-files      succeed (exit code 0) if no files were found
+  --[no-]color                 force or disable colourful output of the diff
   -v, --version                output the version number
   -h, --help                   display help for command
 
+You can use BASH patterns for including and excluding files (only files).
+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.
+If no files or directories are specified, stdin will be parsed. Environments
+for JSON Schema validation are "draft-04", "draft-06", "draft-07",
+"draft-2019-09" or "draft-2020-12". The environment may be prefixed
+with "json-schema-". JSON Type Definition can be selected by "rfc8927",
+"json-type-definition" or "jtd". If not specified, it will be "draft-07".
+
+If you specify multiple schemas, either separate them by comma (,) or
+use the "-V" parameter multiple times.
+
 Examples:
   $ jsonlint myfile.json
   $ jsonlint --in-place --pretty-print mydir
   $ jsonlint --comments --trailing-commas --no-duplicate-keys \\
-      --log-files --compact --continue '**/*.json' '!**/node_modules'`)
+      --log-files --compact --continue '**/*.json' '!**/node_modules'
+  $ jsonlint --validate openapi-schema.json --environment draft-07 myapi.json`)
 }
 
 const { argv } = process
@@ -174,6 +193,12 @@ for (let i = 2, l = argv.length; i < l; ++i) {
           }
           params.environment = arg
           return
+        case 'strict':
+          params.strict = flag
+          return
+        case 'color':
+          params.color = flag
+          return
         case 'x': case 'context':
           arg = match[4] || argv[++i]
           if (Number.isNaN(+arg)) {
@@ -217,6 +242,9 @@ for (let i = 2, l = argv.length; i < l; ++i) {
         case 'trim-trailing-commas':
           params.trimTrailingCommas = flag
           return
+        case 'force-crlf':
+          params.forceCrlf = flag
+          return
         case 'succeed-with-no-files':
           params.succeedWithNoFiles = flag
           return
@@ -257,6 +285,7 @@ const paramNames = {
   'enforce-double-quotes': 'enforceDoubleQuotes',
   'enforce-single-quotes': 'enforceSingleQuotes',
   'trim-trailing-commas': 'trimTrailingCommas',
+  'force-crlf': 'forceCrlf',
   'sort-keys': 'sortKeys',
   'sort-keys-ignore-case': 'sortKeysIgnoreCase',
   'sort-keys-locale': 'sortKeysLocale',
@@ -346,6 +375,7 @@ function processContents (source, file) {
         }
       })
       parserOptions.environment = params.environment
+      parserOptions.strict = params.strict
       try {
         validate = compile(schemas, parserOptions)
       } catch (error) {
@@ -365,7 +395,8 @@ function processContents (source, file) {
         stripObjectKeys: params.stripObjectKeys,
         enforceDoubleQuotes: params.enforceDoubleQuotes,
         enforceSingleQuotes: params.enforceSingleQuotes,
-        trimTrailingCommas: params.trimTrailingCommas
+        trimTrailingCommas: params.trimTrailingCommas,
+        forceCrlf: params.forceCrlf
       })
     }
     const sortOptions = {}
@@ -433,11 +464,41 @@ function ensureLineBreak (parsed, source) {
   const newLine = !lines[lines.length - 1]
   if (params.trailingNewline === true ||
       (params.trailingNewline !== false && newLine)) {
-    parsed += '\n'
+    parsed += params.forceCrlf === true ? "\r\n" : "\n"
   }
   return parsed
 }
 
+function printDiff (diff) {
+  const { env } = process
+  const isColorSupported =
+    !(env.NO_COLOR || params.color === false || env.CI || env.TERM === 'dumb') &&
+    (env.FORCE_COLOR || params.color === true || process.platform === "win32" || process.stdout.isTTY)
+  if (isColorSupported) {
+    const lines = diff.split(/\r?\n/)
+    for (const line of lines) {
+      if (/^@@ +-\d+,\d+ +\+\d+,\d+ +@@/.test(line) ||
+          /^@@ +-\d+ +\+\d+,\d+ +@@/.test(line) ||
+          /^@@ +-\d+,\d+ +\+\d+ +@@/.test(line) ||
+          /^@@ +-\d+ +\+\d+ +@@/.test(line)) {
+        console.log(pico.blue(line)) // meta
+      } else if (/={3,}/.test(line) ||
+                 /^-{3}/.test(line) ||
+                 /^\+{3}/.test(line)) {
+        console.log(pico.gray(line)) // comment
+      } else if (/^\+/.test(line)) {
+        console.log(pico.green(line)) // addition
+      } else if (/^-/.test(line)) {
+        console.log(pico.red(line)) // deletion
+      } else {
+        console.log(line)
+      }
+    }
+  } else {
+    console.log(diff)
+  }
+}
+
 function checkContents (file, source, parsed) {
   const { createTwoFilesPatch, structuredPatch } = require('diff')
   const structured = structuredPatch(`${file}.orig`, file, source, parsed, '', '', { context: params.context })
@@ -454,7 +515,7 @@ function checkContents (file, source, parsed) {
     }
     if (!params.quiet) {
       const diff = createTwoFilesPatch(`${file}.orig`, file, source, parsed, '', '', { context: params.context })
-      console.log(diff)
+      printDiff(diff)
     }
     if (params.continue) {
       process.exitCode = 1

package/lib/index.d.ts

@@ -425,6 +425,13 @@ declare module '@prantlf/jsonlint/lib/validator' {
      *   'json-type-definition' | 'jtd' | 'rfc8927'`
      */
     environment?: Environment
+
+    /**
+     * Enable or disable the strict schema validation mode.
+     *
+     * The default is `true`. You may need to set it to `false` to ignore some schema extensions.
+     */
+    strict?: boolean
   }
 
   /**
@@ -499,6 +506,11 @@ declare module '@prantlf/jsonlint/lib/printer' {
      * Remove trailing commas after the last item in objects and arrays.
      */
     trimTrailingCommas?: boolean
+
+    /**
+     * Makes sure all line breaks are CRLF.
+     */
+    forceCrlf?: boolean
   }
 
   /**

package/lib/jsonlint.js

@@ -9,7 +9,7 @@
 // This is autogenerated with esprima tools, see:
 // https://github.com/ariya/esprima/blob/master/esprima.js
 
-// eslint-disable-next-line no-unused-vars
+// biome-ignore lint/correctness/noUnusedVariables: generated code
 const Uni = {
   isWhiteSpace: function isWhiteSpace (x) {
     // section 7.2, table 2
@@ -103,7 +103,7 @@ const unescapeMap = {
   '/': '/'
 }
 
-const ownsProperty = Object.prototype.hasOwnProperty
+const ownsProperty = Object.hasOwn
 
 const emptyObject = {}
 
@@ -391,7 +391,7 @@ function parseInternal (input, options) {
     while (position < inputLength) {
       skipWhiteSpace()
       const key = parseKey()
-      if (allowDuplicateObjectKeys === false && ownsProperty.call(result, key)) {
+      if (allowDuplicateObjectKeys === false && ownsProperty(result, key)) {
         fail(`Duplicate key: "${key}"`)
       }
       skipWhiteSpace()
@@ -727,7 +727,7 @@ function parseInternal (input, options) {
   }
 }
 
-// eslint-disable-next-line no-unused-vars
+// biome-ignore lint/correctness/noUnusedVariables: concatenated with other files
 function parseCustom (input, options) {
   if (typeof options === 'function') {
     options = {
@@ -739,7 +739,7 @@ function parseCustom (input, options) {
   return parseInternal(input, options)
 }
 
-// eslint-disable-next-line no-unused-vars
+// biome-ignore lint/correctness/noUnusedVariables: concatenated with other files
 function tokenize (input, options) {
   if (!options) {
     options = {}
@@ -759,7 +759,7 @@ function escapePointerToken (token) {
     .replace(/\//g, '~1')
 }
 
-// eslint-disable-next-line no-unused-vars
+// biome-ignore lint/correctness/noUnusedVariables: concatenated with other files
 function pathToPointer (tokens) {
   if (tokens.length === 0) {
     return ''
@@ -775,7 +775,7 @@ function unescapePointerToken (token) {
     .replace(/~0/g, '~')
 }
 
-// eslint-disable-next-line no-unused-vars
+// biome-ignore lint/correctness/noUnusedVariables: concatenated with other files
 function pointerToPath (pointer) {
   if (pointer === '') {
     return []
@@ -881,7 +881,7 @@ function getLocationOnSpiderMonkey (input, reason) {
   if (match) {
     const line = +match[1]
     const column = +match[2]
-    const offset = getOffset(input, line, column) // eslint-disable-line no-undef
+    const offset = getOffset(input, line, column)
     return {
       offset,
       line,
@@ -942,7 +942,7 @@ function improveNativeError (input, error) {
   return error
 }
 
-// eslint-disable-next-line no-unused-vars
+// biome-ignore lint/correctness/noUnusedVariables: concatenated with other files
 function parseNative (input, reviver) {
   try {
     return JSON.parse(input, reviver)
@@ -974,7 +974,7 @@ function getReviver (options) {
   }
 }
 
-// eslint-disable-next-line no-unused-vars
+// biome-ignore lint/correctness/noUnusedVariables: concatenated with other files
 function parse (input, options) {
   options || (options = {})
   return needsCustomParser(options)

package/lib/printer.js

@@ -48,6 +48,7 @@
     const enforceDoubleQuotes = options.enforceDoubleQuotes
     const enforceSingleQuotes = options.enforceSingleQuotes
     const trimTrailingCommas = options.trimTrailingCommas
+    const newLineChar = options.forceCrlf === true ? "\r\n" : "\n"
 
     let outputString = ''
     let foundLineBreak
@@ -90,7 +91,7 @@
     let addDelayedSpaceOrLineBreak
     if (prettyPrint) {
       addLineBreak = function () {
-        outputString += '\n'
+        outputString += newLineChar
       }
 
       addDelayedSpaceOrLineBreak = function () {
@@ -206,7 +207,7 @@
         if (enforceDoubleQuotes && tokenContent[0] !== '"') {
           outputString += JSON.stringify(tokenValue)
         } else if (enforceSingleQuotes && tokenContent[0] !== '\'') {
-          outputString += `\'${tokenValue.replace(/'/g, '\\\'')}\'`
+          outputString += `'${tokenValue.replace(/'/g, '\\\'')}'`
         } else {
           outputString += tokenContent
         }

package/lib/sorter.js

@@ -6,18 +6,19 @@
   'use strict'
 
   // from http://stackoverflow.com/questions/1359761/sorting-a-json-object-in-javascript
-  const ownsProperty = Object.prototype.hasOwnProperty
+  const ownsProperty = Object.hasOwn
+  const formatString = Object.prototype.toString
   function sortObject (o, { ignoreCase, locale, caseFirst, numeric } = {}) {
     if (Array.isArray(o)) {
       return o.map(sortObject)
-    }if (Object.prototype.toString.call(o) !== '[object Object]') {
+    }if (formatString.call(o) !== '[object Object]') {
       return o
     }
     const sorted = {}
     let key
     const a = []
     for (key in o) {
-      if (ownsProperty.call(o, key)) {
+      if (ownsProperty(o, key)) {
         a.push(key)
       }
     }

package/lib/validator.js

@@ -7,7 +7,10 @@
       AjvJTD: 'ajv/dist/jtd',
       Ajv2019: 'ajv/dist/2019',
       Ajv2020: 'ajv/dist/2020',
-      Schema06: 'ajv/dist/refs/json-schema-draft-06.json'
+      Schema06: 'ajv/dist/refs/json-schema-draft-06.json',
+      Keywords: 'ajv-keywords',
+      Formats: 'ajv-formats',
+      Formats2019: 'ajv-formats-draft2019'
     }
     const requireAjv = name => {
       const exported = require(ajv[name])
@@ -101,27 +104,38 @@
     return error
   }
 
-  function createAjv (environment) {
+  function createAjv (environment, ajvOptions) {
     let ajv
     if (!environment || environment === 'json-schema-draft-06' || environment === 'draft-06') {
       const Ajv = requireAjv('Ajv07')
-      ajv = new Ajv()
+      ajv = new Ajv(ajvOptions)
       ajv.addMetaSchema(requireAjv('Schema06'))
+      requireAjv('Formats')(ajv)
+      requireAjv('Keywords')(ajv)
     } else if (environment === 'json-schema-draft-07' || environment === 'draft-07') {
       const Ajv = requireAjv('Ajv07')
-      ajv = new Ajv()
+      ajv = new Ajv(ajvOptions)
+      requireAjv('Formats')(ajv)
+      requireAjv('Formats2019')(ajv)
+      requireAjv('Keywords')(ajv)
     } else if (environment === 'json-schema-draft-04' || environment === 'draft-04') {
       const Ajv = requireAjv('Ajv04')
-      ajv = new Ajv()
+      ajv = new Ajv(ajvOptions)
     } else if (environment === 'json-schema-draft-2019-09' || environment === 'draft-2019-09') {
       const Ajv = requireAjv('Ajv2019')
-      ajv = new Ajv()
+      ajv = new Ajv(ajvOptions)
+      requireAjv('Formats')(ajv)
+      requireAjv('Formats2019')(ajv)
+      requireAjv('Keywords')(ajv)
     } else if (environment === 'json-schema-draft-2020-12' || environment === 'draft-2020-12') {
       const Ajv = requireAjv('Ajv2020')
-      ajv = new Ajv()
+      ajv = new Ajv(ajvOptions)
+      requireAjv('Formats')(ajv)
+      requireAjv('Formats2019')(ajv)
+      requireAjv('Keywords')(ajv)
     } else if (environment === 'json-type-definition' || environment === 'jtd' || environment === 'rfc8927') {
       const Ajv = requireAjv('AjvJTD')
-      ajv = new Ajv()
+      ajv = new Ajv(ajvOptions)
     } else {
       throw new RangeError(`Unsupported environment for the JSON Schema validation: "${environment}".`)
     }
@@ -160,7 +174,11 @@
       options = environment
       environment = options.environment
     }
-    const ajv = createAjv(environment)
+    const ajvOptions = {}
+    if (options.strict === false) {
+      ajvOptions.strict = false
+    }
+    const ajv = createAjv(environment, ajvOptions)
     const parseOptions = {
       mode: options.mode,
       ignoreBOM: options.ignoreBOM,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prantlf/jsonlint",
-  "version": "15.0.0",
+  "version": "16.1.0",
   "description": "JSON/CJSON/JSON5 parser, syntax and schema validator and pretty-printer.",
   "author": "Ferdinand Prantl <prantlf@gmail.com> (http://prantl.tk)",
   "contributors": [
@@ -36,7 +36,7 @@
     "web"
   ],
   "engines": {
-    "node": ">= 14"
+    "node": ">=16.9"
   },
   "scripts": {
     "build": "npm run compile:jsonlint && rollup -c && npm run minify && npm run compile:tests",
@@ -58,28 +58,32 @@
   "dependencies": {
     "ajv": "8.17.1",
     "ajv-draft-04": "1.0.0",
+    "ajv-formats": "^3.0.1",
+    "ajv-formats-draft2019": "^1.6.1",
+    "ajv-keywords": "^5.1.0",
     "cosmiconfig": "9.0.0",
-    "diff": "5.2.0",
-    "fast-glob": "3.3.2"
+    "diff": "8.0.2",
+    "fast-glob": "3.3.3",
+    "picocolors": "^1.1.1"
   },
   "devDependencies": {
-    "@biomejs/biome": "^1.8.3",
-    "@rollup/plugin-commonjs": "26.0.1",
+    "@biomejs/biome": "^2.3.11",
+    "@rollup/plugin-commonjs": "29.0.0",
     "@rollup/plugin-json": "6.1.0",
-    "@rollup/plugin-node-resolve": "15.2.3",
-    "@types/node": "22.1.0",
+    "@rollup/plugin-node-resolve": "16.0.3",
+    "@types/node": "25.0.3",
     "@unixcompat/cat.js": "2.0.0",
     "@unixcompat/mv.js": "2.0.0",
-    "c8": "10.1.2",
-    "esbuild": "0.23.0",
+    "c8": "10.1.3",
+    "esbuild": "0.27.2",
     "http-server": "14.1.1",
-    "js-yaml": "4.1.0",
-    "rollup": "4.20.0",
-    "rollup-plugin-swc-minify": "1.1.2",
+    "js-yaml": "4.1.1",
+    "rollup": "4.54.0",
+    "rollup-plugin-swc-minify": "1.3.0",
     "tehanu": "1.0.1",
     "tehanu-repo-coco": "1.0.1",
     "tehanu-teru": "1.0.1",
-    "typescript": "5.5.4"
+    "typescript": "5.9.3"
   },
   "keywords": [
     "json",