About¶

open-java-format is a Java formatter developed in the open. It began as a fork of palantir-java-format, which is itself a fork of google-java-format, and every artifact is now built and published from its own repository. Why the project exists is in the manifesto.

Where it is published¶

The Maven Central artifacts, the Gradle plugins and the files of a GitHub release are built by the release workflow from the tag of the version. The Maven plugin has a repository and a release workflow of its own, openjavaformat/fmt-maven-plugin.

Versions¶

A version is three numbers, <java>.<minor>.<build>, and each one answers a question of its own.

• The first is the Java version the formatter is built for, 21 today. It moves when the minimum Java version moves.
• The second moves with every change to the output: a fix in wrapping or alignment, a new library rule, a new feature. A newer minor version can reformat code that the previous one left alone, so take it with one reformatting run, in a commit of its own.
• The third moves with fixes that leave the output alone: a crash, a regression, an internal bug, a dependency update. A newer build formats every file exactly as the previous one did, so it is safe to take at any time.

The line between the last two numbers is the output, not the kind of change: a fix that changes the output raises the second number, a fix that does not raises the third.

Up to 2.98.0.6 the version was palantir-java-format's with a build number appended: 2.98.0.6 is the sixth build of 2.98.0. Once the bug fixes made the output differ from upstream, that numbering lost its meaning. Migrate lists those fixes.

Verify a download¶

Each file of a GitHub release has a .asc signature next to it, and so does each artifact on Maven Central and the Gradle Plugin Portal. They are made with the project's release key:

13A6 BDF2 DAA9 8D3D 573B  33EA 1004 81FD AEE9 4DE9

The key is published on keys.openpgp.org. Import it once, then check the checksum file of a release, and the checksum file against your download as shown on the Command line page.

curl -sSL https://keys.openpgp.org/vks/v1/by-fingerprint/13A6BDF2DAA98D3D573B33EA100481FDAEE94DE9 | gpg --import
gpg --verify checksums_sha256.txt.asc checksums_sha256.txt

A good signature ends with the fingerprint above. gpg also warns that the key is not certified with a trusted signature, because nobody in your keyring has signed it: compare the fingerprint instead.

Licence¶

open-java-format is distributed under the Apache License 2.0, like palantir-java-format and google-java-format, and it keeps the copyright notices of both. Neither Palantir Technologies Inc. nor Google LLC endorses, sponsors or is affiliated with it.

Take part¶

• Report a bug or propose a change in the issues, where planned work is tracked too.
• Every page of this site has an Edit this page button, which opens a pull request against its sources.