0.0.6 • Public • Published


This is a fork of Zach Carter zach@carter.name's jison module tweaked to use just enough templates to make typescript compilers tollerate the generated parser.


This works (I'm using it in a few javascript and typescritp projects) but the original tests are all dynamic and i'm not sure how to manage that with the modularized parser and lexer generators dynamically generating code that imports the common modules. Thoughts? -- ericP (ericprud on gitter)

Original Jison README (modulo compilation examples):

build status

A lightly-typescriptified API for creating parsers in JavaScript

Jison generates bottom-up parsers in JavaScript. Its API is similar to Bison's, hence the name. It supports many of Bison's major features, plus some of its own. If you are new to parser generators such as Bison, and Context-free Grammars in general, a good introduction is found in the Bison manual. If you already know Bison, Jison should be easy to pickup.

Briefly, Jison takes a JSON encoded grammar or Bison style grammar and outputs a JavaScript file capable of parsing the language described by that grammar. You can then use the generated script to parse inputs and accept, reject, or perform actions based on the input.


Jison can be installed for Node using npm

Using npm:

npm install ts-jison -g

Usage from the command line

Clone the github repository for examples:

git clone git://github.com/ericprud/ts-jison.git
cd ts-jison/examples

Now you're ready to generate some parsers:

npx jison calculator.jison

This will generate calculator.js in your current working directory. This file can be used to parse an input file, like so:

echo "2^32 / 1024" > testcalc
node calculator.js testcalc

This will print out 4194304.

Full cli option list:

Usage: jison [file] [lexfile] [options]

file        file containing a grammar
lexfile     file containing a lexical grammar

   -j, --json                    force jison to expect a grammar in JSON format
   -o FILE, --outfile FILE       Filename and base module name of the generated parser
   -d, --debug                   Debug mode
   -m TYPE, --module-type TYPE   The type of module to generate (commonjs, amd, js)
   -p TYPE, --parser-type TYPE   The type of algorithm to use for the parser (lr0, slr, lalr, lr)
   -t, --template                Template directory to use for code generation, defaults to javascript
   -V, --version                 print version and exit

Command line ts-node

npx ts-node -e 'const p = require("./grammar").parser; console.log(p.parse("( ( (\n ) ) )\n"));

Usage from a CommonJS module

You can generate parsers programatically from JavaScript as well. Assuming Jison is in your commonjs environment's load path:

// mygenerator.js
var Parser = require("jison").Parser;

// a grammar in JSON
var grammar = {
    "lex": {
        "rules": [
           ["\\s+", "/* skip whitespace */"],
           ["[a-f0-9]+", "return 'HEX';"]

    "bnf": {
        "hex_strings" :[ "hex_strings HEX",
                         "HEX" ]

// `grammar` can also be a string that uses jison's grammar format
var parser = new Parser(grammar);

// generate source, ready to be written to disk
var parserSource = parser.generate();

// you can also use the parser directly from memory

// returns true
parser.parse("adfe34bc e82a");

// throws lexical error
parser.parse("adfe34bc zxg");

More Documentation

For more information on creating grammars and using the generated parsers, read the documentation.

How to contribute

See CONTRIBUTING.md for contribution guidelines, how to run the tests, etc.

Projects using Jison

View them on the wiki, or add your own.



Special thanks to Jarred Ligatti, Manuel E. Bermúdez

Please see the license in this directory.

Package Sidebar


npm i ts-jison



Weekly Downloads






Unpacked Size

1.89 MB

Total Files


Last publish


  • ericprud