Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ergebnis/json-printer
📃 Provides a composer package with a JSON printer, allowing for flexible indentation.
https://github.com/ergebnis/json-printer
formatter json printer
Last synced: 3 days ago
JSON representation
📃 Provides a composer package with a JSON printer, allowing for flexible indentation.
- Host: GitHub
- URL: https://github.com/ergebnis/json-printer
- Owner: ergebnis
- License: mit
- Created: 2018-01-04T11:05:15.000Z (about 7 years ago)
- Default Branch: main
- Last Pushed: 2024-12-23T08:07:04.000Z (15 days ago)
- Last Synced: 2024-12-28T19:02:34.545Z (10 days ago)
- Topics: formatter, json, printer
- Language: PHP
- Homepage:
- Size: 7.8 MB
- Stars: 88
- Watchers: 3
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE.md
- Codeowners: .github/CODEOWNERS
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# json-printer
[](https://github.com/ergebnis/json-printer/actions)
[](https://github.com/ergebnis/json-printer/actions)
[](https://github.com/ergebnis/json-printer/actions)
[](https://github.com/ergebnis/json-printer/actions)
[](https://codecov.io/gh/ergebnis/json-printer)
[](https://packagist.org/packages/ergebnis/json-printer)
[](https://packagist.org/packages/ergebnis/json-printer)
[](https://packagist.org/packages/ergebnis/json-printer)
This project provides a [`composer`](https://getcomposer.org) package with a JSON printer, allowing for flexible indentation.
## Installation
Run
```sh
composer require ergebnis/json-printer
```
## Usage
Let's assume we have a variable `$json` which contains some JSON that is not indented:
```json
{"name":"Andreas Möller","emoji":"🤓","urls":["https://localheinz.com","https://github.com/localheinz","https://twitter.com/localheinz"]}
```
or indented with 4 spaces:
```json
{
"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
print(
$json,
' ',
);
```
which results in `$printed`:
```json
{
"name":"Andreas Möller",
"emoji":"🤓",
"urls":[
"https://localheinz.com",
"https://github.com/localheinz",
"https://twitter.com/localheinz"
]
}
```
:bulb: 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](CHANGELOG.md).
## Contributing
The maintainers of this project suggest following the [contribution guide](.github/CONTRIBUTING.md).
## Code of Conduct
The maintainers of this project ask contributors to follow the [code of conduct](https://github.com/ergebnis/.github/blob/main/CODE_OF_CONDUCT.md).
## General Support Policy
The maintainers of this project provide limited support.
You can support the maintenance of this project by [sponsoring @localheinz](https://github.com/sponsors/localheinz) or [requesting an invoice for services related to this project](mailto:[email protected]?subject=ergebnis/json-printer:%20Requesting%20invoice%20for%20services).
## PHP Version Support Policy
This project supports PHP versions with [active and security support](https://www.php.net/supported-versions.php).
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](.github/SECURITY.md).
## License
This project uses the [MIT license](LICENSE.md).
## Credits
The [`Printer`](src/Printer.php) is adopted from [`Composer\Json\JsonFormatter`](https://github.com/composer/composer/blob/1.6.0/src/Composer/Json/JsonFormatter.php) (originally licensed under MIT by [Nils Adermann](https://github.com/naderman) and [Jordi Boggiano](https://github.com/seldaek)), who adopted it from a [blog post by Dave Perrett](https://www.daveperrett.com/articles/2008/03/11/format-json-with-php/) (originally licensed under MIT by [Dave Perrett](https://github.com/recurser)).
The [`PrinterTest`](test/Unit/PrinterTest.php) is inspired by [`Composer\Test\Json\JsonFormatterTest`](https://github.com/composer/composer/blob/1.6.0/tests/Composer/Test/Json/JsonFormatterTest.php) (originally licensed under MIT by [Nils Adermann](https://github.com/naderman) and [Jordi Boggiano](https://github.com/seldaek)), as well as [`ZendTest\Json\JsonTest`](https://github.com/zendframework/zend-json/blob/release-3.0.0/test/JsonTest.php) (originally licensed under New BSD License).
## Social
Follow [@localheinz](https://twitter.com/intent/follow?screen_name=localheinz) and [@ergebnis](https://twitter.com/intent/follow?screen_name=ergebnis) on Twitter.