Issue #18227: added TextBlockGoogleStyleFormatting to check indentation by Anushreebasics · Pull Request #18947 · checkstyle/checkstyle

Anushreebasics · 2026-02-16T17:53:58Z

Core functionality implemented
All translations added (9 languages)
Updated javadoc and metadata
All unit tests passing (17 tests)
All integration tests passing (5 Google tests)
Test input files updated with proper violation markers

Anushreebasics · 2026-02-18T13:21:08Z

@romani please review

vivek-0509 · 2026-02-19T10:24:40Z

@Anushreebasics Please make CI green

Anushreebasics · 2026-02-19T17:49:22Z

@vivek-0509 please review

vivek-0509 · 2026-02-20T08:44:41Z

@Anushreebasics Please ping me once you are done with all the changes, will review after that

Anushreebasics · 2026-02-20T09:19:43Z

@vivek-0509 please. review

vivek-0509

Please revert all the unrelated formatting changes

vivek-0509 · 2026-02-20T10:35:30Z

 * Checks correct format of
- * <a href="https://docs.oracle.com/en/java/javase/17/text-blocks/index.html">Java Text Blocks</a>
+ * <a href="https://docs.oracle.com/en/java/javase/17/text-blocks/index.html">
+ * Java Text Blocks</a>


No formatting changes needed please revert all the unrelated changes

vivek-0509 · 2026-02-20T10:35:54Z

- *    It ensures that the opening and closing text-block quotes ({@code """}) each appear on their
- *    own line, with no other item preceding them.
+ *    It ensures that the opening and closing text-block quotes
+ *    ({@code """}) each appear on their own line, with no other
+ *    item preceding them.


vivek-0509 · 2026-02-20T10:36:40Z

 @StatelessCheck
-public class TextBlockGoogleStyleFormattingCheck extends AbstractCheck {
+public final class TextBlockGoogleStyleFormattingCheck
+        extends AbstractCheck {


revert this align them on the single line as before

vivek-0509 · 2026-02-20T10:38:09Z

+    /**
+     * A key is pointing to the warning message text in
+     * "messages.properties" file.
+     */
+    public static final String MSG_OPEN_QUOTES_ERROR =
+            "textblock.format.open";


keep everything on one line it will not trigger line length violation

vivek-0509 · 2026-02-20T11:07:51Z

+        ast.setLineNo(lineNo);
+        ast.setColumnNo(columnNo);
+        return ast;
+    }


Please use log(int lineNo, int colNo, String key, Object... args) from AbstractCheck instead of creating synthetic DetailAstImpl nodes. This method exists exactly for cases where there is no real AST node at the violation location.

I tried [AbstractCheck.log(int, int, String, Object...)], but CI fails because this signature is explicitly forbidden by [signatures.txt:4] and enforced in [pom.xml:2071-2079]. I switched to [log(DetailAST, ...)] with a synthetic node to preserve exact line/column and pass project policy. is this okay?

@romani we need your guidance here
we need to report violations on individual text block content lines. However, TEXT_BLOCK_CONTENT is a single AST node, there is no AST node per content line.

Since log(int lineNo, int colNo, String key, Object... args) is forbidden, I was thinking we log the violation on the TEXT_BLOCK_LITERAL_BEGIN node and mention the exact line number in the violation message

Line {0} has wrong indentation level {1}, each line in text block should be indented at least as much as the opening quotes.

Other option we have is to add this check to the forbiddenapis excludes in pom.xml and use log(int lineNo, int colNo, String key, Object... args) for exact line/column reporting? I see other checks with similar cases are already excluded which have the same case, no AST at the violation location.

What is your opinion on this?

@romani please guide

@vivek-0509 how should I proceed?

@Anushreebasics we need @romani opinion on this to avoid multiple iterations, but as we see there are large number of PRs coming so the reviews will be slightly delayed, we should wait
i am leaning towards below mentioned approach

Since log(int lineNo, int colNo, String key, Object... args) is forbidden, I was thinking we log the violation on the TEXT_BLOCK_LITERAL_BEGIN node and mention the exact line number in the violation message

vivek-0509 · 2026-02-20T11:16:06Z


+  <file name="TextBlockGoogleStyleFormattingCheck">
+    <allow class="com.puppycrawl.tools.checkstyle.DetailAstImpl"/>
+    <allow class="com.puppycrawl.tools.checkstyle.StatelessCheck"/>
+    <allow class="com.puppycrawl.tools.checkstyle.utils.TokenUtil"/>
+  </file>
+


Not needed please revert

Anushreebasics · 2026-02-21T09:20:03Z

@vivek-0509 please review

vivek-0509

@Anushreebasics Please revert all unrelated formatting changes, including the ones I mentioned below. There are several others as well, so kindly revert those too.

vivek-0509 · 2026-02-21T12:57:02Z

            if (parent.getType() == TokenTypes.METHOD_DEF) {
-                quotesAreNotPreceded = !quotesArePrecededWithComma(openingQuotes);
+                quotesAreNotPreceded = !quotesArePrecededWithComma(
+                        openingQuotes);
            }


revert this

vivek-0509 · 2026-02-21T12:57:19Z

    /**
-     * Determines if the Closing quotes of text block are not preceded by any code.
+     * Determines if the Closing quotes of text block are not preceded
+     * by any code.


this also and many more

DakshRJain737 · 2026-03-04T11:13:19Z

@Anushreebasics already one PR of mine was open. I am sorry that you had to work one this but my PR is done. Sorry that is didnt say you before that I was already continuing this issue.

Anushreebasics · 2026-03-04T15:32:34Z

@DakshRJain737, I have been working on this for a long time

DakshRJain737 · 2026-03-04T16:37:05Z

I am really sorry 😞 for that. But my PR was open since December. I left it on Jan 18th because of my university exams.

romani

items:

romani · 2026-04-19T19:28:46Z

-textblock.format.close=Tekstilohkon lopetuslainausmerkkien (""") on oltava uudella rivill�.
-textblock.format.open=Tekstilohkon aloituslainausmerkkien (""") on oltava uudella rivill�.
-textblock.vertically.unaligned=Tekstilohkon lainausmerkit eiv�t ole pystysuorassa linjassa.
+textblock.format.close=Tekstilohkon lopetuslainausmerkkien (""") on oltava uudella rivill�.
+textblock.format.open=Tekstilohkon aloituslainausmerkkien (""") on oltava uudella rivill�.
+textblock.line.indentation=Tekstilohkon jokaisen rivin tulee olla sisennetty vähintään yhtä paljon kuin avaavat ja sulkevat lainausmerkit.


I do not see why such lines are changes, please try to make diff only to add single line, as you do in other files.

I have not changed line 61 and line 62

romani · 2026-04-19T19:29:31Z

+        final DetailAstImpl content = new DetailAstImpl();
+        content.setText("");
+        final DetailAstImpl closingQuotes = new DetailAstImpl();
+        content.setNextSibling(closingQuotes);


all test should be done by verifyWithInlineConfigParser.

romani · 2026-04-19T19:31:12Z

   &lt;/li&gt;
+   &lt;li&gt;
+    Each line in the text-block is indented at least as much as
+    the opening and closing quotes.


please add new Example to show validation in action.
code with violation
very similar code without violation
code with violation
very similar code without violation

…dentation checks

Anushreebasics force-pushed the textblock branch 8 times, most recently from bc579ca to c392caf Compare February 18, 2026 13:16

Anushreebasics force-pushed the textblock branch 7 times, most recently from e4ebb3a to 2020456 Compare February 19, 2026 17:30

Anushreebasics force-pushed the textblock branch 5 times, most recently from a64857d to 0a271d4 Compare February 20, 2026 08:42

vivek-0509 suggested changes Feb 20, 2026

View reviewed changes

Anushreebasics force-pushed the textblock branch 3 times, most recently from 06eff46 to 48bcb55 Compare February 20, 2026 16:57

Anushreebasics force-pushed the textblock branch from 48bcb55 to 4ffbf28 Compare February 20, 2026 17:06

vivek-0509 reviewed Feb 21, 2026

View reviewed changes

vivek-0509 mentioned this pull request Feb 23, 2026

Issue #18227: Adding TextBlockGoogleStyleFormattingCheck inside string #18956

Closed

Anushreebasics force-pushed the textblock branch 2 times, most recently from 2ab7ad7 to 3be8b3b Compare March 3, 2026 05:12

romani requested changes Apr 19, 2026

View reviewed changes

Anushreebasics force-pushed the textblock branch 15 times, most recently from 4d23b87 to b603562 Compare April 20, 2026 16:46

Issue checkstyle#18227: Extend TextBlockGoogleStyleFormatting line in…

3936065

…dentation checks

Anushreebasics force-pushed the textblock branch from b603562 to 3936065 Compare April 20, 2026 17:05

Uh oh!

Conversation

Anushreebasics commented Feb 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Anushreebasics commented Feb 18, 2026

Uh oh!

vivek-0509 commented Feb 19, 2026

Uh oh!

Anushreebasics commented Feb 19, 2026

Uh oh!

vivek-0509 commented Feb 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Anushreebasics commented Feb 20, 2026

Uh oh!

vivek-0509 left a comment

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!

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!

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!

Choose a reason for hiding this comment

Uh oh!

Anushreebasics Feb 20, 2026 • 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!

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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Anushreebasics commented Feb 21, 2026

Uh oh!

vivek-0509 left a comment • 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!

Choose a reason for hiding this comment

Uh oh!

DakshRJain737 commented Mar 4, 2026

Uh oh!

Anushreebasics commented Mar 4, 2026

Uh oh!

DakshRJain737 commented Mar 4, 2026

Uh oh!

romani left a comment

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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Anushreebasics commented Feb 16, 2026 •

edited

Loading

vivek-0509 commented Feb 20, 2026 •

edited

Loading

Anushreebasics Feb 20, 2026 •

edited

Loading

vivek-0509 left a comment •

edited

Loading