feat: replace jsonlint with json-parse-helpfulerror

Author: abacaphiliac

package.json

@@ -32,8 +32,8 @@
     "googlediff": "0.1.0",
     "http-string-parser": "0.0.5",
     "is-type": "0.0.1",
+    "json-parse-helpfulerror": "1.0.3",
     "json-pointer": "0.6.0",
-    "jsonlint": "josdejong/jsonlint",
     "media-typer": "0.3.0",
     "tv4": "1.3.0"
   },

src/mixins/validatable-http-message.coffee

@@ -1,4 +1,4 @@
-jsonlint = require 'jsonlint'
+jph = require 'json-parse-helpfulerror'
 mediaTyper = require 'media-typer'
 validators = require '../validators'
 
@@ -138,19 +138,20 @@ class Validatable
     contentType = @headers?['content-type']
     if @isJsonContentType contentType
       try
-        jsonlint.parse @body
+        jph.parse @body
         @validation.body.realType = contentType
       catch error
         message = {
-          message: 'Real body "Content-Type" header is "' +
-            contentType + '" but body is not a parsable JSON.'
+          message: """\
+            Real body 'Content-Type' header is '#{contentType}' \
+            but body is not a parseable JSON:\n#{error.message}\
+          """
           severity: 'error'
         }
-        message.message  = message.message + "\n" + error.message
         @validation.body.results.push message
     else
       try
-        JSON.parse @body
+        jph.parse @body
         @validation.body.realType = 'application/json'
       catch error
         @validation.body.realType = 'text/plain'
@@ -163,10 +164,13 @@ class Validatable
     if @expected.bodySchema?
       if typeof @expected.bodySchema == 'string'
         try
-          parsed = JSON.parse @expected.bodySchema
+          parsed = jph.parse @expected.bodySchema
           if typeof parsed != 'object' or Array.isArray parsed
             message = {
-              message: 'Cant\'t validate. Expected body JSON Schema is not an Object'
+              message: """\
+                Can't validate. Expected body JSON Schema 'Content-Type' is
+                not a parseable JSON:\n#{error.message}\
+              """
               severity: 'error'
             }
             @validation.body.results.push message
@@ -187,18 +191,20 @@ class Validatable
 
       if @isJsonContentType expectedContentType
         try
-          jsonlint.parse @expected.body
+          jph.parse @expected.body
           @validation.body.expectedType = expectedContentType
         catch error
           message = {
-            message: 'Can\'t validate. Expected body Content-Type is ' + expectedContentType + ' but body is not a parseable JSON'
+            message: """\
+              Can't validate. Expected body 'Content-Type' is '#{expectedContentType}' \
+              but body is not a parseable JSON:\n#{error.message}\
+            """
             severity: 'error'
           }
-          message.message = message.message + ": " +error.message
           @validation.body.results.push message
       else
         try
-          JSON.parse @expected.body
+          jph.parse @expected.body
           @validation.body.expectedType = 'application/json'
         catch error
           @validation.body.expectedType = 'text/plain'

test/unit/mixins/validatable-http-message-test.coffee

@@ -549,12 +549,17 @@ describe "Http validatable mixin", () ->
               assert.include results, 'error'
 
             it 'should add error message with lint result', () ->
-              expected = "Parse error on line 1:\n...\"creative?\": false, 'creativ': true }\n-----------------------^\nExpecting 'STRING', got 'undefined'"
+              expected = """\
+                Real body 'Content-Type' header is '#{contentType}' but body is not a parseable JSON:
+                Unexpected token '\\'' at 1:22
+                {"creative?": false, 'creativ': true }
+                                     ^
+              """
               messages = []
               for result in instance.validation.body.results
                 messages.push result.message
 
-              assert.include messages[0], expected
+              assert.equal messages[0], expected
 
             it 'should not overwrite existing errors', () ->
               instance.validation.body.results = [
@@ -751,12 +756,17 @@ describe "Http validatable mixin", () ->
                 assert.include messages[0], 'is not a parseable JSON'
 
               it 'should add error message with lint result', () ->
-                expected = "Parse error on line 1:\n...\"creative?\": false, 'creativ': true }\n-----------------------^\nExpecting 'STRING', got 'undefined'"
+                expected = """\
+                  Can't validate. Expected body 'Content-Type' is '#{contentType}' but body is not a parseable JSON:
+                  Unexpected token '\\'' at 1:22
+                  {"creative?": false, 'creativ': true }
+                                       ^
+                """
                 messages = []
                 for result in instance.validation.body.results
                   messages.push result.message
 
-                assert.include messages[0], expected
+                assert.equal messages[0], expected
 
         describe 'expected headers have not content-type application/json', () ->
           describe 'expected body is a parseable JSON', () ->