Parsimmon

Authors: [@jneen][] and [@laughinghan][]

Maintainer: [@wavebeem][]

Parsimmon is a small library for writing big parsers made up of lots of little parsers. The API is inspired by [parsec][] and [Promises/A+][promises-aplus].

Parsimmon supports IE7 and newer browsers, along with [Node.js][]. It can be used as a standard Node module through [npm][] (named parsimmon), or directly in the browser through a script tag, where it exports a global variable called Parsimmon. To download the latest browser build, use the [unpkg version][]. For more information on how to use unpkg, see the [unpkg homepage][].

Code of Conduct

Everyone is expected to abide by the Contributor Covenant. Please send reports to brian@wavebeem.com.

API Documentation

- Full API documentation in API.md
- Guide with additional questions
- Tutorial by Max Tagher

Examples

See the [examples][] directory for annotated examples of parsing JSON, Lisp, a Python-ish language, and math.

Common Functions

- .createLanguage(parsers)
- .string(string)
- .regexp(regexp)
- .seq(p1, p2, ...pn)
- .sepBy(content, separator)
- .alt(p1, p2, ...pn)
- .whitespace
- .index
- parser.map(fn)
- parser.node(name)
- parser.skip(otherParser)

Questions

Feel free to ask a question by filing a GitHub Issue. I'm happy to help point you in the right direction with the library, and hopefully improve the documentation so less people get confused in the future.

Contributing

Contributions are _not_ just pull requests.

Issues clearly describing bugs or confusing parts of Parsimmon are welcome! Also, documentation enhancements and examples are very desirable.

Feeling overwhelmed about contributing? Open an issue about what you want to contribute and I'm happy to help you through to completion!

Performance

Thanks to [@bd82][] we have a good [benchmark comparing Parsimmon CPU performance to several other parser libraries][perf] with a simple JSON parser example.

Fantasyland

Parsimmon is also compatible with [fantasyland][]. It implements Semigroup, Apply, Applicative, Functor, Chain, and Monad.

[@bd82]: https://github.com/bd82
[@laughinghan]: https://github.com/laughinghan
[@jneen]: https://github.com/jneen
[@wavebeem]: https://github.com/wavebeem
[examples]: https://github.com/jneen/parsimmon/tree/master/examples
[unpkg homepage]: https://unpkg.com/#/
[unpkg version]: https://unpkg.com/parsimmon
[npm]: https://www.npmjs.com/
[node.js]: https://nodejs.org/en/
[promises-aplus]: https://promisesaplus.com/
[parsec]: https://hackage.haskell.org/package/parsec
[fantasyland]: https://github.com/fantasyland/fantasy-land
[perf]: https://chevrotain.io/performance/
[es5]: https://kangax.github.io/compat-table/es5/
[es5-shim]: https://github.com/es-shims/es5-shim