Releases: peggyjs/peggy
Fix types
External grammar libraries
4.0.0
Released: 2024-02-13
Major Changes
- #379 Fix infinite recursion
issue by moving reportInfiniteRecursion to the new prepare pass, and having
it fail after finding the first issue. This will require plugin authors
to ensure that reportInfiniteRecursion is in the new pass correctly. - #417 BREAKING: change to AST to
allow topLevelInitializer and initializer to be arrays, in support of
multi-file inputs. This will require plugin updates. The CLI and API now
take multiple files as input, where the first file is your main library, and
subsequent files consist of a library of other rules. The CLI can take file
names of the formnpm:<package-name>/<filename>to load library rules from
an NPM package that is installed relative to the previous non-npm file name,
or to the current working directory if this is the first file name. - #420 BREAKING: Node v16+ is now
required for running the CLI or using Peggy as a library. Generated code
still targets older runtimes. - #456 BREAKING: Allow imports
from external compiled grammars inside a source grammar, usingimport {rule} from "external.js". Note that this syntax will generate either
importorrequirein the JavaScript output, depending on the value of
theformatparameter. This will need explicit support from
plugins, with a few new AST node types and a few visitor changes. - #463 Drop support for
Internet Explorer. Move to eslint flat configs in order to lint minimized
browser code for compatibility with
defaults, maintained node versions, not op_mini all.
Minor Changes
- #400 Use
@generatedin generated
code - #404 Add support for -w/--watch
to the command line interface. - #415 Added
browserkey to package.json, pointing to Webpack output. - #420 Updated dependencies to
avoid audit warnings. - #425 Add a pass to simplify single-character choices
- #427 Avoid double extraction of
substrings in various MATCH_ bytecodes - #430 Make generate-js.js ts clean
- #432 Add peggy.code-workspace
- #435 Setup tsconfig to detect use of library functions from es6 or later
- #436 Get rid of tsd
- #437 Better type checking for visitor
- #438 Make test build deterministic
- #439 Make peg$computePosDetails a little faster
- #440 Create directories for
output and source-map if they do not exist, rather than erroring. - #446 Add a right-associative
ExponentiationExpressionrule (operator**) tojavascript.pegjsexample grammar. - #451 Make stack.js ts clean
- #452 Fixes to prepare generate-bytecode.js for ts-check
- #453 Make generate-bytecode.js ts-clean
- #460 Allow
-tand-Ttesting
from the CLI with--format es.
Bug Fixes
Contributors
Assets 2
More cleanups
3.0.2
Released: 2023-03-21
Minor Changes
Bug Fixes
- #371 Error using online Peggy - "Can't find variable: util". From @hildjj.
- #374 CLI throws exception on grammar errors. From @hildjj
- #381 Repetitions with code blocks for min or max not handling non-integer returns correctly. From @hildjj.
- #382 Update grammarSource documentation. From @AndrewRayCode.
- #384 Improve the error.format() documentation. From @AndrewRayCode.
- #386 Ensure '*' as allowed-start-rule is documented for CLI. From @hildjj.
Contributors
Assets 2
Minor cleanups
Minor Changes
- #329 Allow plugin options in
generate. This change loosens type checking strictness to allow for options
unknown to Peggy, but used by plugins such as ts-pegjs. From @hildjj.
Bug Fixes
- #329 Allow type definition for ParserBuildOptions to include plugin options. From @hildjj.
- #346 Allow extra semicolons between rules. From @hildjj.
- #347 Disallow '$' as an initial character in identifiers. This is not a breaking change because no grammar could have successfully used these in the past. From @hildjj.
- #354 Various minor nits in the docs, including indentation and ensuring that the CNAME file is correct.
- #357 Fix infinite recursion possibility in repetition delimeters. From @hildjj and @Mingun.
- #359 Do not treat as many words as reserved. Clarify the documentation about identifiers. Ensure that it is more clear that the target language being generated determines what words are reserved. Clarify that reserved word checking is only done for labels. From @nene.
- #364 Fix passing an incorrect external label to the expression inside the
repeatednode. From @Mingun.
Contributors
Assets 2
Breaking changes: node 14+ and reserved words
3.0.0
Released: 2023-02-21
Major Changes
- #280 Add inline examples to the documentation, from @hildjj
- #240 Generate SourceNodes for bytecode, from @hildjj
- #338 BREAKING CHANGE. Update dependencies, causing minimum supported version of node.js to move to 14. Generated grammar source should still work on older node versions and some older browsers, but testing is currently manual for those. from @hildjj
- #291: Add support for repetition operator
expression|min .. max, delimiter|, from @Mingun - #339: BREAKING CHANGE. Updated the list of JavaScript reserved words. This will break existing grammars that use any of the new words in their rule or label names. from @hildjj
Important information for plug-in authors: PR [#291] added 4 new opcodes to the bytecode:
IF_LTIF_GEIF_LT_DYNAMICIF_GE_DYNAMIC
and added a new AST node and a visitor method repeated. Do not forget to update your plug-ins.
Important information for grammar authors: the following words, which used to be valid identifiers for rules and labels, are now treated as JavaScript reserved words, and will cause errors at compile time if you are using them:
- abstract
- as
- async
- boolean
- byte
- char
- double
- eval
- final
- float
- from
- get
- goto
- int
- long
- native
- of
- set
- short
- synchronized
- throws
- transient
- volatile
Minor Changes
- #274
"*"is now a validallowedStartRule, which means all rules are allowed, from @hildjj - #229 new CLI option
-S <rule>or--start-rule <rule>to specify the start rule when testing, from @hildjj - #236 Website: show line numbers in parser input textarea, from @Mingun
- #280 new output type
source-with-inline-map, which generates source text with an inline map, from @hildjj - #285 Require that a non-empty string be given as a grammarSource if you are generating a source map, from @hildjj
- #206: New output type
astand an--astflag for the CLI to get an internal grammar AST for investigation (can be useful for plugin writers), from @Mingun - #294 Website: show errors in the editors, from @Mingun
- #297 Website: add Discord widget, from @hildjj
- #299 Add example grammar for a SemVer.org semantic version string, from @dselman
- [#307] Allow grammars to have relative offsets into their source files (e.g. if embedded in another doc), from @hildjj.
- #308 Add support for reading test data from stdin using
-T -, from @hildjj. - #313 Create the website using eleventy, from @camcherry
Bug Fixes
Contributors
Assets 2
Restore CDN functionality
Released: 2022-01-01
Major Changes
- None
Minor Changes
- #261: Remove documentation from
README.md, instead linking to the HTML documentation. HTML documentation on
https://peggyjs.org is now served from thedocsbranch, so that it won't
update as we change themainbranch.mainmust be merged ontodocsas
a part of the release process going forward. - #266: Expose the private
fieldproblemsin theSessionclass, from @hildjj.
Bug Fixes
Contributors
Assets 2
Source map support
Major Changes
- #163: Add support for
generating source maps, from @Mingun - #160: Introduce an API for
reporting errors, warnings and information messages from passes. New API
allows reporting several diagnostics at once with intermediate results
checking after each compilation stage, from @Mingun - #218: Add a
sourceMappingURL
to the generated code, from @hildjj - #248: Remove support for
Node.js version 10. When updating dependencies, too many of the tools we
use no longer work on the Node 10, which went out of security maintenance
more than a year ago. Added support for Node.js version 18, from @hildjj - #251: Make
commanderand
source-map-generatorfull dependencies. These are not needed for the
pre-packaged web build, but will be used by Node or people that are doing
their own packaging for the web, from @hildjj
Minor Changes
- #167: New CLI, from @hildjj
- Backward compatible with the previous
- New -t/--test and -T/--testfile flags to directly test the generated grammar
- #169: Expose string escape
functions,stringEscape()andregexpClassEscape(), from @hildjj - #175: Check allowedStartRules
for validity, from @hildjj - #185: Updated eslint rules,
from @hildjj - #196: Add example grammars for
XML and source-mapping, from @hildjj - #204: Increase coverage for the
tests, from @Mingun - #210: Refactor CLI testing,
from @hildjj
Bug fixes
- #164: Fix some errors in the
typescript definitions, from @Mingun - #170: Add
missing argument in function call, from @darlanalves - #182: Fix typo in
documentation, from @zargold - #197: Fix a regression of
redundant commas in the character classes in the error messages, introduced
in fad4ab7, from @Mingun - #198: Make all build scripts
run on Windows, from @hildjj - #199: Test web version locally,
using puppeteer, from @hildjj - #211:Command-line -t requires
from wrong directory, from @hildjj - #212: Parse errors with zero
length give badly-formatted errors, from @hildjj - #214: Failing tests don't
format errors - #216: Fix typescript
definition of SyntaxError, from @cmfcmf - #220: Fix rollup warnings,
from @hildjj
Contributors
Assets 2
Minor features and optimizations
Minor Changes
-
Infrastructural rebake @StoneCypher
- Builds with
typescript, removesbabel - Bundles with
rollup, removesbrowserify - Tests with
jest, removesmocha - Minifies with
terser, removesuglify - Adds
rimraffor portable pre-build cleanup - Extends CI testing to
windows,macintosh - Increases node testing range to include
node 16
- Builds with
-
Option to select optimization mode removed as it had no significant effect on the
majority of generated parsers and as such represented only academic interest. You should
use minifiers to get smaller parsers. Optionoptimizeis deleted from thegenerate()
options, flag--optimizeis deleted from the CLI (you still can supply it, but the CLI
will issue a warning that the option is removed).
@Mingun -
location()s now will have additionalsourceproperty which value is taken
from theoptions.grammarSourceproperty. That property can contain arbitrary
data, for example, path to the currently parsed file.
@Mingun -
Made usage of
GrammarErrorandpeg$SyntaxErrormore consistent. Use the
formatmethod to get pretty string outputs. Updated thepeggybinary to
make pretty errors. Slight breaking change: the format of a few error
messages have changed; use thetoString()method onGrammarErrorto get
something close to the old text.
@hildjj -
The code generator was slightly reworked to simplify reusing the bytecode generator
(generate.generateBytecodepass). Propertyconstson thegrammarAST node,
has been creating by the pass in the past, was decoupled into 4 other properties
with the structured information:literalsclassesexpectationsfunctions
-
Added missing type definitions to the
peg.d.tsfile. Added definitions for the
compilerandvisitormodules, AST, andpluginsoption in thegenerate()function.
@MingunNow bytecode generation pass is independent from the JavaScript backend.
@Mingun -
Some opcodes from
compiler/opcode.jswere deprecated. Although you shouldn't use
them directly because they are not considered as a public API, some plugins use them.
For that reason backward compatibility is preserved:- Opcode
MATCH_REGEXPis deprecated and replaced byMATCH_CHAR_CLASSwith the same value. - Added new opcode
PUSH_EMPTY_STRINGthat puts a new empty string on the stack. - Opcode
PUSHis deprecated because it was used only for pushing empty string constants
and they now pushed withPUSH_EMPTY_STRING.
Instead of relying on the library opcodes it is better to have a copy of
them, especially if your plugin replaces both thegenerateBytecodeand
thegenerateJspasses. @Mingun - Opcode
-
Default visitor functions, returned by the
visitor.build(), that just forward
call tonode.expression, now return the result of underlyingvisitcall.
@MingunAffected functions:
rulenamedactionlabeledtextsimple_andsimple_notoptionalzero_or_moreone_or_moregroup
-
Parsers now can use two new functions to get location information:
offset()andrange(). Use them if you don't need the whole
location information, because it is expensive to compute.
These two new functions are always very efficient (back-ported pegjs/pegjs#528).
@felix9 and @Mingun -
Add a new option
config.reservedWords: string[], avalible for plugins in their
use()method. Using this option, a plugin can change the list of words that
cannot be used.By default this new option contains an array with reserved JavaScript words
@Mingun -
Several optimizations in the generator. Generated parsers should now be faster and smaller
@Mingun
Bug fixes
Global Initializers, @plucking
Major Changes
- Added global initializer blocks, which contain code that is only run once
when the grammar is loaded, rather than once every time the parser runs.
Global initializers are surrounded by{{and}}, and must come before
the per-parser initializer, which is surrounded by{and}.
@jaubourg - Back-ported value plucking with
@from pegjs head. If your rule has a simple action that returns one or more of the values matched by the rule, you can instead mark those expressions with@and not need an action. This works inside of parens as well. @hildjj
Bug fixes
First release
Ported over PEG.js from the last-known-good point. Without changing anything substantive, got everything to work in a mostly-current environment.