https://github.com/tanishiking/jpp
JSON Prettier Printer that occupies a minimal number of lines while pretty-printing given JSON.
https://github.com/tanishiking/jpp
go golang json json-pretty layout
Last synced: about 1 year ago
JSON representation
JSON Prettier Printer that occupies a minimal number of lines while pretty-printing given JSON.
- Host: GitHub
- URL: https://github.com/tanishiking/jpp
- Owner: tanishiking
- License: mit
- Created: 2018-10-27T13:51:15.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2021-07-05T20:43:45.000Z (almost 5 years ago)
- Last Synced: 2025-03-18T05:50:06.613Z (about 1 year ago)
- Topics: go, golang, json, json-pretty, layout
- Language: Go
- Homepage: https://godoc.org/github.com/tanishiking/jpp
- Size: 38.1 KB
- Stars: 56
- Watchers: 2
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# jpp
[](https://travis-ci.org/tanishiking/jpp) [](https://app.codacy.com/app/tanishiking/jpp?utm_source=github.com&utm_medium=referral&utm_content=tanishiking/jpp&utm_campaign=Badge_Grade_Dashboard)
JSON Prettier Printer that occupies a minimal number of lines while pretty-printing given JSON, using [prettier](https://github.com/tanishiking/prettier) which is Go implementation of ["Wadler's "A Prettier Printer"](http://homepages.inf.ed.ac.uk/wadler/papers/prettier/prettier.pdf).
`jpp` is quite useful when we want to pretty print the JSON whose each node has a lot of children scalar values.
This `example.json` cites from https://json.org/example.html
## Instalation
### Homebrew
```
$ brew install tanishiking/jpp/jpp
```
### Download binary from GitHub Releases
https://github.com/tanishiking/jpp/releases
### Build from source
```
$ go get -u github.com/tanishiking/jpp/cmd/jpp
```
### Develop
```sh
$ make build # build binary into ./bin/jpp
$ make test # run all unit tests
```
## jpp command
### Options
- `-w`: width (default: your terminal width)
- Note that this command does not guarantee there are no lines longer than `width`
- It just attempts to keep lines within this length when possible.
- `-i`: indent string (default: `' '`)
### Environment Variables
We can specify the color of output string using following environment variables
- `JPP_NULL`
- `JPP_BOOL`
- `JPP_NUMBER`
- `JPP_STRING`
- `JPP_FIELDNAME`
and builtin colors:
- `black`
- `red`
- `green`
- `brown`
- `blue`
- `magenta`
- `cyan`
- `gray`
- `bold_black`
- `bold_red`
- `bold_green`
- `bold_brown`
- `bold_blue`
- `bold_magenta`
- `bold_cyan`
- `bold_gray`
For example, `cat some.json | JPP_NUMBER=bold_red jpp`.
In addition, we can specify complicated styles using SGR code.
See: https://en.wikipedia.org/wiki/ANSI_escape_code
```
$ go get -u github.com/tanishiking/jpp/cmd/jpp
$ cat numbers.json
[
[ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 ],
[ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ],
[ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20 ]
]
$ cat numbers.json | jpp -w 20
[
[
1, 2, 3, 4, 5,
6, 7, 8, 9, 10
],
[
1, 2, 3, 4, 5,
6, 7, 8, 9, 10,
11, 12, 13, 14,
15
],
[
1, 2, 3, 4, 5,
6, 7, 8, 9, 10,
11, 12, 13, 14,
15, 16, 17, 18,
19, 20
]
]
```
## Package Usage
```go
import (
"fmt"
"github.com/tanishiking/jpp"
)
func main() {
jsonStr := `
[
[ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 ],
[ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 ],
[ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20 ]
]
`
res, _ := jpp.Pretty(jsonStr, " ", 20, nil)
fmt.Println(res)
// [
// [
// 1, 2, 3, 4, 5,
// 6, 7, 8, 9, 10
// ],
// [
// 1, 2, 3, 4, 5,
// 6, 7, 8, 9, 10,
// 11, 12, 13, 14,
// 15
// ],
// [
// 1, 2, 3, 4, 5,
// 6, 7, 8, 9, 10,
// 11, 12, 13, 14,
// 15, 16, 17, 18,
// 19, 20
// ]
// ]
}
```