json5 vs json-parse-better-errors vs jsonparse vs jsonlint vs json-stream vs best-effort-json-parser
JSON Parsing Libraries Comparison
1 Year
json5json-parse-better-errorsjsonparsejsonlintjson-streambest-effort-json-parserSimilar Packages:
What's JSON Parsing Libraries?

JSON parsing libraries are essential tools in web development for handling JSON data, which is a common format for data exchange between clients and servers. These libraries provide various functionalities to parse, validate, and manipulate JSON data, each with unique features tailored to different use cases. They can enhance error handling, support additional JSON formats, or facilitate streaming JSON parsing, making them valuable for developers working with APIs and data-heavy applications.

Package Weekly Downloads Trend
Github Stars Ranking
Stat Detail
Package
Downloads
Stars
Size
Issues
Publish
License
json5102,744,9756,905235 kB36-MIT
json-parse-better-errors19,480,41869-57 years agoMIT
jsonparse16,139,387366-208 years agoMIT
jsonlint230,9131,969-807 years ago-
json-stream199,92651-511 years agoMIT
best-effort-json-parser80,11623244.5 kB35 months agoBSD-2-Clause
Feature Comparison: json5 vs json-parse-better-errors vs jsonparse vs jsonlint vs json-stream vs best-effort-json-parser

Error Handling

  • json5:

    Json5 allows for more lenient parsing rules, which means it can handle comments and trailing commas without throwing errors, making it easier to work with human-readable JSON-like structures.

  • json-parse-better-errors:

    This library enhances the error messages produced during JSON parsing, providing line numbers and context for the errors, making it easier for developers to identify and fix issues in their JSON data.

  • jsonparse:

    Jsonparse focuses on performance and speed, but it also includes basic error handling to ensure that malformed JSON does not crash the application.

  • jsonlint:

    Jsonlint provides comprehensive validation and error reporting for JSON data, ensuring that any issues are clearly communicated to the developer, which aids in debugging.

  • json-stream:

    Error handling in json-stream is focused on stream integrity, ensuring that any parsing errors during streaming are handled gracefully, allowing the stream to continue processing subsequent data.

  • best-effort-json-parser:

    This parser attempts to parse JSON data even when it encounters minor errors, returning the closest valid result instead of failing outright. This is useful for applications that need to be resilient to imperfect data.

Performance

  • json5:

    Json5 has a performance profile similar to standard JSON parsing, but the additional flexibility may introduce minor overhead in certain cases, particularly with complex structures.

  • json-parse-better-errors:

    While it provides better error messages, this library may have a slight performance overhead compared to native JSON parsing due to additional error handling logic.

  • jsonparse:

    Jsonparse is built for speed and efficiency, making it one of the fastest options available for parsing JSON data, especially in performance-sensitive applications.

  • jsonlint:

    Jsonlint is primarily focused on validation and formatting rather than raw performance, so it may be slower than other parsers when processing large JSON files.

  • json-stream:

    Json-stream is optimized for performance in scenarios involving large data sets, allowing for efficient memory usage and faster processing by parsing data incrementally.

  • best-effort-json-parser:

    This parser is designed to be lightweight and fast, making it suitable for applications where performance is critical, especially when dealing with large JSON objects.

Flexibility

  • json5:

    Json5 adds flexibility to JSON by allowing comments and additional syntax, making it easier to write and maintain configuration files.

  • json-parse-better-errors:

    It provides flexibility in debugging by offering detailed error messages, which can be customized to suit the developer's needs.

  • jsonparse:

    Jsonparse is designed to be flexible in terms of handling nested JSON structures, allowing for easy parsing of complex data.

  • jsonlint:

    Jsonlint is flexible in that it can be used as both a command-line tool and a library, allowing developers to integrate it into various workflows.

  • json-stream:

    Json-stream allows for flexible handling of large data sets by enabling streaming parsing, which is ideal for real-time applications that require processing data as it arrives.

  • best-effort-json-parser:

    This parser offers flexibility in handling malformed JSON, making it suitable for applications that need to process data from unreliable sources.

Use Cases

  • json5:

    Best used for configuration files or scenarios where human readability is important, allowing developers to write more understandable JSON-like structures.

  • json-parse-better-errors:

    Ideal for development environments where debugging JSON data is critical, providing developers with the necessary tools to quickly identify and fix issues.

  • jsonparse:

    Great for performance-critical applications that require fast parsing of complex JSON data, such as web applications with heavy data interactions.

  • jsonlint:

    Useful for any project that requires strict validation of JSON data, ensuring that data is well-formed before it is processed or sent to APIs.

  • json-stream:

    Perfect for applications that need to process large JSON files or streams of data in real-time, such as data ingestion pipelines or live data feeds.

  • best-effort-json-parser:

    Best suited for applications that consume data from APIs that may not always return perfectly formatted JSON, such as third-party services or legacy systems.

Learning Curve

  • json5:

    Json5 is easy to learn for those already familiar with JSON, as it builds on the existing syntax while adding a few additional features.

  • json-parse-better-errors:

    It requires a basic understanding of JSON parsing but provides significant benefits in terms of debugging, which can justify the learning effort.

  • jsonparse:

    This library is designed for speed and efficiency, and while it is easy to use, understanding its performance optimizations may require some additional learning.

  • jsonlint:

    The learning curve is minimal, as it primarily serves as a validation tool, but understanding its output can enhance a developer's ability to work with JSON effectively.

  • json-stream:

    Developers may need to familiarize themselves with streaming concepts, but the library itself is designed to be intuitive and easy to use once understood.

  • best-effort-json-parser:

    This library is straightforward to use, with a minimal learning curve, making it accessible for developers of all skill levels.

How to Choose: json5 vs json-parse-better-errors vs jsonparse vs jsonlint vs json-stream vs best-effort-json-parser
  • json5:

    Use json5 if you require a more flexible JSON format that allows comments and trailing commas. This is ideal for configuration files where readability and maintainability are important.

  • json-parse-better-errors:

    Select this library if you prioritize detailed error messages for debugging JSON parsing issues. It enhances the standard JSON parsing error messages to make them more informative and user-friendly.

  • jsonparse:

    Select jsonparse if you need a fast and efficient parser for JSON data that can handle nested structures. It is optimized for performance and is suitable for applications that require high-speed parsing.

  • jsonlint:

    Choose jsonlint for validating and formatting JSON data. It is particularly useful for ensuring that your JSON is well-formed and adheres to the JSON standard before processing it in your application.

  • json-stream:

    Opt for json-stream when working with large JSON data sets that need to be processed incrementally. This library allows you to parse JSON data in a streaming fashion, which is memory efficient and suitable for real-time applications.

  • best-effort-json-parser:

    Choose this package if you need a lightweight parser that can handle malformed JSON gracefully, providing a best-effort approach to parsing without throwing errors for minor issues.

README for json5

JSON5 – JSON for Humans

Build Status Coverage
Status

JSON5 is an extension to the popular JSON file format that aims to be easier to write and maintain by hand (e.g. for config files). It is not intended to be used for machine-to-machine communication. (Keep using JSON or other file formats for that. 🙂)

JSON5 was started in 2012, and as of 2022, now gets >65M downloads/week, ranks in the top 0.1% of the most depended-upon packages on npm, and has been adopted by major projects like Chromium, Next.js, Babel, Retool, WebStorm, and more. It's also natively supported on Apple platforms like MacOS and iOS.

Formally, the JSON5 Data Interchange Format is a superset of JSON (so valid JSON files will always be valid JSON5 files) that expands its syntax to include some productions from ECMAScript 5.1 (ES5). It's also a strict subset of ES5, so valid JSON5 files will always be valid ES5.

This JavaScript library is a reference implementation for JSON5 parsing and serialization, and is directly used in many of the popular projects mentioned above (where e.g. extreme performance isn't necessary), but others have created many other libraries across many other platforms.

Summary of Features

The following ECMAScript 5.1 features, which are not supported in JSON, have been extended to JSON5.

Objects

  • Object keys may be an ECMAScript 5.1 IdentifierName.
  • Objects may have a single trailing comma.

Arrays

  • Arrays may have a single trailing comma.

Strings

  • Strings may be single quoted.
  • Strings may span multiple lines by escaping new line characters.
  • Strings may include character escapes.

Numbers

  • Numbers may be hexadecimal.
  • Numbers may have a leading or trailing decimal point.
  • Numbers may be IEEE 754 positive infinity, negative infinity, and NaN.
  • Numbers may begin with an explicit plus sign.

Comments

  • Single and multi-line comments are allowed.

White Space

  • Additional white space characters are allowed.

Example

Kitchen-sink example:

{
  // comments
  unquoted: 'and you can quote me on that',
  singleQuotes: 'I can use "double quotes" here',
  lineBreaks: "Look, Mom! \
No \\n's!",
  hexadecimal: 0xdecaf,
  leadingDecimalPoint: .8675309, andTrailing: 8675309.,
  positiveSign: +1,
  trailingComma: 'in objects', andIn: ['arrays',],
  "backwardsCompatible": "with JSON",
}

A more real-world example is this config file from the Chromium/Blink project.

Specification

For a detailed explanation of the JSON5 format, please read the official specification.

Installation and Usage

Node.js

npm install json5

CommonJS

const JSON5 = require('json5')

Modules

import JSON5 from 'json5'

Browsers

UMD

<!-- This will create a global `JSON5` variable. -->
<script src="https://unpkg.com/json5@2/dist/index.min.js"></script>

Modules

<script type="module">
  import JSON5 from 'https://unpkg.com/json5@2/dist/index.min.mjs'
</script>

API

The JSON5 API is compatible with the JSON API.

JSON5.parse()

Parses a JSON5 string, constructing the JavaScript value or object described by the string. An optional reviver function can be provided to perform a transformation on the resulting object before it is returned.

Syntax

JSON5.parse(text[, reviver])

Parameters

  • text: The string to parse as JSON5.
  • reviver: If a function, this prescribes how the value originally produced by parsing is transformed, before being returned.

Return value

The object corresponding to the given JSON5 text.

JSON5.stringify()

Converts a JavaScript value to a JSON5 string, optionally replacing values if a replacer function is specified, or optionally including only the specified properties if a replacer array is specified.

Syntax

JSON5.stringify(value[, replacer[, space]])
JSON5.stringify(value[, options])

Parameters

  • value: The value to convert to a JSON5 string.
  • replacer: A function that alters the behavior of the stringification process, or an array of String and Number objects that serve as a whitelist for selecting/filtering the properties of the value object to be included in the JSON5 string. If this value is null or not provided, all properties of the object are included in the resulting JSON5 string.
  • space: A String or Number object that's used to insert white space into the output JSON5 string for readability purposes. If this is a Number, it indicates the number of space characters to use as white space; this number is capped at 10 (if it is greater, the value is just 10). Values less than 1 indicate that no space should be used. If this is a String, the string (or the first 10 characters of the string, if it's longer than that) is used as white space. If this parameter is not provided (or is null), no white space is used. If white space is used, trailing commas will be used in objects and arrays.
  • options: An object with the following properties:
    • replacer: Same as the replacer parameter.
    • space: Same as the space parameter.
    • quote: A String representing the quote character to use when serializing strings.

Return value

A JSON5 string representing the value.

Node.js require() JSON5 files

When using Node.js, you can require() JSON5 files by adding the following statement.

require('json5/lib/register')

Then you can load a JSON5 file with a Node.js require() statement. For example:

const config = require('./config.json5')

CLI

Since JSON is more widely used than JSON5, this package includes a CLI for converting JSON5 to JSON and for validating the syntax of JSON5 documents.

Installation

npm install --global json5

Usage

json5 [options] <file>

If <file> is not provided, then STDIN is used.

Options:

  • -s, --space: The number of spaces to indent or t for tabs
  • -o, --out-file [file]: Output to the specified file, otherwise STDOUT
  • -v, --validate: Validate JSON5 but do not output JSON
  • -V, --version: Output the version number
  • -h, --help: Output usage information

Contributing

Development

git clone https://github.com/json5/json5
cd json5
npm install

When contributing code, please write relevant tests and run npm test and npm run lint before submitting pull requests. Please use an editor that supports EditorConfig.

Issues

To report bugs or request features regarding the JSON5 data format, please submit an issue to the official specification repository.

Note that we will never add any features that make JSON5 incompatible with ES5; that compatibility is a fundamental premise of JSON5.

To report bugs or request features regarding this JavaScript implementation of JSON5, please submit an issue to this repository.

Security Vulnerabilities and Disclosures

To report a security vulnerability, please follow the follow the guidelines described in our security policy.

License

MIT. See LICENSE.md for details.

Credits

Aseem Kishore founded this project. He wrote a blog post about the journey and lessons learned 10 years in.

Michael Bolin independently arrived at and published some of these same ideas with awesome explanations and detail. Recommended reading: Suggested Improvements to JSON

Douglas Crockford of course designed and built JSON, but his state machine diagrams on the JSON website, as cheesy as it may sound, gave us motivation and confidence that building a new parser to implement these ideas was within reach! The original implementation of JSON5 was also modeled directly off of Doug’s open-source json_parse.js parser. We’re grateful for that clean and well-documented code.

Max Nanasy has been an early and prolific supporter, contributing multiple patches and ideas.

Andrew Eisenberg contributed the original stringify method.

Jordan Tucker has aligned JSON5 more closely with ES5, wrote the official JSON5 specification, completely rewrote the codebase from the ground up, and is actively maintaining this project.