docrecords: Vinyl-based records with hierarchical field names, default values and documentation

[ cli, data, json, library, mit, options, parsing, records ] [ Propose Tags ]

Implements the DocRec type, which is a record (in the vinyl sense) where each field has an optional value and a docstring. The names of the fields are type-level lists of Symbols, acting as paths. This makes docrecords hierarchical. Addionally, we provide the code to read docrecords from JSON files and derive CLI parsers to override the records read from files. docrecords is part of the porcupine ecosystem. See the README at


Note: This package has metadata revisions in the cabal description newer than included in the tarball. To unpack the package including the revisions, use 'cabal get'.

Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees


Versions [RSS]
Dependencies aeson (<1.6), base (>=4.10 && <5), data-default, lens, optparse-applicative, text, unordered-containers, vinyl (>=0.11), yaml [details]
License MIT
Copyright 2018 EURL Tweag, NovaDiscovery
Maintainer Yves Parès <>
Revised Revision 1 made by sjakobi at 2022-04-05T17:19:05Z
Category Data, Records, JSON, CLI, Options, Parsing
Home page
Bug tracker
Source repo head: git clone
Uploaded by YvesPares at 2019-10-09T10:16:04Z
Reverse Dependencies 1 direct, 2 indirect [details]
Downloads 519 total (4 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs available [build log]
Last success reported on 2019-10-09 [all 1 reports]