toml-parser's Introduction

toml-parser

This package provides a complete and light-weight parser for the TOML configuration language. TOML is specified by https://github.com/toml-lang/toml. This language is designed to be easy to understand and unambiguous.

This implementation uses Alex and Happy to generate an efficient lexer and parser. The code is fully commented and should be useful as an example of how to use these tools to parse other languages.

Example

# This is a TOML document.

title = "Example document"

[section]
string    = "hello, world"
integers  = [0, +1, -2, 3_333_333]
float     = 4.2e10
inlinemap = { x = 1, y = 'two' }

[nesting]

  [nesting.first]
  longstring = """multiline "string" syntax"""
  longquote  = '''escapes \not \interpreted'''

  [nesting.second]
  datetime    = 2017-05-04T12:13:14Z
  lookinggood = true

Contact Information

Please contact me via GitHub or on the #haskell IRC channel on irc.freenode.net

toml-parser's People

Contributors

Stargazers

Watchers

toml-parser's Issues

Add renderer or pretty-printer

It's easy to parse .toml files with this package! But there's no function to render Value data type into Text which might be useful.

Specify which version of Toml the parser conforms to

And ideally make an entry at the toml github wiki.

Given how much toml has evolved between 0.1 and 0.5 (most recent as of today), I think it would be valuable information for the user which version files toml-parser will consume.

bump bounds to allow build with GHC 9.2.1, 9.0.1

I think toml-parser builds with latest GHCs! So a package revision would fix this all :)

Add 'aeson-like' interfaces for parsing

Currently, if I want to store and parse my data type inside TOML file, I need to manually pattern-match on the result of parseTOML function which can be awkward sometimes. Check this for example:

https://github.com/ChShersh/life-sync/blob/665299c3992b5532ff494218a9bca4cfed62e659/src/Life/Configuration.hs#L135

What would be good is to have aeson-like interfaces, let's say ToTOML and FromTOML which allows to convert to TOML and from TOML representations. I'm not saying that toml-parser should completely mimic aeson design choices, maybe something better can be invented. But I think it's a useful addition to library.

What do you think?

Recommend Projects