Chevrotain

TLDR

• Online Playground
• Getting Started Tutorial
• YouTube Video: Introduction to Lexers, Parsers and Interpreters with Chevrotain
• Performance benchmark

Introduction

Chevrotain is a blazing fast and feature rich Parser Building Toolkit for JavaScript with built-in support for LL(K). Grammars and 3rd party plugin for LL(*) grammars. It can be used to build parsers/compilers/interpreters for various use cases ranging from simple configuration files, to full-fledged programming languages.

Grammars are written as pure JavaScript sources without a code generation phase,

A more in depth review of Chevrotain can be found in this great article on: Parsing in JavaScript: Tools and Libraries.

Installation

• npm: npm install chevrotain
• Browser ESM bundled versions: These can be downloaded directly via UNPKG or other NPM cdn services, e.g.:
  • Latest:
    • https://unpkg.com/chevrotain/lib/chevrotain.mjs
    • https://unpkg.com/chevrotain/lib/chevrotain.min.mjs
  • Explicit version number:
    • https://unpkg.com/chevrotain@13.2.0/lib/chevrotain.mjs
    • https://unpkg.com/chevrotain@13.2.0/lib/chevrotain.min.mjs

Documentation & Resources

• Sample Grammars.

• FAQ.

• Other Examples.

• HTML API docs.

• ALL(*) Lookahead in Langium

Compatibility

Chevrotain supports modern JavaScript runtimes: the Node.js versions declared in the published package's package.json engines field, and current evergreen browsers.

Chevrotain may rely on modern standard library APIs. Check the relevant tsconfig*.json files and package engines fields for exact runtime requirements.

Legacy runtimes are not supported. If you need to support older browsers, transpilation and polyfills may be required.

Contributions

Contributions are greatly appreciated. See CONTRIBUTING.md for details.

Where used

A small-curated list:

1. HyperFormula

   • HyperFormula is an open source, spreadsheet-like calculation engine
   • source

2. Langium

   • Langium is a language engineering tool with built-in support for the Language Server Protocol.

3. Prettier-Java

   • A Prettier Plugin for Java
   • source

4. JHipster Domain Language

   • The JDL is a JHipster-specific domain language where you can describe all your applications, deployments, entities and their relationships in a single file (or more than one) with a user-friendly syntax.
   • source

5. Argdown

   • Argdown is a simple syntax for analyzing complex argumentation.
   • source