yaml_elixir alternatives and similar packages
Based on the "YAML" category.
Alternatively, view yaml_elixir alternatives based on common mentions on social networks and blogs.
yamerl8.0 1.9 yaml_elixir VS yamerlYAML 1.2 and JSON parser in pure Erlang
fast_yaml6.2 4.4 yaml_elixir VS fast_yamlFast YAML native library for Erlang / Elixir
ymlr2.3 7.3 yaml_elixir VS ymlrA YAML encoder for Elixir.
yomel1.3 0.0 yaml_elixir VS yomel読める、読めるぞぉ!!
Scout APM: A developer's best friend. Try free for 14-days
Do you think we are missing an alternative of yaml_elixir or a related project?
README
YAML Parser for Elixir
This is a wrapper for yamerl - a native Erlang
YAML parser which brings all of the functionalities to Elixir language.
Installation
Add
:yaml_elixir as a dependency in your
mix.exs file.
defp deps do [ # ... {:yaml_elixir, "~> x.x"}, ] end
Where
x.x.x equals the version in [
mix.exs](mix.exs) (you can omit the last
x). Always make sure to use the latest version.
Once you've done that, run
mix deps.get in your command line to fetch the dependency.
Usage
With
YamlElixir you have an access to two functionalities: one for parsing a string and an another one for parsing a file.
Run
iex -S mix in your terminal to try how their works.
Parsing a string
iex(1)> yaml = """ ...(1)> a: a ...(1)> b: 1 ...(1)> c: true ...(1)> d: ~ ...(1)> e: nil ...(1)> """ " a: a\n b: 1\n c: true\n d: ~\n e: nil\n" iex(2)> YamlElixir.read_from_string(yaml) {:ok, %{"a" => "a", "b" => 1, "c" => true, "d" => nil, "e" => "nil"}}
Parsing a file
iex(1)> path = Path.join(File.cwd!(), "test/fixtures/flat.yml") "/Users/squixy/Desktop/yaml-elixir/test/fixtures/flat.yml" iex(2)> YamlElixir.read_from_file(path) {:ok, %{"a" => "a", "b" => 1, "c" => true, "d" => nil, "e" => []}}
Support for atoms
By default, all map keys are processed as strings, as are all bareword or quoted values.
If you prefer to autodetect keys and values that begin with
: as atoms, this can be accomplished by passing
atoms: true as an option to any of the
read_* functions.
iex(1)> yaml = """ ...(1)> a: a ...(1)> b: 1 ...(1)> c: true ...(1)> d: ~ ...(1)> e: nil, ...(1)> :f: :atom ...(1)> """ " a: a\n b: 1\n c: true\n d: ~\n e: nil\n" iex(2)> YamlElixir.read_from_string(yaml, atoms: true) {:ok, %{:f => :atom, "a" => "a", "b" => 1, "c" => true, "d" => nil, "e" => "nil"}}
Atoms are not garbage collected by
BEAM, so be careful with this option, and
don't use it with user-supplied input.
If you enable autodetection of atoms, any string values entered (e.g.
":not_really_an_atom") will be converted to atoms, as well. If you only need to support a few atom values, it might be better to enable
yamerl's custom tag for atoms:
:yamerl_app.set_param(:node_mods, [:yamerl_node_erlang_atom])
and then using the somewhat inconvenient syntax for it:
atom_key: !<tag:yamerl,2012:atom> atom_value
Support for keyword lists
Keyword lists can be returned in two ways. Either all maps can be transformed into keyword
lists via the option
maps_as_keywords: true or individually with a tag. To mark a block
as a keyword list you must first pass in the node module which can process the tokens:
:yamerl_app.set_param(:node_mods, [YamlElixir.Node.KeywordList])
and then tag the desired block:
prod: foo: !<tag:yaml_elixir,2019:keyword_list> foo: bar bar: foo
This will return:
%{"prod" => %{"foo" => [{"bar", "foo"}, {"foo", "bar"}]}}
Note that due to a quirk in how
yamerl parses YAML documents, using the flow style with
this tag will not work. Do not expect your document to be processed if you write your
YAML like this:
prod: foo: !<tag:yaml_elixir,2019:keyword_list> {foo: bar, bar: foo}
Elixir Sigil
The
YamlElixir.Sigil module provides the
~y sigil that can be useful for example for keeping short configurations or other inlined YAML.
import YamlElixir.Sigil @config ~y""" debug: false port: 9200 files: - some/file.csv - another/file.csv """
Use the
a sigil modifier to turn on atom values from YAML:
~y":answer: yes"a
You can find more examples in
test directory.
Merging anchors
In case your YAML contains anchors, you can have these resolved by passing
merge_anchors: true:
yaml = """ yaml: foo: &foo bar: 42 baz: << *foo """ YamlElixir.read_from_string(yaml, merge_anchors: true)
will result in
%{ "yaml" => %{ "foo" => %{ "bar" => 42 }, "baz" => %{ "bar" => 42 } } }
Mix tasks
Sometimes, you may want to use
yaml_elixir in your
mix tasks. To do that, you must ensure that the application has started.
Application.ensure_all_started(:yaml_elixir)
After that, you will be able to use
:yaml-elixir in your
mix tasks.
Contribution
In case of any problems or suggestions do not hesitate and create a pull request.
Credits
- bobbypriambodo
- Hajto
- sambooo
- ernie
- sibsibsib
- vic
- rothsberg
- msimonborg
- mononym
- EugeneOsadchyi
- TylerPachal
- kianmeng
- floriank
This library is MIT licensed. See the LICENSE for details.
*Note that all licence references and agreements mentioned in the yaml_elixir README section above are relevant to that project's source code only.