Add maxLineLength option to googleJavaFormat step (requires gjf 2.0.0+) by xzxiaoshan · Pull Request #3152 · diffplug/spotless

xzxiaoshan · 2026-10-23T09:19:28Z

Summary

Exposes the column-limit setting that google-java-format added via JavaFormatterOptions.Style.builder().maxLineLength(int) (landed in gjf v1.37.0, resolving google/google-java-format#425, open since Dec 2019 — this was previously impossible because the limit was a compile-time-inlined constant, which is why #1563 was closed back in 2023).

Gradle

googleJavaFormat('2.0.0').maxLineLength(120)

Maven

<googleJavaFormat>
    <version>2.0.0</version>
    <maxLineLength>120</maxLineLength>
</googleJavaFormat>

Setting maxLineLength together with an older gjf version fails at configuration time with a clear message (maxLineLength requires google-java-format 2.0.0 or later (you are using 1.37.0)).

Requires gjf 2.0.0

As flagged by @Goooler in this review: google/google-java-format#1477 restored the enum-compatible Style.valueOf(String)/values()/name() methods on the record Style so that callers compiled against the old enum — like this glue — keep working. The stabilized release turned out to be 2.0.0: no 1.38.0 was ever published to Maven Central (the versions jump from 1.37.0 straight to 2.0.0), and 2.0.0 is the bug-fixing major release that makes the configurable Style reliable. Accordingly this PR:

keeps the glue's original Style.valueOf(...) (no spotless-side compatibility shim for the short-lived broken 1.37.0), and
gates maxLineLength on 2.0.0, the first published version that combines a configurable Style with the restored methods.

The reflection for maxLineLength remains necessary because the glue still compiles against the pinned gjf 1.28.0 (needed for the JDK-17 tier; 1.37+ is class-file v65 which JDK 17 cannot even read). Reflection methods are looked up on the public JavaFormatterOptions$Style$Builder type rather than the builder's runtime class — gjf implements the builder via AutoBuilder and the generated class is package-private, which makes builder.getClass().getMethod(...).invoke(...) throw IllegalAccessException.

This branch is merged with latest main (#3157), so it also carries the upstream cleanup option and the default-version bump to 2.0.0; the two options coexist across lib/plugin-gradle/plugin-maven and can be combined (e.g. googleJavaFormat('2.0.0').maxLineLength(120).cleanup(false)).

maxLineLength is part of the step's equality state, so Gradle/Maven correctly re-run when it changes.

Testing

maxLineLengthRequiresVersion2Dot0OrLater (config-time error with a clear message)
All GoogleJavaFormatStepTest cases pass on JDK 21 against the now-default gjf 2.0.0 (including behaviorWithCleanup)
behaviorWithMaxLineLength passes against published gjf 2.0.0
Gradle integration test (googleJavaFormat('2.0.0').maxLineLength(240) → spotlessApply + up-to-date check) passes on JDK 21
Maven integration test (<version>2.0.0</version> + <maxLineLength>240</maxLineLength>) passes on JDK 21
spotlessCheck passes

Expose the column-limit setting that google-java-format 1.37.0 added via JavaFormatterOptions.Style.builder().maxLineLength(int): - Gradle: googleJavaFormat('1.37.0').maxLineLength(240) - Maven: <googleJavaFormat><version>1.37.0</version><maxLineLength>240</maxLineLength></googleJavaFormat> The step rejects maxLineLength with gjf older than 1.37.0 at configuration time with a clear error message. The glue code keeps compiling against gjf 1.28.0 (so older versions and JDK 17 keep working) and calls the 1.37.0 builder API reflectively. google-java-format 1.37.0 turned JavaFormatterOptions.Style from an enum into a record, which removed Style.valueOf(String) and broke the existing glue with a NoSuchMethodError. Style names are now resolved against the GOOGLE/AOSP constants, which exist as static fields in both shapes, so the step works again on 1.37.0+ regardless of maxLineLength. Fixes diffplug#3151

xzxiaoshan · 2026-10-23T09:32:28Z

On the surface this is a fairly ordinary property addition, but it fulfills something the community has been hoping for over the long term — the underlying upstream request (google/google-java-format#425) stayed open for nearly seven years, and the earlier equivalent request here (#1563) was closed back in 2023 as impossible to implement until upstream made the limit configurable. So finally being able to expose it through Spotless is genuinely meaningful for the many developers who'd like a column limit other than 100. If this PR looks good and can be merged, it would be great to see it included in a release relatively soon so users can start taking advantage of it. Thank you very much for maintaining Spotless and for taking the time to review this contribution!
@nedtwigg @Goooler

jawadshaikst

+1, would love to get this merged and released.

Archilobe

This feature is very important, and I hope it can be merged and released as soon as possible.

Goooler · 2026-10-25T02:59:08Z

+	/**
+	 * Parses a style name without calling {@code Style.valueOf}, which existed only while
+	 * {@code Style} was an enum (google-java-format {@literal <=} 1.36); since 1.37 it is a record,
+	 * but the {@code GOOGLE} and {@code AOSP} constants are present in both.
+	 */
+	@Nonnull
+	private static Style toStyle(@Nonnull String style) {
+		switch (Objects.requireNonNull(style)) {
+		case "GOOGLE":
+			return Style.GOOGLE;
+		case "AOSP":
+			return Style.AOSP;
+		default:
+			throw new IllegalArgumentException("style must be GOOGLE or AOSP, but was: " + style);
+		}
+	}


Blocked by google/google-java-format#1477.

xzxiaoshan · 2026-10-26T01:16:07Z

Thanks for the pointer! To make sure I read it right: gjf #1477 (already merged, so it will land in the next gjf release, 1.38.0) restores the enum-compatible Style.valueOf(String)/values()/name() methods precisely so that callers compiled against the old enum — like this glue — keep working, which would also resolve #3126 from the upstream side. Two notes on how this PR interacts with that: toStyle() deliberately resolves names against the GOOGLE/AOSP static constants instead of valueOf(), and those constants exist in every supported version (enum ≤1.36, record 1.37.0, and 1.38+ with #1477), so this PR is forward-compatible with 1.38.0 and is not blocked by it — it also keeps the already-published 1.37.0 usable from Spotless (fixing #3126 for users pinned to it, no need to wait for 1.38). That said, if you would rather standardize on 1.38.0 (gate maxLineLength on it and drop toStyle() in favor of the restored valueOf()), I'm happy to rework the PR that way — just let me know which direction you prefer.

….0 workaround google/google-java-format#1477 (merged, to be released as gjf 1.38.0) restores the enum-compatible Style.valueOf(String)/values()/name() methods on the record Style, so the glue no longer needs toStyle() to parse style names. Revert the glue to Style.valueOf and raise the maxLineLength gate to 1.38.0, the first version that combines a configurable Style with those restored methods. The short-lived 1.37.0 remains unsupported for Spotless, in line with the upstream fix. The behavior tests now target gjf 1.38.0 and will turn green in CI once that version is published.

xzxiaoshan · 2026-10-26T01:27:24Z

Reworked per your feedback in ab9a64d: the glue is back to plain Style.valueOf() (toStyle() is gone), and the maxLineLength gate is raised to 1.38.0, the first version that combines a configurable Style with the enum-compatible methods restored by #1477. The behavior/integration tests now target gjf 1.38.0 and will go green in CI once that version ships. Thanks for the pointer!

Goooler · 2026-10-26T01:59:50Z

Please be paitent for the release of the blocker fix.

jawadshaikst · 2026-10-30T15:00:36Z

Google java format v2.0 is released: https://github.com/google/google-java-format/releases/tag/v2.0.0
includes the fix: google/google-java-format#1477
@xzxiaoshan @Goooler

Goooler · 2026-10-30T23:25:43Z

I see it. This needs to be stacked on #3157.

nedtwigg · 2026-11-01T18:18:12Z

Upstream blocker is merged now, once this PR is merged also I'll cut a release.

…LineLength - resolve conflicts between our maxLineLength option and upstream's cleanup option / google-java-format 2.0.0 default bump so both features coexist across lib, plugin-gradle, and plugin-maven - raise the minimum google-java-format version for maxLineLength from 1.38.0 (never published to Maven Central) to 2.0.0, the bug-fixing major release which stabilized the configurable Style API - update tests, docs, and changelogs accordingly

Goooler · 2026-11-02T03:45:41Z

 ## [Unreleased]
 ### Added
 - Add `cleanup(false)` to `googleJavaFormat()` to disable google-java-format's non-whitespace cleanups. ([#3157](https://github.com/diffplug/spotless/pull/3157))
+- Add `maxLineLength(int)` to `googleJavaFormat()`, which overrides the 100-column limit prescribed by the GOOGLE and AOSP styles. It requires `google-java-format` `2.0.0` or later. ([#3151](https://github.com/diffplug/spotless/issues/3151))


Please refine the changelog items to subject and desc styles.

Co-authored-by: Zongle Wang <wangzongler@gmail.com>

jawadshaikst approved these changes Oct 23, 2026

View reviewed changes

Archilobe approved these changes Oct 24, 2026

View reviewed changes

Goooler reviewed Oct 25, 2026

View reviewed changes

xzxiaoshan requested a review from Goooler October 26, 2026 01:44

This was referenced Oct 26, 2026

build(deps): bump com.google.googlejavaformat:google-java-format from 1.35.0 to 1.37.0 scalar-labs/scalardb-saga#193

Open

Bump com.google.googlejavaformat:google-java-format from 1.35.0 to 1.37.0 scalar-labs/scalardb-postgres-frontend#6

Open

xzxiaoshan changed the title ~~Add maxLineLength option to googleJavaFormat step (requires gjf 1.37.0+)~~ Add maxLineLength option to googleJavaFormat step (requires gjf 2.0.0+) Nov 2, 2026

Goooler reviewed Nov 2, 2026

View reviewed changes

xzxiaoshan and others added 3 commits November 2, 2026 11:53

Update plugin-maven/README.md

7fd0a54

Co-authored-by: Zongle Wang <wangzongler@gmail.com>

Update plugin-gradle/README.md

d1c06e2

Co-authored-by: Zongle Wang <wangzongler@gmail.com>

docs: split maxLineLength changelog entries into subject and desc style

b2cd501

Navigation Menu

Repository navigation

Add maxLineLength option to googleJavaFormat step (requires gjf 2.0.0+) - #3152

Add maxLineLength option to googleJavaFormat step (requires gjf 2.0.0+)#3152
xzxiaoshan wants to merge 6 commits into
diffplug:mainfrom
xzxiaoshan:feat/google-java-format-max-line-length

xzxiaoshan commented Oct 23, 2026 •

edited

Loading

Uh oh!

xzxiaoshan commented Oct 23, 2026

Uh oh!

jawadshaikst left a comment

Uh oh!

Archilobe left a comment

Uh oh!

Goooler Oct 25, 2026

Uh oh!

xzxiaoshan commented Oct 26, 2026

Uh oh!

xzxiaoshan commented Oct 26, 2026

Uh oh!

Goooler commented Oct 26, 2026

Uh oh!

jawadshaikst commented Oct 30, 2026

Uh oh!

Goooler commented Oct 30, 2026

Uh oh!

nedtwigg commented Nov 1, 2026

Uh oh!

Goooler Nov 2, 2026

Uh oh!

Uh oh!

Uh oh!

This branch has not been deployed

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Conversation

xzxiaoshan commented Oct 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Requires gjf 2.0.0

Testing

Uh oh!

xzxiaoshan commented Oct 23, 2026

Uh oh!

jawadshaikst left a comment

Choose a reason for hiding this comment

Uh oh!

Archilobe left a comment

Choose a reason for hiding this comment

Uh oh!

Goooler Oct 25, 2026

Choose a reason for hiding this comment

Uh oh!

xzxiaoshan commented Oct 26, 2026

Uh oh!

xzxiaoshan commented Oct 26, 2026

Uh oh!

Goooler commented Oct 26, 2026

Uh oh!

jawadshaikst commented Oct 30, 2026

Uh oh!

Goooler commented Oct 30, 2026

Uh oh!

nedtwigg commented Nov 1, 2026

Uh oh!

Goooler Nov 2, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

This branch has not been deployed

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

xzxiaoshan commented Oct 23, 2026 •

edited

Loading