megaparsec/README.md
2015-07-31 17:44:27 +06:00

2.2 KiB
Raw Blame History

MegaParsec

License BSD3 Build Status

This is industrial-strength monadic parser combinator library. MegaParsec is a fork of original Parsec library written by Daan Leijen. This library is different from Parsec in the following ways:

  • Original Parsec consists of quite ancient code-base and has certain stylistic problems that's anyone who tries to compile Parsec with -Wall option can notice. This has been refreshed in MegaParsec. The changes are mainly cosmetic but not limited to them.

  • Some quirks and old «buggy features» (as well as plain bugs) are fixed.

  • Original Parsec uses rather weak collection of tests: a test per bug, obviously to prevent regression. Our aim is to write complete test-suite with QuickCheck to cover 100% of MegaParsec code. You can understand need for this test-suite if you look at CHANGELOG.md file that includes Parsec-era changes. The word «regression» mentioned quite frequently.

  • MegaParsec looks into future, it does not contain code that serves for compatibility purposes, it also requires more recent version of base.

  • Finally, we have fixed numerous typos and other minor flaws.

The reason for creating separate version of the project was inactivity of its current maintainer who reduced active contributions to something like one commit in three months and indefinitely delayed merging of our contributions without any explanation. We wanted to improve Parsec and we had some ideas how this can be achieved, so we decided to create our own version of Parsec.

Contributing

Issues (bugs, feature requests or otherwise feedback) may be reported in the Github issue tracker for this project.

Pull-requests are also welcome (and yes they will get attention and will be merged quickly if they are good).

License

Copyright © 2015 MegaParsec contributors
Copyright © 2007 Paolo Martini
Copyright © 19992000 Daan Leijen

Distributed under BSD3 license.