chore: Update benchmarks and add the json-6 parser

Author: prantlf

benchmarks/README.md

@@ -25,30 +25,30 @@ If you modify some grammars, you have to regenerate parsers before running the t
 ## Performance
 
     ❯ node parse
-    Parsing JSON data 4868 characters long using:
-      the built-in parser x 51,485 ops/sec ±7.66% (58 runs sampled)
-      the pure chevrotain parser x 6,445 ops/sec ±9.27% (52 runs sampled)
-      the extended chevrotain parser x 6,802 ops/sec ±8.64% (63 runs sampled)
-      the standard jsonlint parser x 56,024 ops/sec ±8.26% (66 runs sampled)
-      the extended jsonlint parser x 5,664 ops/sec ±9.85% (64 runs sampled)
-      the tokenising jsonlint parser x 5,086 ops/sec ±8.54% (65 runs sampled)
-      the pure hand-built parser x 9,260 ops/sec ±8.53% (67 runs sampled)
-      the extended hand-built parser x 8,965 ops/sec ±8.46% (66 runs sampled)
-      the AST parser x 6,226 ops/sec ±7.87% (85 runs sampled)
-      the Myna parser x 1,784 ops/sec ±7.12% (81 runs sampled)
-      the pure jju parser x 5,047 ops/sec ±8.06% (72 runs sampled)
-      the extended jju parser x 4,966 ops/sec ±7.73% (73 runs sampled)
-      the tokenisable jju parser x 4,287 ops/sec ±8.43% (65 runs sampled)
-      the tokenising jju parser x 3,378 ops/sec ±8.30% (65 runs sampled)
-      the comments-enabled parser x 4,101 ops/sec ±9.01% (65 runs sampled)
-      the pure pegjs parser x 1,628 ops/sec ±8.18% (59 runs sampled)
-      the extended pegjs parser x 1,611 ops/sec ±9.66% (63 runs sampled)
-      the pure jison parser x 1,283 ops/sec ±9.04% (57 runs sampled)
-      the extended jison parser x 1,186 ops/sec ±8.65% (58 runs sampled)
-      the JSON5 parser x 953 ops/sec ±8.71% (68 runs sampled)
-      the Nearley parser x 663 ops/sec ±8.44% (59 runs sampled)
-    The fastest one was the standard jsonlint parser.
-
+    Parsing JSON data 4797 characters long using:
+      the built-in parser x 78,856 ops/sec ±0.50% (92 runs sampled)
+      the pure chevrotain parser x 9,815 ops/sec ±1.29% (90 runs sampled)
+      the extended chevrotain parser x 9,512 ops/sec ±0.90% (92 runs sampled)
+      the standard jsonlint parser x 78,998 ops/sec ±0.48% (95 runs sampled)
+      the extended jsonlint parser x 7,923 ops/sec ±0.51% (93 runs sampled)
+      the tokenising jsonlint parser x 6,281 ops/sec ±0.71% (91 runs sampled)
+      the pure hand-built parser x 13,529 ops/sec ±0.62% (92 runs sampled)
+      the extended hand-built parser x 13,475 ops/sec ±0.81% (92 runs sampled)
+      the AST parser x 9,201 ops/sec ±0.74% (91 runs sampled)
+      the Myna parser x 3,089 ops/sec ±0.54% (94 runs sampled)
+      the pure jju parser x 8,596 ops/sec ±0.98% (92 runs sampled)
+      the extended jju parser x 6,966 ops/sec ±0.59% (89 runs sampled)
+      the tokenisable jju parser x 6,091 ops/sec ±0.84% (89 runs sampled)
+      the tokenising jju parser x 4,651 ops/sec ±0.54% (92 runs sampled)
+      the comments-enabled parser x 5,632 ops/sec ±0.65% (92 runs sampled)
+      the pure pegjs parser x 2,413 ops/sec ±0.69% (92 runs sampled)
+      the extended pegjs parser x 2,124 ops/sec ±0.66% (92 runs sampled)
+      the pure jison parser x 1,722 ops/sec ±1.16% (88 runs sampled)
+      the extended jison parser x 1,619 ops/sec ±0.65% (91 runs sampled)
+      the JSON5 parser x 1,283 ops/sec ±0.43% (91 runs sampled)
+      the JSON6 parser x 7,922 ops/sec ±1.78% (92 runs sampled)
+      the Nearley parser x 944 ops/sec ±0.51% (92 runs sampled)
+    The fastest one were the standard jsonlint parser and the built-in parser.
 
 [performance]: ./results/performance.md
 [quality of error reporting]: ./results/errorReportingQuality.md

benchmarks/fail.js

@@ -6,6 +6,7 @@ const { parse: jjuParse } = require('./jju/pure')
 const { parse: pegjsParse } = require('./pegjs/pure')
 const jisonParser = require('./jison/pure').parser
 const JSON5 = require('json5')
+const JSON6 = require('json-6')
 const { parse: parseWithComments } = require('comment-json')
 
 const inputSources = [
@@ -231,6 +232,31 @@ function parseJSON5 () {
   }
 }
 
+function improveJSON6Error (error) {
+  let { message } = error
+  message = message.replaceAll('\n', ' ')
+  let [, lineNumber, columnNumber] = / \[(\d+):(\d+)\]$/.exec(message)
+  --columnNumber
+  const cursor = `line ${lineNumber}, column ${columnNumber}`
+  const offset = getOffset(lineNumber, columnNumber)
+  const position = showPosition({ offset })
+  message = message
+    .replace(/ \[\d+:\d+\]$/, '')
+    .replace(/ \(near '.+'\)$/, '')
+    .replace(/ unexpected at \d+$/, '')
+  message = message.charAt(0).toUpperCase() + message.substr(1)
+  error.message = `Parse error on ${cursor}:\n${position}\n${message}`
+  throw error
+}
+
+function parseJSON6 () {
+  try {
+    JSON6.parse(inputSource)
+  } catch (error) {
+    improveJSON6Error(error)
+  }
+}
+
 for (const test of inputSources) {
   inputSource = test
   const formattedTest = test
@@ -246,6 +272,7 @@ for (const test of inputSources) {
     .add('the pegjs parser', parsePegjs)
     .add('the jison parser', parseJison)
     .add('the JSON5 parser', parseJSON5)
+    .add('the JSON6 parser', parseJSON6)
     .start()
   console.log()
 }

benchmarks/package.json

@@ -6,12 +6,13 @@
   },
   "devDependencies": {
     "benchmark": "2.1.4",
-    "chevrotain": "10.1.2",
-    "comment-json": "4.2.2",
+    "chevrotain": "10.4.2",
+    "comment-json": "4.2.3",
     "jison": "0.4.18",
+    "json-6": "1.1.4",
     "json-to-ast": "2.1.0",
-    "json5": "2.2.1",
-    "moo": "0.5.1",
+    "json5": "2.2.3",
+    "moo": "0.5.2",
     "myna-parser": "2.5.1",
     "nearley": "2.20.1",
     "pegjs": "0.10.0"

benchmarks/parse.js

@@ -15,6 +15,7 @@ const handbuiltParse = require('./hand-built/pure')
 const handbuiltExtendedParse = require('./hand-built/pure')
 const astParse = require('json-to-ast')
 const JSON5 = require('json5')
+const JSON6 = require('json-6')
 const { parse: parseWithComments } = require('comment-json')
 const { parse: parseThis, tokenize: tokenizeThis } = require('..')
 const myna = require('myna-parser')
@@ -108,6 +109,10 @@ function parseJSON5 () {
   JSON5.parse(input)
 }
 
+function parseJSON6 () {
+  JSON6.parse(input)
+}
+
 function parseAST () {
   astParse(input, {
     loc: true
@@ -139,5 +144,6 @@ createSuite(`Parsing JSON data ${input.length} characters long using`)
   .add('the pure jison parser', parsePureJison)
   .add('the extended jison parser', parseExtendedJison)
   .add('the JSON5 parser', parseJSON5)
+  .add('the JSON6 parser', parseJSON6)
   .add('the Nearley parser', parseNearley)
   .start()

benchmarks/pnpm-lock.yaml

@@ -503,7 +503,13 @@ Jison appears to return different line number of the error occurrence. If there
 
 ### [JSON5]
 
-A short and technical message. Structured information about the error contains only the line and column, bot not the offset.
+A short and technical message. Structured information about the error contains only the line and column, but not the offset.
+
+The context information can be added using the line and column of the error.
+
+### [JSON6]
+
+A short and technical message. Extra information about the error is appended to the error message. It contains the offset, the line and column, and an excerpt of the invalid input.
 
 The context information can be added using the line and column of the error.
 
@@ -517,4 +523,5 @@ The context information can be added using the line and column of the error.
 [PEG.JS]: http://pegjs.org/
 [Jison]: http://zaach.github.io/jison/
 [JSON5]: https://json5.org/
+[JSON6]: https://github.com/d3x0r/JSON6#readme
 [original JSONLint]: https://github.com/zaach/jison

benchmarks/results/errorReportingQuality.md

@@ -8,7 +8,7 @@ The best parser is likely to be chosen specifically for the particular usage sce
 Universal Parser
 ----------------
 
-The most understandable messages are reported by [JJU] and [PEG.js]. The performance of the latter is not on par with the fastest parsers, but other parsers generated from a grammar specification are even slower.
+The most understandable messages are reported by [JJU] and [PEG.js]. The performance of the latter is not on par with the fastest parsers, but other parsers generated from a grammar specification are even slower. [JSON6] contains the extended information, but appended to the error message, which can make it longer and not so easy to read. 
 
 Validate Standard JSON As Fast As Possible
 ------------------------------------------
@@ -18,7 +18,7 @@ The [built-in] native JSON parser (`JSON.parse`) offers by far the best performa
 Validate Non-Standard JSON
 --------------------------
 
-Depending on extra features required, [Chevrotain] and [JJU] offer the best quality/performance ratio. Chevrotain tries harder to explain, what was wrong, which is often quite counterproductive. JJU explains the problems well-enough with a single sentence, even ended by a full-stop. Chevrotain packs additional features like recovery and reporting all errors instead of just the first one. This extra feature might make it a winner for a flexibly configurable scenario. However, the Chevrotain parser needs significantly more code, than all the others.
+Depending on extra features required, [Chevrotain], [JJU] and [JSON6] offer the best quality/performance ratio. Chevrotain tries harder to explain, what was wrong, which is often quite counterproductive. JJU explains the problems well-enough with a single sentence, even ended by a full-stop. Chevrotain packs additional features like recovery and reporting all errors instead of just the first one. This extra feature might make it a winner for a flexibly configurable scenario. However, the Chevrotain parser needs significantly more code, than all the others. JSON6 supports many extensions to JSON/JSON5 standards.
 
 [tested with a JSON grammar]: https://sap.github.io/chevrotain/performance/
 [performance]: ./performance.md
@@ -27,5 +27,4 @@ Depending on extra features required, [Chevrotain] and [JJU] offer the best qual
 [Chevrotain]: https://github.com/SAP/chevrotain
 [JJU]: http://rlidwka.github.io/jju/
 [PEG.JS]: http://pegjs.org/
-[Jison]: http://zaach.github.io/jison/
-[JSON5]: https://json5.org/
+[JSON6]: https://github.com/d3x0r/JSON6#readme