Product
Introducing License Enforcement in Socket
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
lucene-queryparser
Advanced tools
This is an implementation of the Lucene Query Parser developed using PEG.js.
A quick example of how to use it:
var parser = require('lucene-queryparser');
// return the expression tree
var results = parser.parse('title:"The Right Way" AND text:go');
console.log(results['left']['field']); // title
console.log(results['left']['term']); // The Right Way
console.log(results['operator']); // AND
console.log(results['right']['field']); // text
console.log(results['right']['term']); // go
A slightly more complicated example:
var parser = require('lucene-queryparser');
// return the expression tree
var results = parser.parse('test AND (foo OR bar)');
console.log(results['left']['term']); // test
console.log(results['operator']); // AND
// the grouped expression in parentheses becomes it's own nested node
var rightNode = results['right'];
console.log(rightNode['left']['term']); // foo
console.log(rightNode['operator']); // OR
console.log(rightNode['right']['term']); // bar
The library is available as an npm module.
To install, run:
npm install lucene-queryparser
Unit tests are built with Jasmine.
To run the unit tests on the command line, using node:
npm test
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.
FAQs
Lucene Query Parser for Javascript created using PEG.js
The npm package lucene-queryparser receives a total of 160 weekly downloads. As such, lucene-queryparser popularity was classified as not popular.
We found that lucene-queryparser demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Product
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.
Product
We're excited to introduce Socket Optimize, a powerful CLI command to secure open source dependencies with tested, optimized package overrides.