README.md

java-code-format

Enhance

format the java file/dir

List<String> formatSourceFile(String file, boolean useExecutor, ExecutorService executorService,
                                       boolean reWrite, long timeout, TimeUnit unit, boolean timeoutForAll);

you can choose using a ExecutorService to formatted the source file now.

Using the formatter

from the command-line

Download the formatter and run it with:

java -jar /path/to/google-java-format-1.6-all-deps.jar <options> [files...]

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, use google-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

A google-java-format IntelliJ plugin is available from the plugin repository.

The plugin will be enabled by default. To disable it in the current project, go to File→Settings...→google-java-format Settings (or IntelliJ IDEA→Preferences...→Other Settings→google-java-format Settings on macOS) and uncheck the Enable google-java-format checkbox.

To disable it by default in new projects, use File→Other Settings→Default Settings....

When enabled, it will replace the normal Reformat Code action, which can be triggered from the Code menu or with the Ctrl-Alt-L (by default) keyboard shortcut.

The import ordering is not handled by this plugin, unfortunately. To fix the import order, download the IntelliJ Java Google Style file and import it into File→Settings→Editor→Code Style.

Eclipse

A google-java-format Eclipse plugin can be downloaded from the releases page. Drop it into the Eclipse drop-ins folder to 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

• Gradle plugins
  • Spotless:
  • sherter/google-java-format-gradle-plugin
• Apache Maven plugins
  • coveo/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.
• maltzj/google-style-precommit-hook: A pre-commit (pre-commit.com) hook that will automatically run GJF whenever you commit code to your repository

Usage

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

or

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

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

Building from source

mvn install

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.