colinodell / json5
UTF-8 compatible JSON5 parser for PHP
Fund package maintenance!
colinodell
Patreon
www.colinodell.com/sponsor
www.paypal.me/colinpodell/10.00
Installs: 12 138 600
Dependents: 37
Suggesters: 0
Security: 0
Stars: 276
Watchers: 9
Forks: 11
Open Issues: 2
Requires
- php: ^8.0
- ext-json: *
- ext-mbstring: *
Requires (Dev)
- mikehaertl/php-shellcommand: ^1.7.0
- phpstan/phpstan: ^1.10.57
- scrutinizer/ocular: ^1.9
- squizlabs/php_codesniffer: ^3.8.1
- symfony/finder: ^6.0|^7.0
- symfony/phpunit-bridge: ^7.0.3
README
This library is a PHP fork of the JSON5 reference implementation.
JSON5 is a JS-compatible extension to JSON which allows comments, trailing commas, single-quoted strings, and more:
{ 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.
Install
Via Composer
composer require colinodell/json5
Usage
This package adds a json5_decode()
function which is a drop-in replacement for PHP's built-in json_decode()
:
$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.
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.
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.
Binary / Executable
A binary/executable named json5
is also provided for converting JSON5 to plain JSON via your terminal.
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:
json5 file.json5
Converting a file and saving its output:
json5 file.json5 > file.json
Converting from STDIN:
echo -e "{hello: 'world!'}" | json5
Converting from STDIN and saving the output:
echo -e "{hello: 'world!'}" | json5 > output.json
Change log
Please see CHANGELOG for more information on what has changed recently.
Testing
composer test
Contributing
Please see CONTRIBUTING and CODE_OF_CONDUCT for details.
Security
If you discover any security related issues, please email colinodell@gmail.com instead of using the issue tracker.
Support
In addition to standard support, consider a Tidelift Subscription for professional support and get alerted when new releases or security issues come out.
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.