GitHub - google/google-java-format: Reformats Java source code to comply with Google Java Style. (original) (raw)

google-java-format

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

Using the formatter

From the command-line

java -jar /path/to/google-java-format-${GJF_VERSION?}-all-deps.jar <options> [files...]

Note that it uses the jdk.compiler module to parse the Java source code. Thejava binary version used must therefore be from a JDK (not JRE) with a version equal to or newer than the Java language version of the files being formatted. The minimum Java version can be found in core/pom.xml (currently Java 17). An alternative is to use the available GraalVM based native binaries instead.

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

To reformat changed lines in a specific patch, usegoogle-java-format-diff.py.

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.

IntelliJ, Android Studio, and other JetBrains IDEs

Agoogle-java-format IntelliJ pluginis available from the plugin repository. To install it, go to your IDE's settings and select the Plugins category. Click the Marketplace tab, search for the google-java-format plugin, and click the Install button.

The plugin will be disabled by default. To enable,open the Project settings, then click "google-java-format Settings" and check the "Enable google-java-format" checkbox.

To enable it by default in new projects,open the default settings for new projectsand configure it under "Other Settings/google-java-format Settings".

When enabled, it will replace the normal Reformat Code and Optimize Importsactions.

IntelliJ JRE Config

The google-java-format plugin uses some internal classes that aren't available without extra configuration. To use the plugin, you need toadd some options to your IDE's Java runtime. To do that, go to Help→Edit Custom VM Options... and paste in these lines:

--add-exports=jdk.compiler/com.sun.tools.javac.api=ALL-UNNAMED
--add-exports=jdk.compiler/com.sun.tools.javac.code=ALL-UNNAMED
--add-exports=jdk.compiler/com.sun.tools.javac.file=ALL-UNNAMED
--add-exports=jdk.compiler/com.sun.tools.javac.parser=ALL-UNNAMED
--add-exports=jdk.compiler/com.sun.tools.javac.tree=ALL-UNNAMED
--add-exports=jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED

Once you've done that, restart the IDE.

Eclipse

The latest version of the google-java-format Eclipse plugin can be downloaded from the releases page. Drop it into the Eclipsedrop-ins folderto activate the plugin.

The plugin adds a google-java-format formatter implementation that can be configured in Window > Preferences > Java > Code Style > Formatter > Formatter Implementation.

Third-party integrations

Visual Studio Code
- google-java-format-for-vs-code
Gradle plugins
- spotless
- sherter/google-java-format-gradle-plugin
Apache Maven plugins
- spotless
- spotify/fmt-maven-plugin
- talios/googleformatter-maven-plugin
- Cosium/maven-git-code-format: A maven plugin that automatically deploys google-java-format as a pre-commit git hook.
SBT plugins
- sbt/sbt-java-formatter
Github Actions
- googlejavaformat-action: Automatically format your Java files when you push on github

as a library

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.

google-java-format uses internal javac APIs for parsing Java source. The following JVM flags are required when running on JDK 16 and newer, due toJEP 396: Strongly Encapsulate JDK Internals by Default:

--add-exports=jdk.compiler/com.sun.tools.javac.api=ALL-UNNAMED
--add-exports=jdk.compiler/com.sun.tools.javac.code=ALL-UNNAMED
--add-exports=jdk.compiler/com.sun.tools.javac.file=ALL-UNNAMED
--add-exports=jdk.compiler/com.sun.tools.javac.parser=ALL-UNNAMED
--add-exports=jdk.compiler/com.sun.tools.javac.tree=ALL-UNNAMED
--add-exports=jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED

Maven

com.google.googlejavaformat google-java-format ${google-java-format.version}

Gradle

dependencies { implementation 'com.google.googlejavaformat:google-java-format:$googleJavaFormatVersion' }

You can then use the formatter through the formatSource methods. E.g.

String formattedSource = new Formatter().formatSource(sourceString);

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

Your starting point should be the instance methods ofcom.google.googlejavaformat.java.Formatter.

Building from source

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.