FIX #8169: modify Antlr4 CLI installation guidelines to be more prominent (#8183)

This commit is contained in:
finn-mcclusky 2022-10-18 00:45:53 +11:00 committed by GitHub
parent 786be3bedf
commit e14a3e213b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -10,12 +10,12 @@ OpenMetadata being a full stack project, we use the following for development:
- [Docker 20 or higher](https://docs.docker.com/engine/install/)
- [Java JDK 11 or higher](https://docs.oracle.com/en/java/javase/17/install/overview-jdk-installation.html)
- [Antlr 4.9.2](https://www.antlr.org/) - `sudo make install_antlr_cli`
- [Maven 3.5.x or higher](https://maven.apache.org/install.html)
- [Python 3.7 or higher](https://www.python.org/downloads/)
- [Node >=10.0.0](https://nodejs.org/en/download/)
- [Yarn ^1.22.0](https://classic.yarnpkg.com/lang/en/docs/install/)
- [Rpm (Optional, only to run RPM profile with maven)](https://macappstore.org/rpm/)
- Antlr 4.9.2 - `sudo make install_antlr_cli`
- Here is a snapshot of a working environment on a Macbook.
@ -23,6 +23,33 @@ OpenMetadata being a full stack project, we use the following for development:
> docker --version
Docker version 20.10.8, build 3967b7d
> java -version
openjdk version "11.0.11" 2021-04-20
OpenJDK Runtime Environment AdoptOpenJDK-11.0.11+9 (build 11.0.11+9)
OpenJDK 64-Bit Server VM AdoptOpenJDK-11.0.11+9 (build 11.0.11+9, mixed mode)
> antlr4
ANTLR Parser Generator Version 4.9.2
-o ___ specify output directory where all output is generated
-lib ___ specify location of grammars, tokens files
-atn generate rule augmented transition network diagrams
-encoding ___ specify grammar file encoding; e.g., euc-jp
-message-format ___ specify output style for messages in antlr, gnu, vs2005
-long-messages show exception details when available for errors and warnings
-listener generate parse tree listener (default)
-no-listener don\'t generate parse tree listener
-visitor generate parse tree visitor
-no-visitor don\'t generate parse tree visitor (default)
-package ___ specify a package/namespace for the generated code
-depend generate file dependencies
-D<option>=value set/override a grammar-level option
-Werror treat warnings as errors
-XdbgST launch StringTemplate visualizer on generated code
-XdbgSTWait wait for STViz to close before continuing
-Xforce-atn use the ATN simulator for all predictions
-Xlog dump lots of logging info to antlr-timestamp.log
-Xexact-output-dir all output goes into -o dir regardless of paths/package
> mvn -version
Apache Maven 3.8.2 (ea98e05a04480131370aa0c110b8c54cf726c06f)
Maven home: /usr/local/Cellar/maven/3.8.2/libexec
@ -30,11 +57,6 @@ Java version: 11.0.11, vendor: AdoptOpenJDK, runtime: /Library/Java/JavaVirtualM
Default locale: en_US, platform encoding: UTF-8
OS name: "mac os x", version: "10.15.7", arch: "x86_64", family: "mac"
> java -version
openjdk version "11.0.11" 2021-04-20
OpenJDK Runtime Environment AdoptOpenJDK-11.0.11+9 (build 11.0.11+9)
OpenJDK 64-Bit Server VM AdoptOpenJDK-11.0.11+9 (build 11.0.11+9, mixed mode)
> make -version
GNU Make 3.81
Copyright (C) 2006 Free Software Foundation, Inc.