google-java-format icon indicating copy to clipboard operation
google-java-format copied to clipboard

Incorrect behaviour on Text-blocks preceded by return

Open mohitsatr opened this issue 6 months ago • 2 comments

https://google.github.io/styleguide/javaguide.html#s4.8.9-text-blocks

The opening """ of a text block is always on a new line. That line may either follow the same indentation rules as other constructs, or it may have no indentation at all (so it starts at the left margin). The closing """ is on a new line with the same indentation as the opening """, and may be followed on the same line by further code

Original code:

$ cat TextBlocks.java
/** some javadoc.  */
public class TextBlocks {

  /** some javadoc. */
  public static String textFun(String[] args) {
                                
    final String simpleScript = """
        s
        """;

    final String simpleScript1 = 
        """
        this is simple test;
        """;

    final String simpleScript2 = 
        """
        this is sample text """; 
        
    return """
        this is sample text 
        """;
  }
}

Output by the formatter:

$ java -jar testing/google-java-format-1.27.0-all-deps.jar TextBlocks.java 
/** some javadoc. */
public class TextBlocks {

  /** some javadoc. */
  public static String textFun(String[] args) {
    final String simpleScript =
        """          // CORRECT BEHAVIOUR
        s
        """;

    final String simpleScript1 =
        """
        this is simple test;
        """;

    final String simpleScript2 =
        """
        this is sample text\
        """;         // CORRECT BEHAVIOUR

    return """       // INCORRECT BEHAVIOUR
    this is sample text
    """;
  }
}

I expected the opening quotations of the text-block after return to be on new line.

mohitsatr avatar Jun 06 '25 03:06 mohitsatr

@mohitsatr , please update issue description to show by CLI what formatter you run.

please add:

return 
        """
        this is sample text 
        """;

to test class to show if formatter is ok with waht style guide consider as expected form of code.

romani avatar Jun 07 '25 15:06 romani

$ java -jar google-java-format-1.32.0-all-deps.jar TextBlocks.java
public class TextBlocks {
  public static String textFun(String[] args) {
    return """
    this is sample text
    """;
  }
}

I agree that's a bug, I think we'd want:

    return
        """
        this is sample text
        """;

The space after return is a bit special to avoid breaks in some other situations, at minimum there should be a continuation indent for the rest of the text block like below, but the general style guide approach with text blocks is to always break before the opening """

    return """
        this is sample text
        """;

cushon avatar Oct 28 '25 19:10 cushon