You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
bd82 e95b1fc5c2 docs: startLine of CstNodeLocation should be optional 2 weeks ago
.github/workflows ci: remove node 17 from build matrix 3 months ago
.husky chore: update husky to 7 4 months ago
examples refactor(chevrotain): set noImplicitAny: true and fix errors (#1688) 3 months ago
packages docs: startLine of CstNodeLocation should be optional 2 weeks ago
.eslintrc.js refactor(utils): replace with lodash (#1694) 3 months ago
.gitattributes .gitAttributes 2 years ago
.gitignore chore: fix property name in benchmark options 2 months ago
.prettierignore chore: fix property name in benchmark options 2 months ago
CONTRIBUTING.md docs(contributing.md): correct yarn run ci_full_build as it doesn't exist (#1637) 4 months ago
LICENSE.txt license file 7 years ago
NOTICE.txt chore: update copyright notice (#1669) 3 months ago
README.md docs: remove deps section in main readme 3 months ago
lerna.json chore(release): release 3 months ago
package.json chore(deps): update all non-major dev dependencies (#1704) 3 months ago
renovate.json5 ci: add label to renovate prs 3 months ago
tsconfig.base.json refactor(utils): replace with lodash (#1694) 3 months ago
tsconfig.json refactor(utils): replace with lodash (#1694) 3 months ago
yarn.lock chore(deps): update all non-major dev dependencies (#1704) 3 months ago

README.md

Discussions npm npm Continuous Integration styled with prettier Commitizen friendly

Chevrotain

Introduction

Chevrotain is a blazing fast and feature rich Parser Building Toolkit for JavaScript. It can be used to build parsers/compilers/interpreters for various use cases ranging from simple configuration files, to full-fledged programing languages.

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

It is important to note that Chevrotain is NOT a parser generator. It solves the same kind of problems as a parser generator, just without any code generation. Chevrotain Grammars are pure code which can be created/debugged/edited as any other pure code without requiring any new tools or processes.

TLDR

Installation

  • npm: npm install chevrotain
  • Browser: The npm package contains Chevrotain as concatenated and minified files ready for use in a browser. These can also be accessed directly via UNPKG in a script tag.
    • Latest:
      • https://unpkg.com/chevrotain/lib/chevrotain.js
      • https://unpkg.com/chevrotain/lib/chevrotain.min.js
      • https://unpkg.com/chevrotain/lib_esm/chevrotain.mjs
      • https://unpkg.com/chevrotain/lib_esm/chevrotain.min.mjs
    • Explicit version number:
      • https://unpkg.com/chevrotain@9.1.0/lib/chevrotain.js
      • https://unpkg.com/chevrotain@9.1.0/lib/chevrotain.min.js
      • https://unpkg.com/chevrotain@9.1.0/lib_esm/chevrotain.mjs
      • https://unpkg.com/chevrotain@9.1.0/lib_esm/chevrotain.min.mjs

Documentation & Resources

Compatibility

Chevrotain will run on any modern JavaScript ES2015 runtime. That includes nodejs maintenance/active/current version, modern major browsers, but not legacy ES5.1 runtimes such as IE11.

  • Uses UMD to work with common module loaders (browser global / amd / commonjs).

Contributions

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

Where used

Some interesting samples: