fix: Rename the property "exzerpt" in error information to "excerpt"

BREAKING CHANGE: If you used the property "exzerpt" from the parsing error object, you have to change it to "excerpt". It should be easy using a full-text search in your sources.

Author: prantlf

README.md

@@ -271,8 +271,8 @@ If parsing fails, a `SyntaxError` will be thrown with the following properties:
 | ---------- | ----------------------------------------- |
 | `message`  | the full multi-line error message         |
 | `reason`   | one-line explanation of the error         |
-| `exzerpt`  | part of the input string around the error |
-| `pointer`  | "--^" pointing to the error in `exzerpt`  |
+| `excerpt`  | part of the input string around the error |
+| `pointer`  | "--^" pointing to the error in `excerpt`  |
 | `location` | object pointing to the error location     |
 
 The `location` object contains properties `line`, `column` and `offset`.
@@ -289,13 +289,13 @@ const { parse } = require('@prantlf/jsonlint')
 try {
   parse('{"creative": ?}')
 } catch (error) {
-  const { message, reason, exzerpt, pointer, location } = error
+  const { message, reason, excerpt, pointer, location } = error
   const { column, line, offset } = location.start
   // Logs the complete error message:
   console.log(message)
   // Logs the same text as included in the `message` property:
   console.log(`Parse error on line ${line}, ${column} column:
-${exzerpt}
+${excerpt}
 ${pointer}
 ${reason}`)
 }

lib/validator.js

@@ -39,7 +39,7 @@
       var column = location.column
       var texts = jsonlint.getErrorTexts(problem.reason, input, offset, line, column)
       problem.message = texts.message
-      problem.exzerpt = texts.exzerpt
+      problem.excerpt = texts.excerpt
       if (texts.pointer) {
         problem.pointer = texts.pointer
         problem.location = {

package.json

@@ -40,7 +40,7 @@
     "build": "npm run compile && npm run compile:tests",
     "compile": "node scripts/bundle-jsonlint && uglifyjs -o web/jsonlint.min.js --source-map \"filename='jsonlint.js',url='jsonlint.min.js.map',includeSources=true\" lib/jsonlint.js && uglifyjs -o web/validator.min.js --source-map \"filename='validator.js',url='validator.min.js.map',includeSources=true\" lib/validator.js && uglifyjs -o web/formatter.min.js --source-map \"filename='formatter.js',url='formatter.min.js.map',includeSources=true\" lib/formatter.js && uglifyjs -o web/sorter.min.js --source-map \"filename='sorter.js',url='sorter.min.js.map',includeSources=true\" lib/sorter.js && uglifyjs -o web/printer.min.js --source-map \"filename='printer.js',url='printer.min.js.map',includeSources=true\" lib/printer.js && node scripts/bundle-schema-drafts && uglifyjs -o web/schema-drafts.min.js --source-map \"filename='schema-drafts.js',url='schema-drafts.min.js.map',includeSources=true\" lib/schema-drafts.js && uglifyjs -o web/ajv.min.js --source-map \"filename='ajv.js',url='ajv.min.js.map',includeSources=true\" node_modules/ajv/dist/ajv.bundle.js",
     "compile:tests": "tsc --lib es6 test/typings.test.ts",
-    "test": "nyc --silent node test/typings.test.js && nyc --silent --no-clean node test/parse1 && nyc --silent --no-clean node test/parse1 --native-parser && nyc --silent --no-clean node test/parse2 && nyc --silent --no-clean node test/parse3 && nyc --silent --no-clean node test/parse4 && nyc --silent --no-clean node test/parse5 && nyc --silent --no-clean node test/portable && nyc --silent --no-clean node test/tokenize && nyc --silent --no-clean node test/print && nyc --silent --no-clean node lib/cli package.json test/recursive && nyc --silent --no-clean node lib/cli -sq test/passes/hasOwnProperty.json && nyc --silent --no-clean node lib/cli -s -e json-schema-draft-04 -V test/passes/3.schema.json test/passes/3.json && nyc --silent --no-clean node lib/cli -C test/passes/comments.txt && nyc --silent --no-clean node lib/cli -S test/passes/strings.txt && nyc --silent --no-clean node lib/cli -M json5 test/passes/json5.text && nyc --silent --no-clean node lib/cli -v && nyc --silent --no-clean node lib/cli -h && nyc --silent --no-clean node lib/cli -Pc test/fails/10.json || nyc report",
+    "test": "nyc --silent node test/typings.test.js && nyc --silent --no-clean node test/parse1 && nyc --silent --no-clean node test/parse1 --native-parser && nyc --silent --no-clean node test/parse2 && nyc --silent --no-clean node test/parse3 && nyc --silent --no-clean node test/parse4 && nyc --silent --no-clean node test/parse5 && nyc --silent --no-clean node test/portable && nyc --silent --no-clean node test/tokenize && nyc --silent --no-clean node test/print && nyc --silent --no-clean node lib/cli package.json test/recursive && nyc --silent --no-clean node lib/cli -sq test/passes/hasOwnProperty.json && nyc --silent --no-clean node lib/cli -s -e json-schema-draft-04 -V test/passes/3.schema.json test/passes/3.json && nyc --silent --no-clean node lib/cli -C test/passes/comments.txt && nyc --silent --no-clean node lib/cli -pS test/passes/strings.txt && nyc --silent --no-clean node lib/cli -M json5 test/passes/json5.text && nyc --silent --no-clean node lib/cli -v && nyc --silent --no-clean node lib/cli -h && nyc --silent --no-clean node lib/cli -Pc test/fails/10.json || nyc report",
     "start": "http-server -c 5",
     "web": "npm run web:sync && npm run web:deploy",
     "web:clone": "test ! -d ../jsonlint-pages && git clone --single-branch --branch gh-pages `git remote get-url origin` ../jsonlint-pages",

src/custom-parser.js

@@ -114,7 +114,7 @@ function parseInternal (input, options) {
     var texts = getTexts(message, input, position, lineNumber, column)
     var error = SyntaxError(texts.message)
     error.reason = message
-    error.exzerpt = texts.exzerpt
+    error.excerpt = texts.excerpt
     error.pointer = texts.pointer
     error.location = {
       start: {

src/native-parser.js

@@ -29,7 +29,7 @@ function getPositionContext (input, offset) {
   var upcoming = upcomingInput(input, offset)
   var pointer = new Array(past.length + 1).join('-') + '^'
   return {
-    exzerpt: past + upcoming,
+    excerpt: past + upcoming,
     pointer: pointer
   }
 }
@@ -90,18 +90,18 @@ function getLocationOnSpiderMonkey (input, reason) {
 
 function getTexts (reason, input, offset, line, column) {
   var position = getPositionContext(input, offset)
-  var exzerpt = position.exzerpt
+  var excerpt = position.excerpt
   var message, pointer
   if (typeof line === 'number') {
     pointer = position.pointer
     message = 'Parse error on line ' + line + ', column ' +
-      column + ':\n' + exzerpt + '\n' + pointer + '\n' + reason
+      column + ':\n' + excerpt + '\n' + pointer + '\n' + reason
   } else {
-    message = 'Parse error in JSON input:\n' + exzerpt + '\n' + reason
+    message = 'Parse error in JSON input:\n' + excerpt + '\n' + reason
   }
   return {
     message: message,
-    exzerpt: exzerpt,
+    excerpt: excerpt,
     pointer: pointer
   }
 }
@@ -123,7 +123,7 @@ function improveNativeError (input, error) {
   error.reason = reason
   var texts = getTexts(reason, input, offset, line, column)
   error.message = texts.message
-  error.exzerpt = texts.exzerpt
+  error.excerpt = texts.excerpt
   if (texts.pointer) {
     error.pointer = texts.pointer
     error.location = {

test/parse1.js

@@ -16,7 +16,7 @@ parse = nativeParser ? exported.parseNative : exported.parseCustom
 function checkErrorInformation (error) {
   assert.equal(typeof error.message, 'string')
   assert.equal(typeof error.reason, 'string')
-  assert.equal(typeof error.exzerpt, 'string')
+  assert.equal(typeof error.excerpt, 'string')
   if (!oldNode) {
     assert.equal(typeof error.pointer, 'string')
     assert.equal(typeof error.location, 'object')
@@ -264,7 +264,7 @@ if (!oldNode) {
       exported.parseNative(json)
       assert.fail('should throw error')
     } catch (error) {
-      assert.equal(error.exzerpt, '...      "bar":    }    }')
+      assert.equal(error.excerpt, '...      "bar":    }    }')
       assert.equal(error.pointer, '-------------------^')
       assert.equal(error.reason, 'Unexpected token }')
       assert.deepEqual(error.location, {
@@ -281,7 +281,7 @@ exports['test error location with Windows line breaks using the custom parser']
     exported.parseCustom(json)
     assert.fail('should throw error')
   } catch (error) {
-    assert.equal(error.exzerpt, '...      "bar":    }    }')
+    assert.equal(error.excerpt, '...      "bar":    }    }')
     assert.equal(error.pointer, '-------------------^')
     assert.equal(error.reason, 'No value found for key "bar"')
     assert.deepEqual(error.location, {