yaml-streamly: Support for parsing and rendering YAML documents.

[ bsd3, data, library ] [ Propose Tags ]

Rewrite of yaml in streamly


[Skip to Readme]

Flags

Automatic Flags
NameDescriptionDefault
no-examples

don't build the examples

Enabled
no-exe

don't install the yaml2json or json2yaml executables

Enabled

Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info

Downloads

Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees

Candidates

  • No Candidates
Versions [RSS] 0.12.0, 0.12.1, 0.12.2
Change log ChangeLog.md
Dependencies aeson (>=0.11), attoparsec (>=0.11.3.0), base (>=4.9.1 && <5), bytestring (>=0.9.1.4), containers, deepseq, directory, filepath, libyaml-streamly (>=0.2.1), mtl, optparse-applicative, raw-strings-qq, safe-exceptions, scientific (>=0.3), streamly (>=0.8.0), template-haskell, text, transformers (>=0.1), unordered-containers, vector, yaml-streamly [details]
License BSD-3-Clause
Author Michael Snoyman <michael@snoyman.com>, Anton Ageev <antage@gmail.com>,Kirill Simonov, Julian Ospald <hasufell@posteo.de>
Maintainer Julian Ospald <hasufell@posteo.de>
Category Data
Home page https://github.com/hasufell/streamly-yaml#readme
Bug tracker https://github.com/hasufell/streamly-yaml
Source repo head: git clone https://github.com/hasufell/streamly-yaml
Uploaded by maerwald at 2023-02-23T15:01:02Z
Distributions NixOS:0.12.2
Reverse Dependencies 1 direct, 0 indirect [details]
Executables yaml2json, json2yaml, examples
Downloads 906 total (56 in the last 30 days)
Rating 2.0 (votes: 1) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs uploaded by user
Build status unknown [no reports yet]

Readme for yaml-streamly-0.12.2

[back to package description]

yaml-streamly

Provides support for parsing and emitting Yaml documents.

Data.Yaml provides a high-level interface based around the JSON datatypes provided by the aeson package. It uses Text.Libyaml from libyaml in its implementation of the low-level yaml encoder/decoder.

Examples

Usage examples can be found in the Data.Yaml documentation or in the examples directory.

Additional yaml modules

  • Data.Yaml.Include supports adding !include directives to your YAML files.
  • Data.Yaml.Builder and Data.Yaml.Parser allow more fine-grained control of parsing an rendering, as opposed to just using the aeson typeclass and datatype system for parsing and rendering.
  • Data.Yaml.Aeson is currently a re-export of Data.Yaml to explicitly choose to use the aeson-compatible API.

Executables

Converters json2yaml and yaml2json can be built by disabling flag no-exe, e.g., one of:

cabal install yaml -f-no-exe
stack install yaml --flag yaml:-no-exe