Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zamith/tomlex
A TOML parser for elixir
https://github.com/zamith/tomlex
Last synced: about 2 months ago
JSON representation
A TOML parser for elixir
- Host: GitHub
- URL: https://github.com/zamith/tomlex
- Owner: zamith
- Created: 2014-10-20T18:42:41.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2018-07-25T09:35:58.000Z (over 6 years ago)
- Last Synced: 2024-10-02T06:43:04.150Z (2 months ago)
- Language: Elixir
- Size: 34.2 KB
- Stars: 32
- Watchers: 4
- Forks: 6
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- freaking_awesome_elixir - Elixir - A TOML parser for Elixir. (Text and Numbers)
- fucking-awesome-elixir - tomlex - A TOML parser for Elixir. (Text and Numbers)
- awesome-elixir - tomlex - A TOML parser for Elixir. (Text and Numbers)
README
# Tomlex [](https://travis-ci.org/zamith/tomlex) [](http://inch-ci.org/github/zamith/tomlex)
A TOML parser for elixir.
## Getting Started
You can read all about the TOML markup language in the [official github repo](https://github.com/toml-lang/toml).
### Requirements
* Elixir v1.0.0+
### Usage
Add tomlex as a dependency in your `mix.exs` file.
``` elixir
defp deps do
[{:tomlex, ">= 0.0.0"}]
end
```
Alternatively you can get the edge version.
``` elixir
defp deps do
[{:tomlex, git: "https://github.com/zamith/tomlex.git"}]
end
```
After you're done, run `mix deps.get` in your shell to fetch the dependencies.
Tomlex gets a string and parses it into an elixir `Map` using the `load`
function.
``` elixir
defmodule YourApp do
def your_function do
parsed_file = File.read!("path/to/file.toml") |> Tomlex.load
end
end
```
*Notice:* Do not use different data types in the same array. Tomlex allows it
for now, but will disallow it in the future, as per the [TOML specs](https://github.com/toml-lang/toml#array).
### Documentation
You can find more documentation [here](http://hexdocs.pm/tomlex/).
# Roadmap
- [X] Comments
- [X] Integers
- [X] Strings
- [X] Floats
- [X] Boolean
- [X] Tables
- [X] Nested Tables
- [X] Arrays
- [X] Nested Arrays
- [ ] Array of Tables
- [ ] Datetime
- [ ] Error handling
- [ ] Literal strings
- [ ] Multi-line basic strings
- [ ] Multi-line literal strings
- [ ] Disallow different data types in arrays
- [ ] Better string escaping support
- [ ] UTF-8 `\uXXXX` and `\UXXXXXXXX` forms
# Contributing
To contribute you need to fork tomlex, compile it from source, test it, push the
changes and open a pull request. Here's the commands to do it.
```
# Fork the repo on github
git clone [email protected]:your-name/tomlex.git
cd tomlex
mix test
# Do your awesome changes, make sure the tests still run and commit them locally
git push
# Go to github and open a pull request
```
# License
The MIT License (MIT)
Copyright (c) 2016 Luis Zamith Ferreira
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.