aeson-yaml: Output any Aeson value as YAML (pure Haskell library)

[ bsd3, json, library, text, web, yaml ] [ Propose Tags ]

This library exposes functions for encoding any Aeson value as YAML. There is also support for encoding multiple values into YAML "documents".

This library is pure Haskell, and does not depend on C FFI with libyaml. It is also licensed under the BSD3 license.


[Skip to Readme]
Versions [faq] 1.0.0.0, 1.0.1.0, 1.0.2.0, 1.0.3.0, 1.0.4.0, 1.0.5.0
Change log CHANGELOG.md
Dependencies aeson (>=0.4.0.0 && <1.5), aeson-yaml, base (>=4.8.2.0 && <5), bytestring (>=0.10.4.0 && <0.11), text (>=0.1 && <1.3), unordered-containers (>=0.1.0.0 && <0.3), vector (>=0.1 && <0.13) [details]
License BSD-3-Clause
Copyright 2019 Clovyr LLC
Author Patrick Nielsen
Maintainer patrick@clovyr.io
Revised Revision 2 made by patrick at Mon Sep 30 04:17:12 UTC 2019
Category Text, Web, JSON, YAML
Home page https://github.com/clovyr/aeson-yaml
Bug tracker https://github.com/clovyr/aeson-yaml/issues
Source repo head: git clone https://github.com/clovyr/aeson-yaml
Uploaded by patrick at Mon Sep 30 03:50:30 UTC 2019
Distributions NixOS:1.0.4.0
Executables json-to-yaml
Downloads 418 total (176 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Hackage Matrix CI
Docs available [build log]
Last success reported on 2019-09-30 [all 1 reports]

Modules

[Index] [Quick Jump]

Flags

NameDescriptionDefaultType
build-binaries

Build the binaries

DisabledManual

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

Downloads

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

For package maintainers and hackage trustees


Readme for aeson-yaml-1.0.0.0

[back to package description]

aeson-yaml

BSD3-licensed library to encode any Aeson value as YAML, without a dependency on an external YAML library like yaml (libyaml C FFI) or HsYaml (GPL).

Usage

import qualified Data.Aeson.Yaml as Aeson.Yaml

Aeson.Yaml.encode :: ToJSON a => a -> LazyByteString

-- To encode multiple values, separated by '---' (YAML documents),
-- use `encodeDocuments`.
Aeson.Yaml.encodeDocuments :: ToJSON a => [a] -> LazyByteString

-- To encode values of different types, use `toJSON` from `Data.Aeson`
-- like so:
encodeDocuments [toJSON x, toJSON y, toJSON z]

See bin/JsonToYaml.hs for a simple command-line application using this library.

Documentation

Hackage

License

BSD3