colinodell/json5

UTF-8 compatible JSON5 parser for PHP

JSON5 for PHP - JSON for Humans

![Software License][ico-license] [][link-build-status] ![Coverage Status][ico-scrutinizer] ![SensioLabs Insight][ico-sensio] ![Total Downloads][ico-downloads], _(*1)

This library is a PHP fork of the JSON5 reference implementation., _(*2)

JSON5 is a JS-compatible extension to JSON which allows comments, trailing commas, single-quoted strings, and more:, _(*3)

{
    foo: 'bar',
    while: true,

    this: 'is a \
multi-line string',

    // this is an inline comment
    here: 'is another', // inline comment

    /* this is a block comment
       that continues on another line */

    hex: 0xDEADbeef,
    half: .5,
    delta: +10,
    to: Infinity,   // and beyond!

    finally: [
        'some trailing commas',
    ],
}

See the JSON5 website for additional examples and details., _(*4)

Install

Via Composer, _(*5)

``` bash composer require colinodell/json5, <sub>(*6)</sub>

## Usage

This package adds a `json5_decode()` function which is a drop-in replacement for PHP's built-in `json_decode()`:

``` php
$json = file_get_contents('foo.json5');
$data = json5_decode($json);

It takes the same exact parameters in the same order. For more details on these, see the PHP docs., <sub>(*7)</sub>

To achieve the best possible performance, it'll try parsing with PHP's native function (which usually fails fast) and then falls back to JSON5., <sub>(*8)</sub>

Exceptions

This function will always throw a SyntaxError exception if parsing fails. This is a subclass of the new \JsonException introduced in PHP 7.3. Providing or omitting the JSON_THROW_ON_ERROR option will have no effect on this behavior., <sub>(*9)</sub>

Binary / Executable

A binary/executable named json5 is also provided for converting JSON5 to plain JSON via your terminal., <sub>(*10)</sub>

Usage: json5 [OPTIONS] [FILE]

  -h, --help  Shows help and usage information

  (Reading data from STDIN is not currently supported on Windows)

Examples:

Converting a file named file.json5:, <sub>(*11)</sub>

json5 file.json5

Converting a file and saving its output:, <sub>(*12)</sub>

json5 file.json5 > file.json

Converting from STDIN:, <sub>(*13)</sub>

echo -e "{hello: 'world!'}" | json5

Converting from STDIN and saving the output:, <sub>(*14)</sub>

echo -e "{hello: 'world!'}" | json5 > output.json

Change log

Please see CHANGELOG for more information on what has changed recently., <sub>(*15)</sub>

Testing

bash composer test, <sub>(*16)</sub>

Contributing

Please see CONTRIBUTING and CODE_OF_CONDUCT for details., <sub>(*17)</sub>

Security

If you discover any security related issues, please email colinodell@gmail.com instead of using the issue tracker., <sub>(*18)</sub>

Support

In addition to standard support, consider a Tidelift Subscription for professional support and get alerted when new releases or security issues come out., <sub>(*19)</sub>

Credits

• Colin O'Dell
• Aseem Kishore, the JSON5 project, and their contributors
• All other contributors to this project

License

The MIT License (MIT). Please see License File for more information., <sub>(*20)</sub>