https://github.com/vyskocilm/jf

Json difF: Go library and CLI printing diffs of two json files
https://github.com/vyskocilm/jf

bsd-3-clause cmdline go golang json json-diff

Last synced: about 2 months ago
JSON representation

Json difF: Go library and CLI printing diffs of two json files

• Host: GitHub
• URL: https://github.com/vyskocilm/jf
• Owner: vyskocilm
• License: bsd-3-clause
• Created: 2020-08-19T14:58:00.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-09-17T12:56:57.000Z (over 4 years ago)
• Last Synced: 2024-06-20T13:38:12.859Z (7 months ago)
• Topics: bsd-3-clause, cmdline, go, golang, json, json-diff
• Language: Go
• Homepage:
• Size: 87.9 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![CircleCI](https://circleci.com/gh/vyskocilm/jf.svg?style=svg)](https://circleci.com/gh/vyskocilm/jf) [![license](https://img.shields.io/badge/license-bsd--3--clause-green)](https://raw.githubusercontent.com/vyskocilm/jf/master/LICENSE)

# jf: Json difF

JSON diff library and simple CLI in Go. It can diff two arbitrary complex JSON

files if they starts as an json object.

## Installation and usage

```sh

git clone https://github.com/vyskocilm/jf

cd jf

go test

go build github.com/vyskocilm/jf/cmd/jf

./jf testdata/a.json testdata/b.json

bool       true    false

ints[2]    1       99

number     42      43

string     "hello" "hellp"

strings[1] "world" "worle"

```

**Warning**: depends on `reflect` and `gihub.com/stretchr/objx` and both CAN

panic in some circumstances.  Package `jf` type checks everything before use,

so it uses methods like `value.MustInt()`. However it panics itself if code ends

in an impossible (or not yet implemented one) situation. For example if

diffing code finds a weird type of `interface{}`, like Go channel or a pointer.

Those can't be passed in JSON.

In any case. Panic of `jf` is always a sign of a bug or missing feature, so do

not forget to create [an issue on GitHub](https://github.com/vyskocilm/jf/issues)

if you will find one.

## Features

1. compare primitive values, ints, floats, bools and strings

2. allows a specification of float equality function (can be used for int/float coercion)

3. compare arrays and maps

4. null coerce for A/B or both jsons

5. ignore certain keys

6. basic cmdline tool

7. ignore order of arrays

## TODO

0. API docs

1. flags for cmdline tool (those starting by `x-` are temporary only and will be dropped)

2. custom comparator on objx.Value/objx.Value or string???

## Simple values

```

{

 "number": 42,

 "string": "hello",

 "strings": ["hello", "world"],

 "ints": [4, 2, 1]

}

------------------------------

{

 "number": 43,

 "string": "hellp",

 "strings": ["hello", "worle"],

 "ints": [4, 2, 99]

}

------------------------------

ints[2]    1       99

number     42      43

string     "hello" "hellp"

strings[1] "world" "worle"

```

## Nested maps

```

{

 "key": {

  "subkey": {

   "id": 11,

   "name": "joe"

  }

 }

}

------------------------------

{

 "key": {

  "subkey": {

   "id": 11,

   "name": "Joe"

  }

 }

}

------------------------------

key.subkey.name "joe" "Joe"

```

See [jsondiff_test.go](jsondiff_test.go) for more examples.