Lucene Query Parser for JavaScript
This is an implementation of the Lucene Query Parser developed using PEG.js.
Example
A quick example of how to use it:
var parser = ; // return the expression treevar results = parser; console; // titleconsole; // The Right Wayconsole; // ANDconsole; // textconsole; // go
A slightly more complicated example:
var parser = ; // return the expression treevar results = parser; console; // testconsole; // AND // the grouped expression in parentheses becomes it's own nested nodevar rightNode = results'right'; console; // fooconsole; // ORconsole; // bar
Installation
On the Command-Line
The library is available as an npm module.
To install, run:
npm install lucene-queryparser
Unit Tests
Unit tests are built with Jasmine.
On the Command-line
To run the unit tests on the command line, using node:
npm test
Grammar
The parser is auto-generated from a PEG implementation in Javascript called PEG.js.
To test the grammar without using the generated parser, or if you want to modify it, try out PEG.js online. This is a handy way to test an abritrary query and see what the results will be like or debug a problem with the parser for a given piece of data.