From eaf0cd8dea9f2ed8ac4ab962abb23a13c9d6deeb Mon Sep 17 00:00:00 2001 From: Mike Lischke Date: Tue, 12 Sep 2023 11:03:47 +0200 Subject: [PATCH] New point release Added installation instructions --- ReadMe.md | 15 +++++++++++++++ package-lock.json | 18 +++++++++++++++--- 2 files changed, 30 insertions(+), 3 deletions(-) diff --git a/ReadMe.md b/ReadMe.md index bbfd20c..23801cd 100644 --- a/ReadMe.md +++ b/ReadMe.md @@ -17,6 +17,21 @@ This package is a fork of the official ANTLR4 JavaScript runtime, with the follo 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](https://github.com/antlr/antlr4/blob/master/doc/javascript-target.md) and [TypeScript](https://github.com/antlr/antlr4/blob/master/doc/typescript-target.md) 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: + +```bash +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: + +```bash +npm install --save-dev antlr4ng-cli +``` +See it's 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: diff --git a/package-lock.json b/package-lock.json index ce3e9d8..f37b920 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "antlr4ng", - "version": "1.0.4", + "version": "1.0.7", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "antlr4ng", - "version": "1.0.4", + "version": "1.0.7", "license": "BSD-3-Clause", "devDependencies": { "@babel/core": "7.22.15", @@ -29,13 +29,16 @@ "minimist": "1.2.8", "source-map-support": "0.5.21", "terser-webpack-plugin": "5.3.9", - "ts-node": "^10.9.1", + "ts-node": "10.9.1", "typescript": "5.2.2", "webpack": "5.88.2", "webpack-cli": "5.1.4" }, "engines": { "node": ">=16" + }, + "peerDependencies": { + "antlr4ng-cli": "1.0.0" } }, "node_modules/@aashutoshrathi/word-wrap": { @@ -2892,6 +2895,15 @@ "node": ">=4" } }, + "node_modules/antlr4ng-cli": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/antlr4ng-cli/-/antlr4ng-cli-1.0.0.tgz", + "integrity": "sha512-VBcZNDmdKkiMdj1ZNVXuPBxD9dRcxMdxuSWEjYVWYlZEWmY+01sPCN7QalK8ZOQdgbPdVwx5EIY49uiqbYFAnQ==", + "peer": true, + "bin": { + "antlr4ng": "index.js" + } + }, "node_modules/are-docs-informative": { "version": "0.0.2", "resolved": "https://registry.npmjs.org/are-docs-informative/-/are-docs-informative-0.0.2.tgz",