serokell / aeson-options

Various options to configure field and constructor names in JSON

aeson-options

DEPRECATED

This library is deprecated because its maintainers considered it useless. The aeson-casing package solves similar problems, consider using it instead.

Library providing sensible options for deriving JSON instances for records automatically (using deriveJSON). Functions for defining Generic instances are also included.

Most useful with record fields defined accordingly to Serokell style guide

Build instructions

This project uses Stack. Run stack build to build it.

Usage

See API documentation on Hackage

For Contributors

Please see CONTRIBUTING.md for more information.

About Serokell

aeson-options is maintained by Serokell.

We love open source software. See which services we provide and drop us a line if you are interested.

aeson-options's Issues

Remove 'universum' from dependencies

This is a small library. We want it be as lightweight as possible. universum is not needed here.

Add Haddock code examples for data type and resulting JSON and doctest

Current aeson-options is very poor...

• http://hackage.haskell.org/package/aeson-options-0.0.0/docs/Data-Aeson-Options.html

What would be great if to have for each option documentation in a form like this:

1. Declare some data type in ghci-like documentation.
2. Derive instance with proper options for this data type.
3. Encode this data type in aeson.

And then we can test such documentation with doctest! I think this is awesome.

Review comments

GitHub UX sucks. I can't sumbit review to existing code. So I put all my comments and things that should be improved under this issue:

• Rename module to Data.Aeson.Options to make it more consistent with ecosystem.
• Add JSON category to .cabal.

Add 'fixedPrefixOptions'

Current defaultOptions don't work with data types described in this issue:

• haskell/aeson#624

Let's have some options where you can specify prefix. Or even get type automatically like it's suggested in that issue! I think that the result of this issue should be two extra options.