sherter/google-java-format

Download

Step 1. Add the JitPack repository to your build file

Add it in your root settings.gradle at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url 'https://jitpack.io' }
		}
	}

Add it in your settings.gradle.kts at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url = uri("https://jitpack.io") }
		}
	}

Add to pom.xml

	<repositories>
		<repository>
		    <id>jitpack.io</id>
		    <url>https://jitpack.io</url>
		</repository>
	</repositories>

Add it in your build.sbt at the end of resolvers:

 
    resolvers += "jitpack" at "https://jitpack.io"

Add it in your project.clj at the end of repositories:

 
    :repositories [["jitpack" "https://jitpack.io"]]

Step 2. Add the dependency

	dependencies {
		implementation 'com.github.sherter:google-java-format:'
	}
	dependencies {
		implementation("com.github.sherter:google-java-format:")
	}
	<dependency>
	    <groupId>com.github.sherter</groupId>
	    <artifactId>google-java-format</artifactId>
	    <version></version>
	</dependency>

                            
    libraryDependencies += "com.github.sherter" % "google-java-format" % ""
        
        

                            
    :dependencies [[com.github.sherter/google-java-format ""]]

Readme

google-java-format

Build Status

Release version: 0.1-alpha Snapshot version: 0.1-SNAPSHOT

google-java-format is a program that reformats Java source code to comply with Google Java Style.

Using the formatter from the command-line

First download the formatter and save it where you wish. Then simply run it via:

java -jar /path/to/google-java-format-0.1-alpha.jar <options> [files...]

The formatter can act on whole files, on limited lines (--lines), on specific ofsets (--offset), passing through to standard-out (default) or altered in-place (--replace).

Note: There is no configurability as to the formatter's algorithm for formatting. This is a deliberate design decision to unify our code formatting on a single format.

Using the formatter in code-generators

The formatter can be used in software which generates java to output more legible java code. Just include the library in your maven/gradle/etc. configuration.

Maven

<dependency>
  <groupId>com.google.googlejavaformat</groupId>
  <artifactId>google-java-format</artifactId>
  <version>0.1-alpha</version>
</dependency>

Gradle

dependencies {
  compile 'com.google.googlejavaformat:google-java-format:0.1-alpha'
}

You can then use the formatter quite simply using the various formatSource methods. E.g.

String formattedSource = Formatter.formatSource(sourceString);

or

CharSource source = ...
CharSink output = ...
Formatter.formatSource(source, output);

Generally speaking, your starting point should be the static methods found in com.google.googlejavaformat.java.Formatter.

Building from source

To build google-java-format from source, you will need copy IntelliJ's platform JARs from a local IntelliJ install; see install-idea-jars.sh. Alternatively, you can skip building the IntelliJ plugin:

mvn -pl '!idea_plugin' install

Contributing

Please see the contributors guide for details.

License

Copyright 2015 Google Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not
use this file except in compliance with the License. You may obtain a copy of
the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
License for the specific language governing permissions and limitations under
the License.