chevrotain
Version:
Chevrotain is a high performance fault tolerant javascript parsing DSL for building recursive decent parsers
731 lines (388 loc) • 23.6 kB
Markdown
## 2.0.1 (2-11-2018)
#### Bug Fixes
- Removed redundant dependency.
## 2.0.0 (2-11-2018)
#### Breaking Changes
- [See BREAKING_CHANGES.md](https://github.com/SAP/chevrotain/blob/master/BREAKING_CHANGES.md#200)
#### Major Changes
- [Support custom user defined declarative APIs](http://sap.github.io/chevrotain/website/Deep_Dive/custom_apis.html)
#### Minor Changes
- [Increase DSL methods suffix indices.](https://github.com/SAP/chevrotain/issues/606)
#### Bug Fixes
- [Added missing link to deprecated TokenType parent property error message.](https://github.com/SAP/chevrotain/issues/640)
## 1.0.1 (12-27-2017)
#### Documentation
- [New Documentation Website.](http://sap.github.io/chevrotain/website/)
#### Bug Fixes
- Parser exceptions will now reference the new docs page.
## 1.0.0 (12-8-2017)
#### Breaking Changes
- [Rework token single inheritance into multiple classifications/ categories.](https://github.com/SAP/chevrotain/issues/564#issuecomment-349062346)
- [Tokens properties renaming.](https://github.com/SAP/chevrotain/issues/610#issuecomment-350244423)
#### Minor Changes
- [Custom Error Message argument for CONSUME.](https://github.com/SAP/chevrotain/issues/543)
- [Improved empty empty alternatives detection.](https://github.com/SAP/chevrotain/issues/196)
- [previousToken information for EarlyExitException.](https://github.com/SAP/chevrotain/pull/616)
#### Bug Fixes
- [Missing token location in EarlyExitException if token is EOF.](https://github.com/SAP/chevrotain/issues/613)
## 0.35.0 (11-15-2017)
#### Minor Changes
- ["Type" Property on Tokens "instances" for easier debugging.](https://github.com/SAP/chevrotain/issues/542)
- [Support both "push_mode" and "pop_mode" on a Token to support transitions.](https://github.com/SAP/chevrotain/issues/597)
- [Validation to check for too many alternatives.](https://github.com/SAP/chevrotain/issues/388)
#### Examples
- [TinyC Grammar Example](https://github.com/SAP/chevrotain/blob/master/examples/grammars/tinyc/tinyc.js)
- [Backtracking Example.](https://github.com/SAP/chevrotain/blob/master/examples/parser/backtracking/backtracking.js)
## 0.34.0 (10-15-2017)
#### Minor Changes
- [Rework syntax diagrams creation for ease of use and simplicity.](https://github.com/SAP/chevrotain/issues/583)
## 0.33.0 (10-2-2017)
#### Breaking Changes
- Removed "extendToken" and "NEXT_TOKEN" deprecated APIs.
Use [createToken](http://sap.github.io/chevrotain/documentation/0_32_1/modules/_chevrotain_d_.html#createtoken)
and [LA(1)](http://sap.github.io/chevrotain/documentation/0_32_1/classes/_chevrotain_d_.parser.html#la) instead.
#### Minor Changes
- Tiny performance improvements and optimizations.
* [1](https://github.com/SAP/chevrotain/commit/0567813bea6c2d32d01fc2aaf39f5290c7e02f0b)
* [2](https://github.com/SAP/chevrotain/commit/26703756b17c71391f51fbecf08d06cba6c8734e)
* [3](https://github.com/SAP/chevrotain/commit/d82fb7afdc386005995a58b5d192641403931c16)
## 0.32.1 (7-8-2017)
#### Bug Fixes
- [Fixed diagrams sample.](https://github.com/SAP/chevrotain/commit/d28eb378d5704e82e189f05ff3333cf29601b27c)
## 0.32.0 (7-6-2017)
#### Major Changes
Lexer Performance oriented release.
10%+ performance boost measured under V8.
- [Lexer Perf boost - .test + lastIndex vs .exec.](https://github.com/SAP/chevrotain/issues/522)
- [Reduce token vector resizing using a simple heuristic](https://github.com/SAP/chevrotain/commit/530a1fe5fe0bb24233d1ff9759bae073e07365fe)
## 0.31.0 (7-1-2017)
#### Breaking Changes
- [Token patterns which may include line terminators must be explicitly flagged with the "line_breaks" property.](https://github.com/SAP/chevrotain/blob/master/docs/resolving_lexer_errors.md#LINE_BREAKS)
#### Major Changes
- [Support for user defined line terminators.](https://github.com/SAP/chevrotain/issues/523)
## 0.30.0 (6-23-2017)
#### Major Changes
- [Customizable error messages.](https://github.com/SAP/chevrotain/issues/500)
#### Minor Changes
- [Validate that user Token Patterns cannot match an empty string.](https://github.com/SAP/chevrotain/issues/379)
## 0.29.0 (6-13-2017)
#### Breaking Changes
- [Default maxLookahead changed to 4](https://github.com/SAP/chevrotain/issues/472)
* Originally the default maxLookahead was 5, This could cause very slow parser initialization
under certain edge case during ambiguity detection, however the vast majority of grammars do not
require five tokens of lookahead. A smaller default avoids these potential slow downs while still allows
overriding in unique cases which require a large lookahead.
#### Bug Fixes
- [Separator DSL methods lookahead issue.](https://github.com/SAP/chevrotain/issues/391)
## 0.28.3 (5-1-2017)
#### Bug Fixes
- [Diagrams drawing bug when using custom Token patterns.](https://github.com/SAP/chevrotain/issues/462)
## 0.28.2 (4-28-2017)
#### Minor Changes
- [Upgrade to TypeScript 2.3.1](https://github.com/SAP/chevrotain/pull/458)
#### Documentation
- [Ensure chevrotain.d.ts is compatiable with noImplicitAny.](https://github.com/SAP/chevrotain/issues/459)
## 0.28.1 (4-18-2017)
#### Minor Changes
- [Major performance boost for CST Creation.](https://github.com/SAP/chevrotain/issues/446)
* **50%** speed boost measured on V8 when CST output is enabled.
## 0.28.0 (4-16-2017)
#### Major Changes
- [Concrete Syntax Tree / Semantic Actions Visitor.](https://github.com/SAP/chevrotain/issues/381)
#### Documentation
- [Runnable offline tutorial source code.](https://github.com/SAP/chevrotain/pull/410)
#### Bug Fixes
- [Definitions: Chevrotain don't support literal string as Token PATTERN in TypeScript.](https://github.com/SAP/chevrotain/pull/448)
## 0.27.3 (3-31-2017)
#### Minor Changes
- [Support MultiMode Lexer definitions in Parser Constructor.](https://github.com/SAP/chevrotain/issues/395)
## 0.27.2 (3-31-2017)
#### Minor Changes
- [Detect alternation prefix ambiguities.](https://github.com/SAP/chevrotain/issues/186)
## 0.27.1 (3-29-2017)
#### Minor Changes
- [Refactor Lexer for minor performance boost.](https://github.com/SAP/chevrotain/commit/e91fc7e7b4f3a000ed9e3fa359b8fe6c3a6fd873)
#### Bug Fixes
- [Certain RegExp meta characters won't be handled correctly in small RegExps.](https://github.com/SAP/chevrotain/issues/433)
## 0.27.0 (3-27-2017)
#### Major Changes
- [Support string Literals as Token patterns.](https://github.com/SAP/chevrotain/issues/431)
- [Lexer Performance optimizations 0.27.0](https://github.com/SAP/chevrotain/issues/432)
## 0.26.0 (3-26-2017)
#### Breaking Changes
- [Major Refactoring to Lexer & Token APIs](https://github.com/SAP/chevrotain/issues/423#issuecomment-289225219)
#### Major Changes
- [Simplify Lexer & Tokens APIs.](https://github.com/SAP/chevrotain/issues/423)
#### Minor Changes
- [Detection of infinite loops caused by grammars with "empty" repetitions.](https://github.com/SAP/chevrotain/pull/410)
* Thanks @kdex!
## 0.25.1 (3-21-2017)
#### Bug Fixes
- [Fix Performance regression in Regular Tokens 0.25.0.](https://github.com/SAP/chevrotain/commit/52f3f1a4a7214b2b75c2ca95b58a1ec28ccbcfbd)
## 0.25.0 (3-19-2017)
#### Breaking Changes
- [Custom Token Patterns API change](https://github.com/SAP/chevrotain/issues/380#issuecomment-287629918)
#### Major Changes
- [Use RegExp sticky flag for lexer performance boost.](https://github.com/SAP/chevrotain/issues/380)
* Up to **30%** Lexer performance boost measured.
#### Bug Fixes
- [0.24.0: Regression: Terminal token name: {name} not found.](https://github.com/SAP/chevrotain/issues/406)
## 0.24.0 (3-17-2017)
#### Breaking Changes
- [DSL Methods Improved optional arguments syntax.](https://github.com/SAP/chevrotain/issues/367)
#### Major Changes
- [Automatic creation of a Concrete Syntax Tree.](https://github.com/SAP/chevrotain/issues/215)
* See [Relevant Docs]( https://github.com/SAP/chevrotain/blob/master/docs/concrete_syntax_tree.md).
#### Minor Changes
- [Clear error message if rules have been defined after performSelfAnalysis has been called.](https://github.com/SAP/chevrotain/issues/385)
- [Micro performance boost on subrule array init.](https://github.com/SAP/chevrotain/issues/378)
#### Bug Fixes
- [Avoid Possible internal unique key conflicts.](https://github.com/SAP/chevrotain/commit/393f2a97cd109c239ced67931586afe5034df713)
- [Infinite loop during GAST builder.](https://github.com/SAP/chevrotain/issues/392)
## 0.23.0 (2-3-2017)
#### Major Changes
- [Custom Token Patterns to Support Lexer Context.](https://github.com/SAP/chevrotain/issues/360)
#### Documentation
- [Example of lexing python style indentation.](https://github.com/SAP/chevrotain/issues/352)
## 0.22.0 (1-27-2017)
#### Minor Changes
- [Lexer performance improvements.](https://github.com/SAP/chevrotain/issues/354)
## 0.21.1 (1-26-2017)
#### Bug Fixes
- [Fix issue with tokens that both pop and push a mode.](https://github.com/SAP/chevrotain/issues/351)
- [Avoid infinite loops during validations caused by left recursion.](https://github.com/SAP/chevrotain/commit/b796ffb8a95046fa331e6f7c6c2504557b794096)
## 0.21.0 (12-24-2016)
#### Major Changes
- [New "createToken" helper functions.](https://github.com/SAP/chevrotain/issues/329)
- [Support for custom implementations of Token patterns.](https://github.com/SAP/chevrotain/issues/331)
## 0.20.0 (12-11-2016)
#### Breaking Changes
- [More Functional Parsing DSL API.](https://github.com/SAP/chevrotain/issues/324)
* This change **broke** a couple of APIS:
- "OPTION" now returns the value of the inner grammar implementation or undefined otherwise instead of a boolean.
- The "*_SEP" methods now return an object made up of two arrays, separators and values instead of a single array of separators.
## 0.19.0 (12-3-2016)
#### Minor Changes
- [Improve formatting of NoViableAlt exception message.](https://github.com/SAP/chevrotain/issues/297)
- [Less verbose syntax for defining grammar rules.](https://github.com/SAP/chevrotain/issues/316)
## 0.18.0 (10-27-2016)
#### Major Changes
- [Syntactic Content Assist Support.](https://github.com/SAP/chevrotain/issues/291)
## 0.17.1 (10-12-2016)
#### Bug Fixes
- [Lexer "Groups" state persists between different inputs tokenization.](https://github.com/SAP/chevrotain/issues/287)
#### Minor Changes
- [Parsers without error recovery should fail faster on invalid inputs.](https://github.com/SAP/chevrotain/issues/256)
## 0.17.0 (10-3-2016)
#### Major Changes
- [Grammar serialization and de-serialization.](https://github.com/SAP/chevrotain/issues/139)
- [Separate Railroad Diagram Generation into Scriptable Function.](https://github.com/SAP/chevrotain/issues/134)
## 0.16.1 (9-28-2016)
#### Minor Changes
- [Simple Lazy Tokens should support Token inheritance.](https://github.com/SAP/chevrotain/issues/282)
## 0.16.0 (9-24-2016)
#### Breaking Changes
The chevrotain TypeScript definitions file is now **only** compatible with TypeScript 2.0 and later versions.
For older versions of TypeScript use Chevrotain versions <= 0.15.0.
#### Minor Changes
- [Add "typings" field to package.json.](https://github.com/SAP/chevrotain/issues/251)
## 0.15.0 (9-23-2016)
#### Major Changes
- [Performance Improvements: Lookahead functions.](#274)
- [Performance: SimpleLazyTokens.](#277)
- ["Smart" Map based lookahead for K = 1 with Token inheritance.](#279)
This release is is focused on performance improvements, with **~20%** boost on V8
and potentially **~100%** (double) performance on SpiderMonkey (FireFox 49).
To enjoy the maximum performance boost the new **SimpleLazyTokens** should be used.
See:**[Token Types Docs](docs/token_types.md)** for additional details.
#### Breaking Changes
Certain advanced uses cases of [dynamically defined Tokens](https://github.com/SAP/chevrotain/blob/master/examples/parser/dynamic_tokens/dynamic_delimiters.js)
Will break if some of new lookahead optimizations are enabled.
To resolve this a new property **dynamicTokensEnabled** has been defined on the [IParserConfig](http://sap.github.io/chevrotain/documentation/0_15_0/interfaces/iparserconfig.html)
interface. This configuration property is disabled by default, but can be enabled to support the use case of dynamically defined tokens.
See the [dynamically defined Tokens](https://github.com/SAP/chevrotain/blob/master/examples/parser/dynamic_tokens/dynamic_delimiters.js)
example for details.
## 0.14.0 (9-3-2016)
#### Breaking Changes
- [OR DSL method Syntax should be more consistent.](https://github.com/SAP/chevrotain/issues/192)
#### Minor Changes
- [Performance Optimizations for 0.14.0 release.](https://github.com/SAP/chevrotain/pull/272)
## 0.13.4 (9-1-2016)
#### Minor Changes
- [Change NPMCDN links to use UNPKG domain name.](https://github.com/SAP/chevrotain/issues/270)
## 0.13.3 (8-28-2016)
#### Bug Fixes
- [Slow Parser Initialization.](https://github.com/SAP/chevrotain/issues/243)
## 0.13.2 (8-23-2016)
#### Bug Fixes
- [Diagrams with nodejs fail on instanceof check.](https://github.com/SAP/chevrotain/issues/268)
## 0.13.1 (8-15-2016)
#### Major Changes
- [Lexer: Lazy Tokens support.](https://github.com/SAP/chevrotain/issues/258)
- [Token "startOffset" and "endOffset" properties.](https://github.com/SAP/chevrotain/issues/259)
This Release includes a new **performance** feature called **"Lazy Tokens"**.
These tokens contain less actual state and defer the calculation of their properties
until needed. Considering most of the time this information is never needed (full position information)
the overall speed boost can be as much as **10-25%** (depending on the grammar used).
[See "2. Use Lazy Tokens"](https://github.com/SAP/chevrotain/blob/master/docs/faq.md#Q6)
for more details.
## 0.13.0 (8-6-2016)
#### Major Changes
- [0.13.0 Performance Optimizations.](https://github.com/SAP/chevrotain/issues/248)
- [Performance FAQ section docs.](https://github.com/SAP/chevrotain/blob/master/docs/faq.md#Q6)
This release includes **major performance optimizations and guidelines**.
Anywhere from 20% to 100% was measured (on V8) depending on the grammar used.
Please read the Performance FAQ section, as much of the performance gain is achieved by changing
the way a Chevrotain parser is initialized which will require code changes (not mandatory)
in user's code.
## 0.12.1 (8-3-2016)
#### Bug Fixes
- [Diagrams do not work with custom lexers.](https://github.com/SAP/chevrotain/issues/242)
#### Documentation
- [Improve support for running minified in the browser.](https://github.com/SAP/chevrotain/issues/239)
## 0.12.0 (7-21-2016)
#### Breaking Changes
- [Removed Bower support.](https://github.com/SAP/chevrotain/issues/226)
#### Bug Fixes
- [Predicates / Gates using closures to parameters will cause unexpected behavior.](https://github.com/SAP/chevrotain/issues/221)
- [Diagrams highlights issues under IE Edge.](https://github.com/SAP/chevrotain/issues/229)
#### Documentation
- [Example using parametrized sub-rules.](https://github.com/SAP/chevrotain/issues/218)
## 0.11.4 (7-16-2016)
- Fixes issue with previous release automation.
## 0.11.3 (7-16-2016)
#### Bug Fixes
- [AmbiguousAlternatives error's <occurence> property was always undefined.](https://github.com/SAP/chevrotain/issues/212)
#### Quality
- [Use SauceLabs for browser matrix testing](https://github.com/SAP/chevrotain/issues/217)
## 0.11.2 (7-5-2016)
#### Minor Changes
- [Unresolved subrule references can cause none descriptive exceptions during follow up validations.](https://github.com/SAP/chevrotain/issues/209)
- [More descriptive unresolved grammar error message.](https://github.com/SAP/chevrotain/issues/210)
#### Documentation
- [Dynamically defined Tokens example.](https://github.com/SAP/chevrotain/issues/208)
## 0.11.1 (6-16-2016)
#### Minor Changes
- [extendToken should create constructor functions with meaningful names](https://github.com/SAP/chevrotain/issues/206)
## 0.11.0 (6-7-2016)
- Minor version release as the previous version included a breaking change in a patch version.
#### Minor Changes
- [Better runtime checks for Invalid Lexer definitions.](https://github.com/SAP/chevrotain/issues/204)
## 0.10.2 (6-6-2016)
#### Breaking Changes
- [MultiMode Lexer defaultMode should not be implicitly defined.](https://github.com/SAP/chevrotain/issues/202)
#### Documentation
- [XML grammar example.](https://github.com/SAP/chevrotain/issues/201)
## 0.10.1 (5-30-2016)
- Fixes issue with previous release automation.
## 0.10.0 (5-29-2016)
#### Major Changes
- [Predicates / Gates on productions should be in addition to standard lookahead.](https://github.com/SAP/chevrotain/issues/189)
- [Capability to ignore parser definition issues at construction time.](https://github.com/SAP/chevrotain/issues/197)
#### Breaking Changes
- **IsNextRule** method was removed from the Parser class. It's functionality is no longer needed as usage of predicates / gates
no longer requires manually (re)implementing the lookahead function.
- [DSL methods with separators should not support predicates.](https://github.com/SAP/chevrotain/issues/191)
- [Move all "parse time" grammar validations to the initialization phase (grammar construction).](https://github.com/SAP/chevrotain/issues/103)
#### Documentation
- [Example implementing syntactic & semantic content assist.](https://github.com/SAP/chevrotain/issues/194)
## 0.9.0 (4-29-2016)
#### Major Changes
- [Support LL(k) grammars.](https://github.com/SAP/chevrotain/issues/184)
## 0.8.1 (4-11-2016)
#### Minor Changes
- [Avoid rebuilding the GAST on parser construction when using RULE_OVERRIDE.](https://github.com/SAP/chevrotain/issues/171)
#### Bug Fixes
- [GAST Production cache does not take into account grammar inheritance](https://github.com/SAP/chevrotain/issues/181)
## 0.8.0 (4-8-2016)
#### Breaking Changes
Some breaking API changes in this version. Most have the changes have been to optional arguments,
so not many changes will be needed (if at all) for most users.
- [Use a config object for RULE DSL method.](https://github.com/SAP/chevrotain/issues/168)
The [RULE method's](http://sap.github.io/chevrotain/documentation/0_7_2/classes/parser.html#rule) optional third and fourth parameters
have been been replaced with a single configuration object of the type [IRuleConfig](http://sap.github.io/chevrotain/documentation/0_8_0/interfaces/iruleconfig.html).
Therefore any RULE invocation with more than two arguments must be refactored to the new form.
For example:
```Typescript
// old deprecated form
this.RULE("createStmt", function(){ /* ... */}, function(){ return 666 })
// new form
this.RULE("createStmt", function(){ /* ... */}, {recoveryValueFunc: function(){ return 666 }})
```
- [Remove RULE_NO_RESYNC DSL method.](https://github.com/SAP/chevrotain/issues/172)
The RULE_NO_RESYNC convenience method has been removed.
All usages of it must be replaced with an equivalent RULE call using the IRuleConfig [resyncEnabled](http://sap.github.io/chevrotain/documentation/0_8_0/interfaces/iruleconfig.html#resyncenabled)
property.
For example:
```javascript
// old deprecated form
this.RULE_NO_RESYNC("createStmt", function(){ /* ... */})
// new form
this.RULE("createStmt", function(){ /* ... */}, {resyncEnabled: false})
```
- [Parser Configuration should be done using a "Config" Object instead of constructor parameters.](https://github.com/SAP/chevrotain/issues/175)
- [Error Recovery / Fault Tolerance abilities should be disabled by default.](https://github.com/SAP/chevrotain/issues/174)
The [Parser constructors's](http://sap.github.io/chevrotain/documentation/0_7_2/classes/parser.html#rule) third (optional) parameter
has been been replaced with a single configuration object of the type [IParserConfig](http://sap.github.io/chevrotain/documentation/0_8_0/interfaces/iparserconfig.html)
Therefore any Base Parser super invocation which uses the optional parameter must be updated.
Additionally The Error recovery functionality is now **disabled** by default, it can be enabled via the parser's configuration.
For example:
```javascript
// old deprecated form
function JsonParser(input) {
// The third argument was used to enable/disable error recovery
// and was **true** by default.
Parser.call(this, input, true)
}
// new form
function JsonParser(input) {
// invoke super constructor
Parser.call(this, input, allTokens, {
// by default the error recovery flag is **false**
// use recoveryEnabled flag in the IParserConfig object to enable enable it.
recoveryEnabled: true}
);
}
```
## 0.7.2 (4-7-2016)
#### Minor Changes
- [Support Overriding Rule implementations in inheriting grammars.](https://github.com/SAP/chevrotain/issues/169)
#### Documentation
- [Bring order to the chaos of the examples folder.](https://github.com/SAP/chevrotain/tree/master/examples)
## 0.7.1 (4-3-2016)
#### Minor Changes
- [Parsing Errors should include Parser context information.](https://github.com/SAP/chevrotain/issues/165)
- [AT_LEAST_ONE dsl rule, errMsg param should be optional.](https://github.com/SAP/chevrotain/issues/91)
## 0.7.0 (4-2-2016)
#### Major Changes
- [Lexer multi "modes" support.](https://github.com/SAP/chevrotain/issues/134)
## 0.6.3 (3-28-2016)
#### Minor Changes
- [Re-synced tokens should be reported to the user.](https://github.com/SAP/chevrotain/issues/154)
## 0.6.2 (3-25-2016)
#### Bug Fixes
- [LexerDefinitionErrorType enum was not exported as part of the public API.](https://github.com/SAP/chevrotain/issues/158)
## 0.6.1 (3-25-2016)
#### Bug Fixes
- [ParserDefinitionError enum was not exported.](https://github.com/SAP/chevrotain/commit/96edf7fe26d41f25272ea2a39d27fd7eb27991b2)
## 0.6.0 (3-20-2016)
#### Breaking Changes
- [Reorganized projected structure to be consistent and use "lib" folder](#155)
Chevrotain's aggregated artifacts are now located under the **lib** folder instead of the **bin** folder in the npm package
or the **release** folder in the bower pacakge.
This means that references to "bower_components/chevrotain/**release**/..." or "node_modules/chevrotain/**bin**/..."
Will have to be replaced with references to ".../**lib**/...".
[For example - modified diagrams.html](https://github.com/SAP/chevrotain/pull/155/files#diff-c5283f95a0a6408c8016dcaff5abe0fa)
Note that no changes are needed for standard consumption of chevrotain under node.js (**require('chevrotain')**).
#### Bug Fixes
- [Diagrams - Fixed global references to permit UMD loading.](https://github.com/SAP/chevrotain/issues/152)
## 0.5.23 (3-17-2016)
#### Bug Fixes
- [Syntax Diagrams usage highlights issues.](https://github.com/SAP/chevrotain/issues/149)
## 0.5.22 (3-15-2016)
#### Minor Changes
- [Human Readable Token Labels in Syntax Diagrams.](https://github.com/SAP/chevrotain/issues/144)
- [Use Token Labels in error messages.](#https://github.com/SAP/chevrotain/issues/146)
#### Bug Fixes
- [Diagrams template resources were not fully included in bower "package".](https://github.com/SAP/chevrotain/issues/145)
**Older Releases** changelog is available on [Github Releases.](https://github.com/SAP/chevrotain/releases)