https://github.com/tusharsadhwani/formatjson
Format JSON files
https://github.com/tusharsadhwani/formatjson
formatter json
Last synced: 4 months ago
JSON representation
Format JSON files
- Host: GitHub
- URL: https://github.com/tusharsadhwani/formatjson
- Owner: tusharsadhwani
- License: mit
- Created: 2024-04-06T11:34:37.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-04-29T22:59:52.000Z (about 2 years ago)
- Last Synced: 2024-12-30T00:34:39.309Z (over 1 year ago)
- Topics: formatter, json
- Language: Rust
- Homepage: https://docs.rs/formatjson
- Size: 62.5 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# formatjson
A simple JSON validator and formatter written in Rust.
For documentation check [the docs.rs page](https://docs.rs/formatjson).
## Installation
```bash
cargo install formatjson
```
## Usage
- As a command-line tool:
```console
$ formatjson example.json
Successfully formatted example.json
$ echo '{"foo": "bar"}' | formatjson
{
"foo": "bar"
}
```
- As a library:
```rust
fn main() {
let json = formatjson::format_json(r#"{"foo":"bar"}"#).unwrap();
println!("{}", json);
}
```
```console
$ cargo run
{
"foo": "bar"
}
```
## Speed
Running it on [this 25MB JSON file][1] gave the following results:
```console
$ hyperfine 'formatjson large.json'
Benchmark 1: formatjson large.json
Time (mean ± σ): 400.1 ms ± 9.3 ms [User: 359.4 ms, System: 31.9 ms]
Range (min … max): 390.1 ms … 419.6 ms 10 runs
```
Averaging 400 milliseconds on my M1 MacBook Air, which is about 38 times faster
than prettier, which took 15.27 seconds:
```console
$ time npx prettier --check large.json
Checking formatting...
[warn] large.json
[warn] Code style issues found in the above file. Run Prettier to fix.
npx prettier --check large.json 26.14s user 11.57s system 246% cpu 15.279 total
```
[1]: https://raw.githubusercontent.com/json-iterator/test-data/master/large-file.json