jamen / guru

(Archived) A pluggable and intuitive parser.

Guru

A fancy, general-purpose, modular, and reusable parser.

Guru is a general purpose parsing library for Node.js, that can take advantage of the modular ecosystem, and rely on a lot of native components to be lightweight.

It uses a Reader class to maintain the ability to take abstract input, and the Parser class relies on this. With that in play, the Parser can be reused multiple times to parse many different things... For instance, you can use the same Parser class to lex an input, as well as to analyze tokens outputted from your previous parser.

Installation

$ npm install --save jamen/guru

Usage

import { Parser } from 'guru';
import fs from 'fs-promise';
import { tokenize, transform, resolve } from 'my-lang';

fs.readFile('my-file.txt')
.then(buffer => new Parser(tokenize).parse(buffer))
.then(tokens => new Parser(transform).parse(tokens))
.then(tokens => new Parser(resolve).parse(tokens))
.then(buffer => {
  // ...
});

Credits

Jamen Marzonie

guru's Issues

AST support in Reader

The new Writer class (#1) will allow for AST output (nested arrays), Reader should be able to handle trees as well.

Because Reader is more of a blueprint for strictly linear structures, it might be extended into a separate ASTReader class.

Better Promise integration for rules.

Rules should be able to work asynchronously in the Parser.

Custom output methods.

Guru, being a general-purpose parser, should have the ability to have a custom method of outputting. Much like how you can load a custom Reader.

Right now Guru only allows linear output into an array, which is on the Parser class.