https://github.com/izziiyt/jsdp
simple command line tool to sort json in deep (including arrays)
https://github.com/izziiyt/jsdp
json normalize sort
Last synced: 6 months ago
JSON representation
simple command line tool to sort json in deep (including arrays)
- Host: GitHub
- URL: https://github.com/izziiyt/jsdp
- Owner: izziiyt
- License: mit
- Created: 2024-08-31T05:17:51.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-31T07:45:02.000Z (over 1 year ago)
- Last Synced: 2025-01-21T22:11:37.916Z (12 months ago)
- Topics: json, normalize, sort
- Language: Go
- Homepage:
- Size: 12.7 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[![CI][ci-img]][ci]
[![Go Report Card][go-report-img]][go-report]
[![License: MIT][license-img]][license]
# Why jsdp (Json Sort in Deep)?
`jsdp` is a simple tool for recursively sorting objects and arrays in JSON files.
It is useful in situations where you want to compare JSON files that have the same content but different order.
While `jq -S` and `dictknife` can sort objects, they cannot sort arrays.
In such cases, `jsdp` is superior as it can also sort the contents of arrays.
# Install
go
```bash
go install github.com/izziiyt/jsdp
```
mise
```bash
mise use --global go:github.com/izziiyt/jsdp
```
# Example
(`jq` is required)
```bash
$ cat 0.json
{
"b": 2,
"a": [
false,
{
"a": 1
},
1,
null,
2.1,
"value",
[3, 2, 1]
]
}
$ cat 1.json
{
"a": [
2.1,
1,
{
"a": 1
},
null,
[2, 3, 1],
"value"
],
"b": 2
}
$ diff <(jsdp 0.json | jq) <(cat 1.json | jsdp | jq)
3d2
< false,
```
# Sorting Order
Everything is sorted in ascending order.
The data types in the JSON are described according to [RFC-8259](https://datatracker.ietf.org/doc/html/rfc8259#section-3).
## object
Objects are sorted by the string order of their keys.
before
```json
{
"c": false,
"a": 1,
"b": null
}
```
after
```json
{
"a": 1,
"b": null,
"c": false
}
```
## array
Arrays are sorted first by the following order of data types:
- false
- true
- number
- string
- array
- object
- null
Subarrays divided by type are then sorted according to their respective types.
before
```json
{
"a": [
{ "a": 1},
false,
"b",
1,
null,
"a",
[1, false],
true,
0.5
]
}
```
after
```json
{
"a": [
false,
true,
0.5,
1,
"a",
"b",
[false, 1],
{ "a": 1},
null
]
}
```
[ci]: https://github.com/izziiyt/jsdp/actions/workflows/ci.yaml
[ci-img]: https://github.com/izziiyt/jsdp/actions/workflows/ci.yml/badge.svg
[go-report]: https://goreportcard.com/report/github.com/izziiyt/jsdp
[go-report-img]: https://goreportcard.com/badge/github.com/izziiyt/jsdp
[license]: https://opensource.org/licenses/MIT
[license-img]: https://img.shields.io/badge/License-MIT-yellow.svg