Skip to content

google/google-java-format

master
Switch branches/tags
Code

Latest commit

Bumps [maven-dependency-plugin](https://github.com/apache/maven-dependency-plugin) from 3.2.0 to 3.3.0.
<details>
<summary>Commits</summary>
<ul>
<li><a href="https://github.com/apache/maven-dependency-plugin/commit/e52bc0248c00dbf5458a0ce080db260148dab4b9"><code>e52bc02</code></a> [maven-release-plugin] prepare release maven-dependency-plugin-3.3.0</li>
<li><a href="https://github.com/apache/maven-dependency-plugin/commit/0ec0a522e29e740cd8b92da0382c589f3078218e"><code>0ec0a52</code></a> Fix Jenkins url</li>
<li><a href="https://github.com/apache/maven-dependency-plugin/commit/77e42ca2b80d42c8ac6195a1a16595ff0a11e8c0"><code>77e42ca</code></a> [MDEP-796] Upgrade Maven Parent to 35</li>
<li><a href="https://github.com/apache/maven-dependency-plugin/commit/78976c03b6afd8d28ff5cf82511888904cd645b0"><code>78976c0</code></a> [MDEP-795] Update Jetty to 9.4.45.v20220203 (<a href="https://github-redirect.dependabot.com/apache/maven-dependency-plugin/issues/202">#202</a>)</li>
<li><a href="https://github.com/apache/maven-dependency-plugin/commit/a8d4690acefc0d5ac67b6c1d7796802776d8d715"><code>a8d4690</code></a> [MDEP-788] Upgrade maven-reporting-impl to version 3.1.0</li>
<li><a href="https://github.com/apache/maven-dependency-plugin/commit/25ca8338e6af4f121d7d377ccfdd5ada4d4f4410"><code>25ca833</code></a> (doc) Update link to Github PR docs</li>
<li><a href="https://github.com/apache/maven-dependency-plugin/commit/76d59f0ffe8ab02757cb9c9d131004b6145a7ceb"><code>76d59f0</code></a> [MDEP-789] Improve documentation of analyze - Non-test scoped</li>
<li><a href="https://github.com/apache/maven-dependency-plugin/commit/b66d2b2e9cf81ce865fcd362ec48b3dfdb1b5548"><code>b66d2b2</code></a> Bump mockito-core from 4.2.0 to 4.3.1</li>
<li><a href="https://github.com/apache/maven-dependency-plugin/commit/b057234aec8b3da4001ae5fa94791dde1a73278f"><code>b057234</code></a> Bump slf4j-simple from 1.7.32 to 1.7.36</li>
<li><a href="https://github.com/apache/maven-dependency-plugin/commit/f64d4f7f9fcb59769e5587b7ef9dd2300cda205e"><code>f64d4f7</code></a> [MDEP-787] allow ignoring non-test-scoped dependencies</li>
<li>Additional commits viewable in <a href="https://github.com/apache/maven-dependency-plugin/compare/maven-dependency-plugin-3.2.0...maven-dependency-plugin-3.3.0">compare view</a></li>
</ul>
</details>
<br />

[![Dependabot compatibility score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=org.apache.maven.plugins:maven-dependency-plugin&package-manager=maven&previous-version=3.2.0&new-version=3.3.0)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
- `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

</details>

Fixes #794

COPYBARA_INTEGRATE_REVIEW=#794 from google:dependabot/maven/org.apache.maven.plugins-maven-dependency-plugin-3.3.0 1ca666e
PiperOrigin-RevId: 466369343
f70db1b

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

google-java-format

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

Using the formatter

from the command-line

Download the formatter and run it with:

java -jar /path/to/google-java-format-${GJF_VERSION?}-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, Android Studio, and other JetBrains IDEs

A google-java-format IntelliJ plugin is 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 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 check the Enable google-java-format checkbox. (A notification will be presented when you first open a project offering to do this for you.)

To enable 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

The latest version of the 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

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 to JEP 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.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

<dependency>
  <groupId>com.google.googlejavaformat</groupId>
  <artifactId>google-java-format</artifactId>
  <version>${google-java-format.version}</version>
</dependency>

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);

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

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.