ProductPromotion
Logo

Elixir

made by https://0x3d.site

GitHub - zamith/tomlex: A TOML parser for elixir
A TOML parser for elixir. Contribute to zamith/tomlex development by creating an account on GitHub.
Visit Site

GitHub - zamith/tomlex: A TOML parser for elixir

GitHub - zamith/tomlex: A TOML parser for elixir

Tomlex Build Status Inline docs

A TOML parser for elixir.

Getting Started

You can read all about the TOML markup language in the official github repo.

Requirements

  • Elixir v1.0.0+

Usage

Add tomlex as a dependency in your mix.exs file.

defp deps do
  [{:tomlex, ">= 0.0.0"}]
end

Alternatively you can get the edge version.

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.

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.

Documentation

You can find more documentation here.

Roadmap

  • Comments
  • Integers
  • Strings
  • Floats
  • Boolean
  • Tables
  • Nested Tables
  • Arrays
  • 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.

Articles
to learn more about the elixir concepts.

Resources
which are currently available to browse on.

mail [email protected] to add your project or resources here 🔥.

FAQ's
to know more about the topic.

mail [email protected] to add your project or resources here 🔥.

Queries
or most google FAQ's about Elixir.

mail [email protected] to add more queries here 🔍.

More Sites
to check out once you're finished browsing here.

0x3d
https://www.0x3d.site/
0x3d is designed for aggregating information.
NodeJS
https://nodejs.0x3d.site/
NodeJS Online Directory
Cross Platform
https://cross-platform.0x3d.site/
Cross Platform Online Directory
Open Source
https://open-source.0x3d.site/
Open Source Online Directory
Analytics
https://analytics.0x3d.site/
Analytics Online Directory
JavaScript
https://javascript.0x3d.site/
JavaScript Online Directory
GoLang
https://golang.0x3d.site/
GoLang Online Directory
Python
https://python.0x3d.site/
Python Online Directory
Swift
https://swift.0x3d.site/
Swift Online Directory
Rust
https://rust.0x3d.site/
Rust Online Directory
Scala
https://scala.0x3d.site/
Scala Online Directory
Ruby
https://ruby.0x3d.site/
Ruby Online Directory
Clojure
https://clojure.0x3d.site/
Clojure Online Directory
Elixir
https://elixir.0x3d.site/
Elixir Online Directory
Elm
https://elm.0x3d.site/
Elm Online Directory
Lua
https://lua.0x3d.site/
Lua Online Directory
C Programming
https://c-programming.0x3d.site/
C Programming Online Directory
C++ Programming
https://cpp-programming.0x3d.site/
C++ Programming Online Directory
R Programming
https://r-programming.0x3d.site/
R Programming Online Directory
Perl
https://perl.0x3d.site/
Perl Online Directory
Java
https://java.0x3d.site/
Java Online Directory
Kotlin
https://kotlin.0x3d.site/
Kotlin Online Directory
PHP
https://php.0x3d.site/
PHP Online Directory
React JS
https://react.0x3d.site/
React JS Online Directory
Angular
https://angular.0x3d.site/
Angular JS Online Directory