Format text blocks + Intellij reflows strings #1419

crogoz · 2025-09-25T11:47:21Z

Before this PR

Text blocks were not formatted.
Intellij would not wrap long strings/would not format textBlocks. Different behaviour when running the formatter via the Intellij plugin vs. the gradle task.

After this PR

Fixes: #930
Fixes: #1331

Text blocks get formatted, by adding the initial """ on the previous line, the text block gets reindented.
Same behaviour between the Intellij plugin & gradle task formatters.

Example of a re-format: https://pl.ntr/2x2
==COMMIT_MSG==
Format text blocks + Intellij reflows strings
==COMMIT_MSG==

Possible downsides?

changelog-app · 2025-09-25T11:47:26Z

Generate changelog in `changelog/@unreleased`

Type (Select exactly one)

Feature (Adding new functionality)
Improvement (Improving existing functionality)
Fix (Fixing an issue with existing functionality)
Break (Creating a new major version by breaking public APIs)
Deprecation (Removing functionality in a non-breaking way)
Migration (Automatically moving data/functionality to a new system)

Description

Format text blocks + Intellij reflows strings

Check the box to generate changelog(s)

Generate changelog entry

crogoz · 2025-09-25T11:52:11Z

palantir-java-format/src/main/java/com/palantir/javaformat/doc/Token.java


    @Override
    protected float computeWidth() {
+        if (token.getTok().getOriginalText().startsWith(StringWrapper.TEXT_BLOCK_DELIMITER)) {


before - when the textBlock+methods would exceed 120 characters (maxWidthLimit), the block would look like this:

""" hello %s this exceeds 120 characters nasddnsadalsdaslda """ .formatted("world");

now:

""" hello %s this exceeds 120 characters nasddnsadalsdaslda """.formatted("world");

crogoz · 2025-09-25T11:58:29Z

palantir-java-format/src/main/java/com/palantir/javaformat/java/FormatFileCallable.java

+                if (!StringWrapper.linesNeedWrapping(options.maxLineLength(), formattedText, characterRanges)) {
+                    return writeFormatReplacements(replacements);
+                }
+                String wrappedFormattedText = StringWrapper.wrap(options.maxLineLength(), formattedText, formatter);


same behaviour now as with the gradle formatter task:

palantir-java-format/gradle-palantir-java-format/src/main/java/com/palantir/javaformat/gradle/spotless/PalantirJavaFormatStep.java

Line 72 in 1cc1160

return memoizedFormatter.get()::formatSourceReflowStringsAndFixImports;

.

The alternative would have been to directly call the same method in the Intellij plugin, however I think this would be a bit more optimal - because when there is no need to call the wrapper, we can simply return just the replacement ranges. Worst case happens here where we have to send back the full document range to be reformatted.

crogoz · 2025-09-25T12:02:22Z

palantir-java-format/src/main/java/com/palantir/javaformat/java/StringWrapper.java

            throws FormatterException {
-        JCTree.JCCompilationUnit unit = parse(input, /* allowStringFolding= */ false);
-        String separator = Newlines.guessLineSeparator(input);
+        return new Reflower(columnLimit, input).getReflowReplacements();


tried to keep this in line with pjf logic - refactored to be similar to pjf - as it easier to compare diffs.

crogoz · 2025-09-25T12:03:26Z

palantir-java-format/src/main/java/com/palantir/javaformat/java/StringWrapper.java

+                String prefix = (lineStartPosition + startColumn + 4 > startPosition ? "" : " ".repeat(4))
+                        + " ".repeat(startColumn);
+
+                StringBuilder output = new StringBuilder(initialLines.get(0));


diverges from gjf to ensure we indent text blocks

crogoz · 2025-09-25T12:04:53Z

palantir-java-format/src/main/java/com/palantir/javaformat/java/StringWrapper.java

+     * column limit or contain text blocks. Used by the Intellij plugin to check if we need to run StringWrapper.wrap.
+     * Keep this method and {@code needWrapping} in line.
+     * */
+    public static boolean linesNeedWrapping(int columnLimit, String input, RangeSet<Integer> initialRangesToChange) {


pjf specific - we need to figure out if we need to wrap the current input in the rangeSet initialRangesToChange

changelog-app · 2025-09-25T12:25:09Z

✅ Successfully generated changelog entry!

What happened?

Your changelog entries have been stored in the database as part of our migration to ChangelogV3.

Need to regenerate?

Simply interact with the changelog bot comment again to regenerate these entries.

crogoz · 2025-09-25T13:53:33Z

palantir-java-format/src/test/resources/com/palantir/javaformat/java/testdata/RSL.output

+            """ + """
+            bar
+            """;
+        String u = stringVariableOne + """


unfortunately string concatenation is not great with text blocks and I am not sure if I can change it.
after running the AST formatter I am getting (The AST cannot change the indentation of the text block node):

String u = stringVariableOne + """ ... """ + stringVariableTwo + """ ... """;

and then after I try to re-indent the text blocks and given that I am trying to indent based on the previous line, I am getting the block below.

For these kind of text block operations, people should try to keep the textBlocks indented at the same line with the rest of the operands and then the block will be properly indented

crogoz · 2025-09-25T15:30:34Z

Depends on palantir/gradle-baseline#3276. Adding do not merge until the previous PR is merged

message · 2025-10-01T09:55:33Z

CRogers · 2025-10-01T13:14:32Z

palantir-java-format/src/main/java/com/palantir/javaformat/java/StringWrapper.java

-            int lineEnd = end;
-            while (Newlines.hasNewlineAt(input, lineEnd) == -1) {
-                lineEnd++;
+        private void indentTextBlocks(TreeRangeMap<Integer, String> replacements, List<Tree> textBlocks) {


In general the changes in this PR look much better! I ran it on gradle-guide here and most of the changes are an improvement imo.

The only weirdness (on this repo at least) is around multiple text block arguments to the same method, example:

refactorFromTo(""" someCode """, """ otherCode """);

I think the second text block is getting indented out of line with the first because the first ending """ has been indented?

You can take this to it's logical extreme:

void lotsOfStringParams(String a, String b, String c, String d, String e, String f, String g) {} void test() { lotsOfStringParams(""" aaa """, """ bbb """, """ ccc """, """ ddd """, """ eee """, """ fff """, """ ggg """); }

Ah, this might be the same as a concatenation issue?

If you force it to put each arg on a new line by making one arg very long, it kinda looks better but stops the """, """ pattern:

void lotsOfStringParams(String a, String aa, String b, String c) {} void test() { lotsOfStringParams( """ aaa """, "sdklfjslfkjsadlkgjsdklfjsadlkfjsaklfjaskdsfkljsaklfjsadflkjsdafkljasdfklsjfklsajflkasjfsfjksflfj", """ bbb """, """ ccc """); }

re: last example with the one long arg
I believe this has to do with how parameters for a method are going to be structured if the maxLineColumn would exceed - same behaviour if we had long variable names/long annotated variables.

void test( String aaaaaaaaaa, @NotNull @Variable Ssdklfjslfkjsdasdadasasdsadsadasdasadadasddadsasdsadadasdadadasdas variable, String bbbbbb) { lotsOfStringParams( aaaaaaaaaa, sdklfjslfkjsdasdadasasdsadsadasdasadadasddadsasdsadadasdadadasdasadadasdasfasfasfasfas, bbbbbb); }

crogoz added 14 commits September 10, 2025 16:31

indentation is wrong, but consistent

6743e8e

changed indentation

95c4ee5

.

fd96d13

kep pjf wrapper

23c91f9

.

96d304a

.

aa324c8

fix textBlock indentation

11d0c00

wip

043db14

fix text block

8063b4d

intellij runs wrapper

19e6298

reachability metadata

2730c64

cleanup

946543a

cleanup

c618730

text

87f1e1d

crogoz commented Sep 25, 2025

View reviewed changes

crogoz mentioned this pull request Sep 25, 2025

Do not flag textBlock lineLength palantir/gradle-baseline#3276

Merged

crogoz added the do not merge label Sep 25, 2025

CRogers reviewed Oct 1, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Format text blocks + Intellij reflows strings #1419

Format text blocks + Intellij reflows strings #1419

crogoz commented Sep 25, 2025 •

edited

Loading

Uh oh!

changelog-app bot commented Sep 25, 2025 •

edited by crogoz

Loading

Uh oh!

crogoz Sep 25, 2025

Uh oh!

crogoz Sep 25, 2025

Uh oh!

crogoz Sep 25, 2025

Uh oh!

crogoz Sep 25, 2025 •

edited

Loading

Uh oh!

crogoz Sep 25, 2025

Uh oh!

changelog-app bot commented Sep 25, 2025

Uh oh!

crogoz Sep 25, 2025

Uh oh!

crogoz commented Sep 25, 2025

Uh oh!

message commented Oct 1, 2025

Uh oh!

CRogers Oct 1, 2025

Uh oh!

CRogers Oct 1, 2025

Uh oh!

CRogers Oct 1, 2025

Uh oh!

crogoz Oct 3, 2025 •

edited

Loading

Uh oh!

Uh oh!

Format text blocks + Intellij reflows strings #1419

Are you sure you want to change the base?

Format text blocks + Intellij reflows strings #1419

Conversation

crogoz commented Sep 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Before this PR

After this PR

Possible downsides?

Uh oh!

changelog-app bot commented Sep 25, 2025 • edited by crogoz Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Generate changelog in changelog/@unreleased

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

crogoz Sep 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

changelog-app bot commented Sep 25, 2025

✅ Successfully generated changelog entry!

What happened?

Need to regenerate?

Uh oh!

Choose a reason for hiding this comment

Uh oh!

crogoz commented Sep 25, 2025

Uh oh!

message commented Oct 1, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

crogoz Oct 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

crogoz commented Sep 25, 2025 •

edited

Loading

changelog-app bot commented Sep 25, 2025 •

edited by crogoz

Loading

Generate changelog in `changelog/@unreleased`

crogoz Sep 25, 2025 •

edited

Loading

crogoz Oct 3, 2025 •

edited

Loading