Hackage :: [Package]

yaml: Support for parsing and rendering YAML documents.

[ bsd3, data, library ] [ Propose Tags ]

README and API documentation are available at https://www.stackage.org/package/yaml

[Skip to Readme]
Versions [faq] 0.0.0, 0.0.1, 0.0.2, 0.0.3, 0.0.4, 0.2.0, 0.2.1, 0.3.0, 0.4.0, 0.4.1, 0.4.1.1, 0.4.1.2, 0.5.0, 0.5.0.1, 0.5.1, 0.5.1.1, 0.5.1.2, 0.5.2, 0.6.0, 0.6.1, 0.7.0, 0.7.0.1, 0.7.0.2, 0.7.0.3, 0.7.0.4, 0.8.0, 0.8.0.1, 0.8.0.2, 0.8.1, 0.8.1.1, 0.8.1.2, 0.8.2, 0.8.2.1, 0.8.2.2, 0.8.2.3, 0.8.2.4, 0.8.3, 0.8.4, 0.8.4.1, 0.8.5, 0.8.5.1, 0.8.5.2, 0.8.5.3, 0.8.5.4, 0.8.6, 0.8.6.1, 0.8.6.2, 0.8.7, 0.8.7.1, 0.8.7.2, 0.8.8, 0.8.8.1, 0.8.8.2, 0.8.8.3, 0.8.8.4, 0.8.9, 0.8.9.1, 0.8.9.2, 0.8.9.3, 0.8.9.4, 0.8.10, 0.8.10.1, 0.8.11, 0.8.12, 0.8.13, 0.8.14, 0.8.15.1, 0.8.15.2, 0.8.15.3, 0.8.16, 0.8.17, 0.8.17.1, 0.8.17.2, 0.8.18, 0.8.18.1, 0.8.18.2, 0.8.18.3, 0.8.18.4, 0.8.18.5, 0.8.18.6, 0.8.18.7, 0.8.19.0, 0.8.20, 0.8.21, 0.8.21.1, 0.8.21.2, 0.8.22, 0.8.22.1, 0.8.23, 0.8.23.1, 0.8.23.3, 0.8.24, 0.8.25, 0.8.25.1, 0.8.26, 0.8.27, 0.8.28, 0.8.29, 0.8.30, 0.8.31, 0.8.31.1, 0.8.32, 0.9.0, 0.10.0, 0.10.1, 0.10.1.1, 0.10.2.0, 0.10.3.0, 0.10.4.0, 0.11.0.0
Change log ChangeLog.md
Dependencies aeson (>=0.11), attoparsec (>=0.11.3.0), base (==4.*), bytestring (>=0.9.1.4), conduit (>=1.2.8 && <1.4), containers, directory, filepath, raw-strings-qq, resourcet (>=0.3 && <1.3), scientific, semigroups, template-haskell, text, transformers (>=0.1), unordered-containers, vector, yaml [details]
License BSD-3-Clause
Author Michael Snoyman <michael@snoyman.com>, Anton Ageev <antage@gmail.com>,Kirill Simonov
Maintainer Michael Snoyman <michael@snoyman.com>
Category Web
Home page http://github.com/snoyberg/yaml/
Source repo head: git clone https://github.com/snoyberg/yaml
Uploaded by MichaelSnoyman at Mon May 7 15:00:10 UTC 2018
Distributions Arch:0.11.0.0, Debian:0.8.32, Fedora:0.8.32, FreeBSD:0.8.13, LTSHaskell:0.11.0.0, NixOS:0.11.0.0, Stackage:0.11.0.0, openSUSE:0.11.0.0
Executables examples, json2yaml, yaml2json
Downloads 191331 total (2059 in the last 30 days)
Rating 2.0 (votes: 3) [estimated by rule of succession]
Your Rating
  • λ
  • λ
  • λ
Status Hackage Matrix CI
Docs available [build log]
Last success reported on 2018-05-07 [all 1 reports]

Modules

[Index]

Flags

NameDescriptionDefaultType
no-exe

don't install the yaml2json or json2yaml executables

EnabledAutomatic
no-examples

don't build the examples

EnabledAutomatic
system-libyaml

Use the system-wide libyaml instead of the bundled copy

DisabledAutomatic
no-unicode

Don't enable unicode output. Instead, unicode characters will be escaped.

DisabledAutomatic

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

Downloads

Maintainer's Corner

For package maintainers and hackage trustees

Readme for yaml-0.8.30

[back to package description]

yaml

Provides support for parsing and emitting Yaml documents.

This package includes the full libyaml C library version 0.1.7 by Kirill Simonov in the package so you don't need to worry about any non-Haskell dependencies.

The package is broken down into two primary modules. Data.Yaml provides a high-level interface based around the JSON datatypes provided by the aeson package. Text.Libyaml provides a lower-level, streaming interface. For most users, Data.Yaml is recommended.

Examples

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

Additional 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.