safe-json: Automatic JSON format versioning
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.
This library aims to make the updating of JSON formats or contents, while keeping backward compatibility, as painless as possible. The way this is achieved is through versioning and defined migration functions to migrate older (or newer) versions to the one used.
The library mainly consists of two classes:
SafeJSON a
: Defines the version ofa
and if (and how) it is migratable.Migrate a
: Defines the data type (MigrateFrom a
) that can be migrated toa
and how to migrate from that type.
Using these two classes, JSON serialized data types will stay parsable, even after format changes.
For a more in-depth explanation and examples, please see the README at https://github.com/Vlix/safe-json#readme
[Skip to Readme]
Properties
Versions | 0.1.0, 1.0.0, 1.0.0, 1.1.0, 1.1.1, 1.1.1.1, 1.1.2.0, 1.1.3.0, 1.1.3.1, 1.1.4.0, 1.2.0.0, 1.2.0.1, 1.2.0.2 |
---|---|
Change log | ChangeLog.md |
Dependencies | aeson (>=1.4.1 && <1.5), base (>=4.9 && <5), bytestring (>=0.10.8.1 && <0.11), containers (>=0.5.7.1 && <0.7), dlist (>=0.8.0.3 && <0.9), hashable (>=1.2.6.1 && <1.4), scientific (>=0.3.5.2 && <0.4), tasty (>=0.11.3 && <1.3), tasty-hunit (>=0.9.2 && <0.11), tasty-quickcheck (>=0.8.4 && <0.11), text (>=1.2.3 && <1.3), time (>=1.6.0.1 && <1.9), unordered-containers (>=0.2.9 && <0.3), uuid-types (>=1.0.3 && <1.1), vector (>=0.12.0.1 && <0.13) [details] |
License | MIT |
Copyright | 2019 Felix Paulusma |
Author | Felix Paulusma |
Maintainer | felix.paulusma@gmail.com |
Category | JSON |
Home page | https://github.com/Vlix/safe-json#readme |
Bug tracker | https://github.com/Vlix/safe-json/issues |
Source repo | head: git clone https://github.com/Vlix/safe-json |
Uploaded | by nideco at 2019-09-09T16:18:56Z |
Modules
[Index]
Downloads
- safe-json-1.0.0.tar.gz [browse] (Cabal source package)
- Package description (as included in the package)
Maintainer's Corner
Package maintainers
For package maintainers and hackage trustees