feat: Remove deprecated exports Parser and parser

BREAKING CHANGE: The `Parser` class and `parser` instance did not bring any benefit. They were generated by Jison. After abandoning the Jison parser they were kept for compatibility only. The only method on the `Parser` prototype was the `parse`. It remains unchanged as a direct export. Drop the class interface and just call the `parse` method directly.

Author: prantlf

README.md

@@ -21,9 +21,11 @@ This is a fork of the original package with the following enhancements:
 * Reports errors with rich additional information. From the schema validation too.
 * Implements JavaScript modules using [UMD] to work everywhere.
 * Depends on up-to-date npm modules with no installation warnings.
-* Small size - 19.4 kB minified, 6.7 kB gzipped.
+* Small size - 18.2 kB minified, 6.3 kB gzipped.
 
-Integration to the favourite task loaders is provided by the following NPM modules:
+**Note:** In comparison with the original project, this package exports only the `parse` method; not the `Parser` object.
+
+Integration to the favourite task loaders for JSON file validation is provided by the following NPM modules:
 
 * [`Grunt`] - see [`@prantlf/grunt-jsonlint`]
 * [`Gulp`] - see [`@prantlf/gulp-jsonlint`]

scripts/bundle-jsonlint.js

@@ -8,29 +8,29 @@ var prefix = `(function (global, factory) {
 
 `
 var suffix = `
-  exports.parser = jsonlint
-  exports.Parser = jsonlint.Parser
-  exports.parse = function (input, options) {
-    return jsonlint.parse(input, options, false)
-  }
-  exports.parseNative = parseNative
-  exports.parseCustom = parseCustom
+  exports.parse = parse
   exports.tokenize = tokenize
-  exports.getErrorTexts = getTexts
   exports.pathToPointer = pathToPointer
   exports.pointerToPath = pointerToPath
+
+  exports.parseNative = parseNative
+  exports.parseCustom = parseCustom
+  exports.getErrorTexts = getTexts
+
   Object.defineProperty(exports, '__esModule', { value: true })
 }));
 `
 var unicodeFile = path.join(__dirname, '../src/unicode.js')
 var unicodeSource = fs.readFileSync(unicodeFile, 'utf8')
 var customFile = path.join(__dirname, '../src/custom-parser.js')
 var customSource = fs.readFileSync(customFile, 'utf8')
+var pointerFile = path.join(__dirname, '../src/pointer.js')
+var pointerSource = fs.readFileSync(pointerFile, 'utf8')
 var nativeFile = path.join(__dirname, '../src/native-parser.js')
 var nativeSource = fs.readFileSync(nativeFile, 'utf8')
 var configurableFile = path.join(__dirname, '../src/configurable-parser.js')
 var configurableSource = fs.readFileSync(configurableFile, 'utf8')
 var jsonlintFile = path.join(__dirname, '../lib/jsonlint.js')
 var jsonlintSource = prefix + unicodeSource + '\n' + customSource + '\n' +
-  nativeSource + '\n' + configurableSource + suffix
+  pointerSource + '\n' + nativeSource + '\n' + configurableSource + suffix
 fs.writeFileSync(jsonlintFile, jsonlintSource)

src/configurable-parser.js

@@ -1,59 +1,12 @@
 /* globals navigator, process, parseCustom, parseNative */
 
-function Parser (options, deprecate) {
-  if (deprecate !== false) {
-    console.warn('DEPRECATED: Do not instantiate an object of the class Parser. Call the method `parse` directly exported from the main module (`lib/jsonlint`).')
-  }
-  processOptions.call(this, options)
-}
-
-function processOptions (options) {
-  if (options) {
-    var changed = {}
-    if (options.ignoreComments !== undefined) {
-      changed.ignoreComments = this.ignoreComments
-      this.ignoreComments = options.ignoreComments
-    }
-    if (options.ignoreTrailingCommas !== undefined) {
-      changed.ignoreTrailingCommas = this.ignoreTrailingCommas
-      this.ignoreTrailingCommas = options.ignoreTrailingCommas
-    }
-    if (options.allowSingleQuotedStrings !== undefined) {
-      changed.allowSingleQuotedStrings = this.allowSingleQuotedStrings
-      this.allowSingleQuotedStrings = options.allowSingleQuotedStrings
-    }
-    if (options.allowDuplicateObjectKeys !== undefined) {
-      changed.allowDuplicateObjectKeys = this.allowDuplicateObjectKeys
-      this.allowDuplicateObjectKeys = options.allowDuplicateObjectKeys
-    }
-    if (options.mode !== undefined) {
-      changed.mode = this.mode
-      this.mode = options.mode
-    }
-    return changed
-  }
-}
-
-function restoreContext (changed) {
-  if (changed) {
-    for (var option in changed) {
-      var value = changed[option]
-      if (value === undefined) {
-        delete this[option]
-      } else {
-        this[option] = value
-      }
-    }
-  }
-}
-
 var isSafari = typeof navigator !== 'undefined' && /Safari/.test(navigator.userAgent) && /Apple Computer/.test(navigator.vendor)
 var oldNode = typeof process !== 'undefined' && process.version.startsWith('v4.')
 
-function needsCustomParser () {
-  return this.ignoreComments || this.ignoreTrailingCommas ||
-    this.allowSingleQuotedStrings || this.allowDuplicateObjectKeys === false ||
-    this.mode === 'cjson' || this.mode === 'json5' || isSafari || oldNode
+function needsCustomParser (options) {
+  return options.ignoreComments || options.ignoreTrailingCommas ||
+  options.allowSingleQuotedStrings || options.allowDuplicateObjectKeys === false ||
+  options.mode === 'cjson' || options.mode === 'json5' || isSafari || oldNode
 }
 
 function getReviver (options) {
@@ -64,21 +17,9 @@ function getReviver (options) {
   }
 }
 
-Parser.prototype.constructor = Parser
-Parser.prototype.Parser = Parser
-
-Parser.prototype.parse = function (input, options, deprecate) {
-  if (deprecate !== false) {
-    console.warn('DEPRECATED: Do not call the instance method `parse`. method  Call the `parse` directly exported from the main module (`lib/jsonlint`).')
-  }
-  var changed = processOptions.call(this, options)
-  try {
-    return needsCustomParser.call(this)
-      ? parseCustom.call(this, input, options)
-      : parseNative(input, getReviver(options))
-  } finally {
-    restoreContext.call(this, changed)
-  }
+function parse (input, options) { // eslint-disable-line no-unused-vars
+  options || (options = {})
+  return needsCustomParser(options)
+    ? parseCustom(input, options)
+    : parseNative(input, getReviver(options))
 }
-
-var jsonlint = new Parser(undefined, false) // eslint-disable-line no-unused-vars

src/custom-parser.js

@@ -654,38 +654,3 @@ function tokenize (input, options) { // eslint-disable-line no-unused-vars
   options.tokenize = true
   return parseInternal(input, options)
 }
-
-function escapePointerToken (token) {
-  return token
-    .toString()
-    .replace(/~/g, '~0')
-    .replace(/\//g, '~1')
-}
-
-function pathToPointer (tokens) { // eslint-disable-line no-unused-vars
-  if (tokens.length === 0) {
-    return ''
-  }
-  return '/' + tokens
-    .map(escapePointerToken)
-    .join('/')
-}
-
-function unescapePointerToken (token) {
-  return token
-    .replace(/~1/g, '/')
-    .replace(/~0/g, '~')
-}
-
-function pointerToPath (pointer) { // eslint-disable-line no-unused-vars
-  if (pointer === '') {
-    return []
-  }
-  if (pointer[0] !== '/') {
-    throw new Error('Missing initial "/" in the reference')
-  }
-  return pointer
-    .substr(1)
-    .split('/')
-    .map(unescapePointerToken)
-}

src/pointer.js

@@ -0,0 +1,34 @@
+function escapePointerToken (token) {
+  return token
+    .toString()
+    .replace(/~/g, '~0')
+    .replace(/\//g, '~1')
+}
+
+function pathToPointer (tokens) { // eslint-disable-line no-unused-vars
+  if (tokens.length === 0) {
+    return ''
+  }
+  return '/' + tokens
+    .map(escapePointerToken)
+    .join('/')
+}
+
+function unescapePointerToken (token) {
+  return token
+    .replace(/~1/g, '/')
+    .replace(/~0/g, '~')
+}
+
+function pointerToPath (pointer) { // eslint-disable-line no-unused-vars
+  if (pointer === '') {
+    return []
+  }
+  if (pointer[0] !== '/') {
+    throw new Error('Missing initial "/" in the reference')
+  }
+  return pointer
+    .substr(1)
+    .split('/')
+    .map(unescapePointerToken)
+}

test/parse1.js

@@ -6,8 +6,6 @@ var path = require('path')
 var assert = require('assert')
 
 var exported = require('../lib/jsonlint')
-var Parser = exported.Parser
-var parser = exported.parser
 var parse = exported.parse
 var validator = require('../lib/validator')
 
@@ -32,61 +30,21 @@ function checkErrorInformation (error) {
 if (!nativeParser) {
   exports['test exported interface'] = function () {
     assert.equal(typeof parse, 'function')
-    assert.equal(typeof parser, 'object')
-    assert.equal(typeof Parser, 'function')
-    assert.equal(typeof Parser.prototype, 'object')
-    assert.equal(Object.getPrototypeOf(parser), Parser.prototype)
-    assert.equal(Parser.prototype.constructor, Parser)
   }
 
   exports['test function'] = function () {
     var json = '{"foo": "bar"}'
     assert.deepEqual(parse(json), { 'foo': 'bar' })
   }
+}
 
-  exports['test function object'] = function () {
-    var json = '{"foo": "bar"}'
-    var parser = new Parser()
-    assert.deepEqual(parser.parse(json), { 'foo': 'bar' })
-  }
-
-  exports['test context cleanup'] = function () {
-    var json = '{"foo": "bar"}'
-    assert.equal(Object.keys(parser).length, 0)
-    assert.deepEqual(parse(json, { ignoreComments: true }), { 'foo': 'bar' })
-    assert.equal(Object.keys(parser).length, 0)
-  }
-
-  exports['test context restoration'] = function () {
-    var json = '{"foo": "bar"}'
-    var parser = new Parser({
-      ignoreComments: false
-    })
-    assert.deepEqual(parse(json, { ignoreComments: true }), { 'foo': 'bar' })
-    assert.equal(parser.ignoreComments, false)
-  }
-
-  exports['test limited error information'] = function () {
-    var json = '{"foo": ?}'
-    var parser = new Parser({
-      ignoreComments: true
-    })
-    try {
-      parser.parse(json)
-      assert.fail()
-    } catch (error) {
-      checkErrorInformation(error)
-    }
-  }
-} else {
-  exports['test limited error information'] = function () {
-    var json = '{"foo": ?}'
-    try {
-      parse(json)
-      assert.fail()
-    } catch (error) {
-      checkErrorInformation(error)
-    }
+exports['test limited error information'] = function () {
+  var json = '{"foo": ?}'
+  try {
+    parse(json)
+    assert.fail()
+  } catch (error) {
+    checkErrorInformation(error)
   }
 }