google / google/google-java-format

Incorrect behaviour on Text-blocks preceded by return

Open
#1,258 2 comments 1 reaction 0 assignees View on GitHub
Dominant language
Java
Stars
6.2k
Forks
937
Avg merge
6m
Merged PRs (30d)
3

Description

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:
```java
$ 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
$ 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.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.