A source code formatter/beautifier/pretty printer for the Java programming language. It is aimed to provide a full-featured, yet free alternative to the well-known Jindent. Plug-ins for Ant, Eclipse, IDEA, JBuilder, JDeveloper, jEdit, NetBeans.
The latest and greatest source can be found here on GitHub. If you are using Git, use this command to clone the project:
git clone git://github.com/lukespragg/jalopy.git
Or download the latest zip archive.
This project can be built with the latest Java Development Kit and Maven or Gradle. Maven and Gradle are used to simplify dependency management, but using either of them is optional.
For Maven, the command mvn clean package
will build the project and will put the compiled JAR in target
, and mvn clean install
will copy it to your local Maven repository.
For Gradle, the command gradlew
will build the project and will put the compiled JAR in ~/build/distributions
, and gradlew install
will copy it to your local Maven repository.
Are you a talented programmer looking to contribute some code? We'd love the help!
- Open a pull request with your changes, following the guidelines and coding standards.
- Please follow the above guidelines for your pull request(s) accepted.
- For help setting up the project, keep reading!
If you're using Maven to manage project dependencies, simply include the following in your pom.xml
file:
<dependency>
<groupId>com.lukespragg</groupId>
<artifactId>jalopy</artifactId>
<version>1.1.0-SNAPSHOT</version>
</dependency>
If you do not already have the required repo in your repository list, you will need to add this as well:
<repository>
<id>sonatype-nexus</id>
<url>https://oss.sonatype.org/content/groups/public</url>
</repository>
If you're using Gradle to manage project dependencies, simply include the following in your build.gradle
file:
repositories {
mavenLocal()
mavenCentral()
maven {
name = 'sonatype-nexus'
url = 'https://oss.sonatype.org/content/groups/public/'
}
}
dependencies {
compile 'com.lukespragg:jalopy:1.0.0-SNAPSHOT'
}
To generate the the Javadocs with Maven, use the mvn javadoc:javadoc
command. To view the javadocs simply go to target/site/apidocs/
and open index.html
in a web browser.
To generate Javadocs with Gradle, use the gradlew javadoc
command. To view the javadocs simply go to build/docs/javadoc/
and open index.html
in a web browser.
Jalopy is licensed under the BSD 3-Clause License. Basically, you can do whatever you want as long as you include the original copyright. Please see the LICENSE.txt
file for details.