mirror of
https://github.com/mrkkrp/megaparsec.git
synced 2024-12-01 10:54:14 +03:00
62 lines
2.5 KiB
Markdown
62 lines
2.5 KiB
Markdown
# Megaparsec
|
||
|
||
*Note that this is work in progress.*
|
||
|
||
[](http://opensource.org/licenses/BSD-3-Clause)
|
||
[](https://travis-ci.org/mrkkrp/megaparsec)
|
||
[](https://coveralls.io/github/mrkkrp/megaparsec?branch=master)
|
||
|
||
This is industrial-strength monadic parser combinator library. Megaparsec is
|
||
a fork of Parsec library originally written by Daan Leijen.
|
||
|
||
Megaparsec is different from Parsec in the following ways:
|
||
|
||
* Better error messages. We test our error messages using dense QuickCheck
|
||
tests. Good error messages are just as important for us as correct return
|
||
values of our parsers. Megaparsec will be especially useful if you write
|
||
compiler or interpreter for some language.
|
||
|
||
* Some quirks and “buggy features” (as well as plain bugs) of original
|
||
Parsec are fixed. There is no undocumented surprising stuff in Megaparsec.
|
||
|
||
* Better support for Unicode parsing in `Text.Megaparsec.Char`.
|
||
|
||
* Megaparsec has more powerful combinators and can parse languages where
|
||
indentation matters.
|
||
|
||
* Comprehensive QuickCheck test suite covering nearly 100% of our code.
|
||
|
||
* We have benchmarks to detect performance regressions.
|
||
|
||
* Better documentation, with 100% of functions covered, without typos and
|
||
obsolete information, with working examples. Megaparsec's documentation is
|
||
well-structured and doesn't contain things useless to end user.
|
||
|
||
* Megaparsec's code is clearer and doesn't contain “magic” found in original
|
||
Parsec.
|
||
|
||
* Megaparsec looks into the future, it does not contain code that serves for
|
||
compatibility purposes, it also requires more recent version of `base`.
|
||
|
||
## Contributing
|
||
|
||
Issues (bugs, feature requests or otherwise feedback) may be reported in
|
||
[the Github issue tracker for this project](https://github.com/mrkkrp/megaparsec/issues).
|
||
|
||
Pull-requests are also welcome (and yes, they will get attention and will be
|
||
merged quickly if they are good, we are progressive folks).
|
||
|
||
## Spread the Word
|
||
|
||
Many people still don't know about Megaparsec, you can help the project by
|
||
writing about it in a blog, creating a tutorial or something like that. This
|
||
is highly appreciated.
|
||
|
||
## License
|
||
|
||
Copyright © 2015 Megaparsec contributors<br>
|
||
Copyright © 2007 Paolo Martini<br>
|
||
Copyright © 1999–2000 Daan Leijen
|
||
|
||
Distributed under BSD3 license.
|