https://github.com/mcchatman8009/antlr4-tool
A useful Antlr4 tool with full TypeScript support
https://github.com/mcchatman8009/antlr4-tool
antlr-tool antlr4 antlr4-grammar antlr4-tool antlr4-typescript cli command-line es6 npm parser tool typescript
Last synced: 6 months ago
JSON representation
A useful Antlr4 tool with full TypeScript support
- Host: GitHub
- URL: https://github.com/mcchatman8009/antlr4-tool
- Owner: mcchatman8009
- License: other
- Created: 2018-07-10T22:09:25.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2021-08-10T19:22:48.000Z (about 4 years ago)
- Last Synced: 2025-03-25T08:16:38.868Z (7 months ago)
- Topics: antlr-tool, antlr4, antlr4-grammar, antlr4-tool, antlr4-typescript, cli, command-line, es6, npm, parser, tool, typescript
- Language: TypeScript
- Homepage:
- Size: 5.66 MB
- Stars: 36
- Watchers: 2
- Forks: 20
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# antlr4-tool
## Overview
The purpose and intent of this project was to create and generate Typescript declaration files
for the [Antlr4](https://www.npmjs.com/package/antlr4) JavaScript target.
Allowing for generated Antlr Parsers and Lexers that have full **ES5** browser support. This tool also
allows for pure JavaScript implementations, if needed.
## Requirements
* Java Runtime Environment 1.6+ (1.8+ recommended)
## Getting Stated
* Install *antlr4-tool*, adding it to your package.json
```bash
npm install --save-dev antlr4-tool
```
* Install the Antlr4 library
```bash
npm install -S antlr4
#
# (TypeScript Only)
#
npm install -S @types/antlr4
```
* Add a grammar to your project, e.g. path/to/Grammar.g4
```json
"scripts": {
"generate-parser": "antlr4-tool -o parser path/to/Grammar.g4"
}
```
* Run the NPM script command
```bash
npm run generate-parser
```
* Use your generated Parser
**JavaScript**
```javascript
const antlr4 = require('antlr4')
const InputStream = antlr4.InputStream;
const CommonTokenStream = antlr4.CommonTokenStream;
const GrammarParser = require('./parser/GrammarParser').GrammarParser;
const GrammarLexer = require('./parser/GrammarLexer').GrammarLexer;
const inputStream = new InputStream('int x = 10;');
const lexer = new GrammarLexer(inputStream);
const tokenStream = new CommonTokenStream(lexer);
const parser = new GrammarParser(tokenStream);
// Parse the input, where `compilationUnit` is whatever entry point you defined
const tree = parser.compilationUnit();
console.log(tree);
```
**TypeScript**
```typescript
import {InputStream, CommonTokenStream} from 'antlr4';
import {GrammarParser} from './parser/GrammarParser';
import {GrammarLexer} from './parser/GrammarLexer';
const inputStream = new InputStream('enter you grammar here');
const lexer = new GrammarLexer(inputStream);
const tokenStream = new CommonTokenStream(lexer);
const parser = new GrammarParser(tokenStream);
// Parse the input, where `compilationUnit` is whatever entry point you defined
const tree = parser.compilationUnit();
console.log(tree);
```
### TypeScript Notes
Add to your **tsconfig.json**:
```
"typeRoots": ["types"],
```
## For Command-Line Use
### Installation For Command-Line Use
```bash
npm install -g antlr4-tool
```
```
Usage: antlr4-tool [options]
Options:
-V, --version output the version number
-o --output-dir [output_dir] Output Directory (Default: Current Directory)
-l --language [language] Antlr Language Target: ts, typescript, js, javascript (Default: typescript)
--listener Generate parse tree listener (Default)
--no-listener Don't generate parse tree listener
--visitor Generate parse tree visitor (Default)
--no-visitor Don't generate parse tree visitor
-h, --help output usage information
```
### Finding the Version
```bash
antlr4-tool -V
```
### Example Creating a C Parser for TypeScript
```bash
antlr4-tool -l ts -o c-parser samples/c/C.g4
```
### Example Creating a C Parser for JavaScript
```bash
antlr4-tool -l js -o c-parser samples/c/C.g4
```
## Using antlr4-tool as a Library
```javascript
const tool = require('antlr4-tool');
const opts = {
language: 'TypeScript', // Only support for JavaScript & TypeScript
grammarFiles: ['samples/c/C.g4'],
outputDirectory: 'c-parser'
};
const compiledResults = tool.compile(opts);
console.log(compiledResults);
```