https://github.com/vodori/rsql-parser
A javascript library for parsing rsql expressions into predicates.
https://github.com/vodori/rsql-parser
Last synced: 27 days ago
JSON representation
A javascript library for parsing rsql expressions into predicates.
- Host: GitHub
- URL: https://github.com/vodori/rsql-parser
- Owner: vodori
- License: mit
- Created: 2018-02-02T15:12:53.000Z (over 7 years ago)
- Default Branch: develop
- Last Pushed: 2023-05-22T11:56:57.000Z (almost 2 years ago)
- Last Synced: 2023-08-12T18:22:11.711Z (over 1 year ago)
- Language: JavaScript
- Size: 621 KB
- Stars: 3
- Watchers: 7
- Forks: 3
- Open Issues: 9
-
Metadata Files:
- Readme: readme.md
- Changelog: changelog.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://travis-ci.org/vodori/rsql-parser)
[](https://opensource.org/licenses/mit-license.php)
### rsql-parser
A javascript parser and visitor for the predicate expression language RSQL. Useful for turning
simple string expressions into a function that resolves to either true or false when provided
a chunk of data.
### Usage
```javascript 1.6
const parser = new Parser.PredicateParser();
const predicate = parser.parse("firstName==Paul;age==25");
const matches = predicate({firstName: "Paul", age: 23});
assertFalse(matches);
```
### How it works
We've written an RSQL grammar for Antlr4. We compile this grammar into a lexer, parser, and base visitor. We then
extend the base visitor with hand-written code that builds the parsed AST into a function of one argument that returns
a boolean indicating if the data matches the expression. The grammar still needs battle testing and may be missing
support for certain edge cases. Please see the tests for examples of what is / isn't supported and expected behavior.
### Motivation
RSQL is used internally as a predicate expression language within Vodori's Pepper Cloud product suite. We're creating
a browser compatible version so that we can extend dynamic configurable behavior to the browser but without asking the
people writing configuration to learn a new expression language.
### License
This project is licensed under [MIT license](http://opensource.org/licenses/MIT).