aeson-diff: Extract and apply patches to JSON documents.

This is a package candidate release! Here you can preview how this package release will appear once published to the main package index (which can be accomplished via the 'maintain' link below). Please note that once a package has been published to the main package index it cannot be undone! Please consult the package uploading documentation for more information.

[maintain] [Publish]

This is a small library for working with changes to JSON documents. It includes a library and two command-line executables in the style of the diff(1) and patch(1) commands available on many systems.

[Skip to Readme]

Properties

Versions	0.1.1.1, 0.1.1.2, 0.1.1.3, 1.0.0.0, 1.0.0.1, 1.0.0.1, 1.1.0.0, 1.1.0.2, 1.1.0.3, 1.1.0.4, 1.1.0.5, 1.1.0.7, 1.1.0.8, 1.1.0.9, 1.1.0.10, 1.1.0.11, 1.1.0.12, 1.1.0.13
Change log	CHANGELOG.md
Dependencies	aeson, aeson-diff, base (>=4.5 && <4.10), bytestring (>=0.10), edit-distance-vector, hashable, mtl, optparse-applicative (>=0.11 && <0.13), scientific, text, unordered-containers, vector [details]
License	BSD-3-Clause
Copyright	(c) 2015 Thomas Sutton and others.
Author	Thomas Sutton
Maintainer	me@thomas-sutton.id.au
Category	JSON, Web, Algorithms
Home page	https://github.com/thsutton/aeson-diff
Source repo	head: git clone https://github.com/thsutton/aeson-diff
Uploaded	by ThomasSutton at 2016-07-18T06:30:03Z

Modules

[Index]

Data
- Aeson

Downloads

aeson-diff-1.0.0.1.tar.gz [browse] (Cabal source package)
Package description (as included in the package)

Maintainer's Corner

Package maintainers

ThomasSutton, clintonmead, clinton, janus, velveteer

For package maintainers and hackage trustees

edit package information

Readme for aeson-diff-1.0.0.1

[back to package description]

Aeson Diff

This is a small library for working with changes to JSON documents. It includes a library and two executables in the style of diff(1) and patch(1). Patches are themselves JSON Patch documents as specified in RFC 6902.

Installing

The aeson-diff package is written in Haskell and can be installed using the Cabal package management tool, stack, or something similar.

stack install aeson-diff

The command-line tools can then be executed using stack:

stack exec json-diff -- ....
stack exec json-patch -- ....

If you prefer to use Cabal, something like this might do the trick:

cd aeson-diff/
cabal sandbox init
cabal install --dependencies-only
cabal build
sudo mkdir -p /usr/local/bin
sudo cp dist/build/json-*/json-{diff,patch} /usr/local/bin/

Usage

Patch format

aeson-diff supports the JSON Patch format described in RFC 6902.

json-diff command

The json-diff command compares two JSON documents and extracts a patch describing the differences between the first document and the second.

Usage: json-diff [-o|--output OUTPUT] FROM TO
Generate a patch between two JSON documents.

Available options:
    -h,--help                Show this help text

json-patch command

The json-patch command applies a patch describing changes to be made to a JSON document.

Usage: json-patch [-o|--output OUTPUT] PATCH FROM
Generate a patch between two JSON documents.

Available options:
  -h,--help                Show this help text
  -o,--output OUTPUT       Destination for patched JSON.
  PATCH                    Patch to apply.
  FROM                     JSON file to patch.

aeson-diff library

The aeson-diff library exports as single module: Data.Aeson.Diff. This exports diff and patch functions which do exactly what might be expected:

diff :: Value -> Value -> Patch examines source and target JSON Values and constructs a new Patch describing the changes.
patch :: Patch -> Value -> Value applies the changes in a Patch to a JSON Value. If an error results then an exception is thrown.

For more complete information, see the documentation.