antlr4ng

TypeScript Target Runtime for ANTLR 4

This package is a fork of the official ANTLR4 JavaScript runtime (with its TypeScript additions), with the following changes:

• Much improved TypeScript type definitions.
• XPath implementation.
• Vocabulary implementation.
• Complete Interval implementation.
• Consistent formatting (indentation, semicolons, spaces, etc.).
• Numerous smaller fixes (null instead of undefined and others).
• Smaller node package (no test specs or other unnecessary files).
• Bug fixes.

It is (mostly) a drop-in replacement of the antlr4 package, and can be used as such. For more information about ANTLR see www.antlr.org. Read more details about the JavaScript and TypeScript targets at the provided links, but keep in mind that this documentation applies to the original JS/TS target.

Installation

To install the package, run the following command:

npm install antlr4ng

This package has a peer dependency to antlr4ng-cli, which is the tool to generate parser files compatible with this runtime, so it is strongly recommended to install this one too:

npm install --save-dev antlr4ng-cli

See its readme for more information.

Benchmarks

This runtime is constantly monitored for performance regressions. The following table shows the results of the benchmarks run on last release:

Test	Cold Run	Warm Run
Query Collection	8761 ms	233 ms
Example File	1062 ms	113 ms
Large Inserts	11577 ms	10844 ms
Total	21476 ms	11219 ms

The benchmarks consist of a set of query files, which are parsed by a MySQL parser.

Release Notes

1.1.0

This release includes a lot of cleanup.

• Generated parser rules that can appear as either returning a single parse context or a list of that no longer use the __list() appendix in their name. Instead method overloading is used now to distinguish between the two cases.
• The members getTypedRuleContext and getTypedRuleContexts have been renamed to getRuleContext and getRuleContexts respectively, just as in the Java runtime.
• There are more renames (_errHandler -> 'errorHandler, _input->inputStream` and more).
• The package has been stripped down to just a single bundle file. This is an ESM module now, so it can be used in both, node and browser environments. No differentiation is made anymore between the two.
• The internal folder structure has been changed to match the Java runtime.
• Extended some classes, added new type definitions and exported some more classes.
• Improved BitSet to use less memory.

1.0.6 - 1.0.7

• Fixed recognizer token type and rule index maps.
• Fixed getTokens() in BufferedTokenStream.
• Added new peer dependency antlr4ng-cli, which is the tool to generate parser files compatible with this runtime.

1.0.5

• Added benchmarks.
• Introduced the IntStream interface as the base for CharStream and TokenStream. This avoids duplicate code in the stream type definitions.
• Removed FileStream as a preparation to get rid of the separate package files for node and browser. If something needs to be loaded from a file, the particular environment should provide the code for that.

1.0.2 - 1.0.4

• Github build action
• Updated package.json
• Exported ErrorNode, InputMismatchException
• Some smaller fixes

1.0.1

• Added and/or replaced all copyrights to a common ANTLR version.
• Removed all individual default exports. Only the final lib exports contain both, default and non-default exports. This avoids namespace access like antlr4.atn. Everything is available under a top level import.
• Renamed ErrorListener to BaseErrorListener, as that is what it is actually when comparing it to the Java runtime.

1.0.0

• Initial release.