feat: Support parser options for customisation and performance in JSON schema parsing too

Author: prantlf

README.md

@@ -101,6 +101,17 @@ const validate = validator.compile('string with JSON schema')
 validate(parser.parse('string with JSON data'))
 ```
 
+Compiling JSON schema supports the same options for customisation and performance improvement as parsing JSON data (`ignoreComments`, `allowSingleQuotedStrings`, `limitedErrorInfo`). They can be passed as the second (object) parameter. The optional second `environment` parameter can be passed as an additional property in the options object:
+
+```js
+const validator = require('@prantlf/jsonlint/lib/validator')
+const validate = validator.compile('string with JSON schema', {
+  limitedErrorInfo: true,
+  environment: 'json-schema-draft-04'
+})
+validate(jsonData)
+```
+
 ### Performance
 
 This is a part of [performance test results](./benchmarks/results/performance.md) of parsing a 3.8 KB formatted string ([package.json](./package,json)) with Node.js 10.15.3:

lib/cli.js

@@ -66,23 +66,24 @@ if (options.compact) {
 }
 
 function parse (source, file) {
-  var parsed
-  var formatted
+  var parserOptions, parsed, formatted
   parsedFile = file
   try {
-    parsed = parser.parse(source, {
+    parserOptions = {
       ignoreComments: options.comments,
       allowSingleQuotedStrings: options.singleQuotedStrings,
       limitedErrorInfo: !(options.comments || options.singleQuotedStrings)
-    })
+    }
+    parsed = parser.parse(source, parserOptions)
     if (options.sortKeys) {
       parsed = sorter.sortObject(parsed)
     }
     if (options.validate) {
       var validate
       try {
         var schema = fs.readFileSync(path.normalize(options.validate), 'utf8')
-        validate = validator.compile(schema, options.environment)
+        parserOptions.environment = options.environment
+        validate = validator.compile(schema, parserOptions)
       } catch (error) {
         var message = 'Loading the JSON schema failed: "' +
           options.validate + '".\n' + error.message

lib/validator.js

@@ -29,6 +29,11 @@
   'use strict'
 
   function compile (schema, environment) {
+    var options = {}
+    if (typeof environment === 'object') {
+      options = environment
+      environment = options.environment
+    }
     var ajv
     if (!environment) {
       ajv = new Ajv({ schemaId: 'auto' })
@@ -48,7 +53,11 @@
     }
     var validate
     try {
-      schema = jsonlint.parse(schema)
+      schema = jsonlint.parse(schema, {
+        ignoreComments: options.ignoreComments,
+        allowSingleQuotedStrings: options.allowSingleQuotedStrings,
+        limitedErrorInfo: options.limitedErrorInfo
+      })
       validate = ajv.compile(schema)
     } catch (error) {
       throw new Error('Compiling the JSON schema failed.\n' + error.message)

test/all-tests.js

@@ -326,8 +326,15 @@ exports['test schema validation success'] = function () {
 exports['test schema validation failure'] = function () {
   var data = fs.readFileSync(path.join(__dirname, '/passes/3.schema.json')).toString()
   var schema = fs.readFileSync(path.join(__dirname, '/passes/3.schema.json')).toString()
-  var validate = validator.compile(schema)
-  assert['throws'](function () { validate(parser.parse(data)) }, 'should throw error')
+  var validate = validator.compile(schema, {
+    limitedErrorInfo: nativeParser,
+    environment: 'json-schema-draft-04'
+  })
+  assert['throws'](function () {
+    validate(parser.parse(data, {
+      limitedErrorInfo: nativeParser
+    }))
+  }, 'should throw error')
 }
 
 if (require.main === module) { require('test').run(exports) }

web/jsonlint.html

@@ -137,13 +137,15 @@ <h2>Result</h2>
         document.getElementById('result-section').style.display = 'block'
         try {
           var parser = jsonlint.parser
-          var parsed = parser.parse(document.getElementById('data').value, {
+          var parserOptions = {
             ignoreComments: document.getElementById('comments').checked,
-            allowSingleQuotedStrings: document.getElementById('single-quoted-strings').checked
-          })
+            allowSingleQuotedStrings: document.getElementById('single-quoted-strings').checked,
+            limitedErrorInfo: !(options.comments || options.singleQuotedStrings)
+          }
+          var parsed = parser.parse(document.getElementById('data').value, parserOptions)
           if (document.getElementById('with-schema').checked) {
             var schema = document.getElementById('schema').value
-            var validate = jsonlintValidator.compile(schema)
+            var validate = jsonlintValidator.compile(schema, parserOptions)
             validate(parsed)
           }
           document.getElementById('result').innerText = 'Data is valid!'