localheinz / json-printer
Provides a JSON printer, allowing for flexible indentation.
Installs: 471 785
Dependents: 1
Suggesters: 0
Security: 0
Stars: 86
Watchers: 2
Forks: 2
Open Issues: 1
Requires
- php: ~7.4.0 || ~8.0.0 || ~8.1.0 || ~8.2.0 || ~8.3.0 || ~8.4.0
- ext-json: *
- ext-mbstring: *
Requires (Dev)
- ergebnis/data-provider: ^3.2.0
- ergebnis/license: ^2.4.0
- ergebnis/php-cs-fixer-config: ^6.36.0
- ergebnis/phpunit-slow-test-detector: ^2.15.1
- fakerphp/faker: ^1.23.1
- infection/infection: ~0.26.6
- phpunit/phpunit: ^9.6.19
- psalm/plugin-phpunit: ~0.19.0
- rector/rector: ~1.2.5
- vimeo/psalm: ^5.26.1
README
This project provides a composer
package with a JSON printer, allowing for flexible indentation.
Installation
Run
composer require ergebnis/json-printer
Usage
Let's assume we have a variable $json
which contains some JSON that is not indented:
{"name":"Andreas Möller","emoji":"🤓","urls":["https://localheinz.com","https://github.com/localheinz","https://twitter.com/localheinz"]}
or indented with 4 spaces:
{ "name":"Andreas Möller", "emoji":"🤓", "urls":[ "https://localheinz.com", "https://github.com/localheinz", "https://twitter.com/localheinz" ] }
but we want to indent it with 2 spaces (or tabs).
This is where Ergebnis\Json\Printer\Printer
comes in
<?php declare(strict_types=1); use Ergebnis\Json\Printer; $printer = new Printer\Printer(); $printed = $printer->print( $json, ' ', );
which results in $printed
:
{ "name":"Andreas Möller", "emoji":"🤓", "urls":[ "https://localheinz.com", "https://github.com/localheinz", "https://twitter.com/localheinz" ] }
💡 Note that this printer is only concerned with normalizing the indentation, no escaping or un-escaping occurs.
Changelog
The maintainers of this project record notable changes to this project in a changelog.
Contributing
The maintainers of this project suggest following the contribution guide.
Code of Conduct
The maintainers of this project ask contributors to follow the code of conduct.
General Support Policy
The maintainers of this project provide limited support.
You can support the maintenance of this project by sponsoring @localheinz or requesting an invoice for services related to this project.
PHP Version Support Policy
This project supports PHP versions with active and security support.
The maintainers of this project add support for a PHP version following its initial release and drop support for a PHP version when it has reached the end of security support.
Security Policy
This project has a security policy.
License
This project uses the MIT license.
Credits
The Printer
is adopted from Composer\Json\JsonFormatter
(originally licensed under MIT by Nils Adermann and Jordi Boggiano), who adopted it from a blog post by Dave Perrett (originally licensed under MIT by Dave Perrett).
The PrinterTest
is inspired by Composer\Test\Json\JsonFormatterTest
(originally licensed under MIT by Nils Adermann and Jordi Boggiano), as well as ZendTest\Json\JsonTest
(originally licensed under New BSD License).
Social
Follow @localheinz and @ergebnis on Twitter.