README.md

parsing.combinators

Packrat parser combinator implementation.

Example

( ... )

Installing

The easiest way is to grab it from NPM. If you're running in a Browser environment, you can use Browserify

$ npm install parsing.combinators

Using with CommonJS

If you're not using NPM, Download the latest release, and require the parsing.combinators.umd.js file:

var combinators = require('parsing.combinators')

Using with AMD

Download the latest release, and require the parsing.combinators.umd.js file:

require(['parsing.combinators'], function(combinators) {
  ( ... )
})

Using without modules

Download the latest release, and load the parsing.combinators.umd.js file. The properties are exposed in the global folktale.parsing.combinators object:

<script src="/path/to/parsing.combinators.umd.js"></script>

Compiling from source

If you want to compile this library from the source, you'll need Git, Make, Node.js, and run the following commands:

$ git clone git://github.com/folktale/parsing.combinators.git
$ cd parsing.combinators
$ npm install
$ make bundle

This will generate the dist/parsing.combinators.umd.js file, which you can load in any JavaScript environment.

Documentation

You can read the documentation online or build it yourself:

$ git clone git://github.com/folktale/parsing.combinators.git
$ cd parsing.combinators
$ npm install
$ make documentation

Then open the file docs/literate/index.html in your browser.

Platform support

This library assumes an ES5 environment, but can be easily supported in ES3 platforms by the use of shims. Just include es5-shim :)

Licence

Copyright (c) 2013 Quildreen Motta.

Released under the MIT licence.