[JavaScript] Document Node.JS v16 requirement #4355
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Document that the ANTLR 4 JavaScript target requires Node >= 16. This has been the case since ANTLR 4.12.0 Fixes: 2c75e64 Signed-off-by: Alois Klink <alois@aloisklink.com>
Add some open-source badges to the README.md, taken from https://shields.io/. The most important one shows which versions of Node.JS are supported by the latest version of `antlr4`. Signed-off-by: Alois Klink <alois@aloisklink.com>
aloisklink
added a commit
to aloisklink/zenuml-core
that referenced
this pull request
Jul 12, 2023
ANTLR versioning does not strictly follow semver semantics (see https://github.com/antlr/antlr4/blob/dev/README.md): > * backwards compatibility is only guaranteed for patch version bumps (4.11.1 -> 4.11.2) > > Taken from > https://github.com/antlr/antlr4/blob/ce7f5e73cd4787c5aebdc05c29d4d898d6f2d123/README.md?plain=1#L33 Because of that, we can't use `^` (caret) in a version requirements. Instead, we can use [`~` tilde ranges][1]. Staying on v4.11.x is required, becasue `antlr4` v4.12.0 no longer supports Node.JS v14, see antlr/antlr4#4355. [1]: https://github.com/npm/node-semver#tilde-ranges-123-12-1
|
@parrt blessed |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The current
antlr4JavaScript package requires Node.JS v16, since 2c75e64 (aka ANTLR 4.12.0).The important line changed is:
antlr4/runtime/JavaScript/package.json
Line 49 in ce7f5e7
By the way, can an admin modify the release notes for https://github.com/antlr/antlr4/releases/tag/4.12.0 and stick somewhere that the javascript target now requires Node v16? It's currently missing from the release notes.
By the way, I've also added some badges to the
runtime/JavaScript/README.mdfile that automatically load data listed in thepackage.jsonfile, which look like:These shields are pretty common in the Python and JavaScript/NPM eco-system1
Footnotes
GitHub even hosts their own badges for GitHub Actions, like
is
↩