README.md

Antlr4Formatter

Building

The project uses maven wrapper, so it's easy to build the project without worrying about having the right Maven version installed locally.

To build antlr4-formatter and the standalone utility antlr4-formatter-standalone run:

./mvnw clean package

Using the standalone formatter

To format a grammar use the script formatFile.sh passing the grammar file as an argument to the script. You can also use it with the Spotless plugin in gradle or maven.

Maven Coordinates

<groupId>com.khubla.antlr4formatter</groupId>
<artifactId>antlr4-formatter</artifactId>
<version>1.2.1</version>
<packaging>jar</packaging>

Contributing

Contributions are welcome. To shorten the process of reviewing the pull request be sure that the code conforms to the projects code style. Before committing fix the code format by running spotless:

./mvnw spotless:apply