Issue #11867: Suppress Line-Length violations for text-block content #17666

mohitsatr · 2025-08-21T07:15:23Z

resolves #11867

Diff Regression config: https://gist.githubusercontent.com/mohitsatr/2f62c8fabd1ea8fbc7ceaf6f8b4d19b5/raw/6281804ddac26777baac8e4fef9eef76aa076a82/master_linelength.xml
Diff Regression patch config: https://gist.githubusercontent.com/mohitsatr/f4bc1e92062712f41048c8282e8e283c/raw/1f9b1df02f6be4017d7b3909c41c70676a9bea3c/patch_linelength.xml

mohitsatr · 2025-08-21T07:21:35Z

src/main/resources/google_checks.xml

-
+  <module name="SuppressWithPlainTextCommentFilter">
+    <property name="checkFormat" value="LineLength"/>
+    <property name="offCommentFormat" value='^.*"""$'/>


this regex doesn't match if the opening quotes have trailing whitespace

it's a very rare case but it can cause false-positive

try ^.*"""\s*$ and """\s*$. I shallow tested it and it was working fine, but still not sure about it.

mohitsatr · 2025-08-21T07:21:45Z

src/main/resources/google_checks.xml

+  <module name="SuppressWithPlainTextCommentFilter">
+    <property name="checkFormat" value="LineLength"/>
+    <property name="offCommentFormat" value='^.*"""$'/>
+    <property name="onCommentFormat" value='^\s*"""\s*(?:[,;]|.+)$'/>


The regex doesn't match when the closing quotes are followed by characters.

try this regex: """(?=\s*[,;+]), again not sure if this will work perfectly or not. We will need to generate diff reports to find out.

This will not do.

I tried bunch of patterns, but it keep missing cases and becoming more difficult to understand.
if we create regex to catch the following cases, it starts catching the opening quotes too.

testing""" testing """ + testing """,

I don't think regex would be up for the job to catch such edge cases.
I did not see any case where text block content was followed by closing quotes. maybe we should not worry about such cases.
@romani wdyt?

sorry for the late response,

Yup it is catching opening quotes too:

I think achieving this solely by regex is not possible, or too difficult. Maybe we can modify the check itself, add opening quotes token and closing quotes tokens support and introduce a new property called ignoreTextBlocks. If enabled, it'll ignore the text block's content. And I think it should be very easy to implement too.

@romani please give your opinion.

supprssions are always prone to not cover edge cases. Please put most of them to sample to show trasparently that we discovered them but no way to handle them now, and issue is created.
One day some other random hacker from web will improve.

so should we modify the check or not?

No, check is general and not java specific.

For all edge cases we need we need to create new Check , something like JavaLineLengh that can allow violations under some tokens.
Such new Check might be javadoc too, to allow allowances under some javadoc specific tokens.

issue created #17707

mohitsatr · 2025-08-21T07:31:48Z

Github, generate report

github-actions · 2025-08-21T07:50:59Z

https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/edc5b0a_2025075024/reports/diff/index.html

Zopsss · 2025-08-21T16:41:05Z

...m/google/checkstyle/test/chapter4formatting/rule44columnlimit/InputTextBlockColumnLimit.java

+    String textblock4 =
+            """
+            Contrary to popular belief, Lorem Ipsum is not simply random text. It has roots in a piece of classical Latin literature from 45 BC, making it over 2000 years old. Richard McClintock, a Latin professor at Hampden-Sydney College in Virginia, looked up one of the more obscure Latin words, consectetur, from a Lorem Ipsum passage, and going through the cites of the word in classical literature, discovered the undoubtable source. Lorem Ipsum comes from sections 1.10.32 and 1.10.33 of "de Finibus Bonorum et Malorum" (The Extremes of Good and Evil) by Cicero, written in 45 BC. This book is a treatise on the theory of ethics, very popular during the Renaissance. The first line of Lorem Ipsum, "Lorem ipsum dolor sit amet..", comes from a line in section 1.10.32.
+            """ + getSampleTest();


please also add a case where closing quotes are followed by some string.

Zopsss · 2025-08-21T17:33:03Z

src/site/xdoc/filters/suppresswithplaintextcommentfilter.xml.template

+          <li>
+            <a href="https://github.com/search?q=path%3Asrc%2Fmain%2Fresources%20path%3A**%2Fgoogle_checks.xml+repo%3Acheckstyle%2Fcheckstyle+SuppressWithPlainTextCommentFilter">
+            Google Style</a>
+          </li>


we need to add documentation of using this suppression in google_style.xml

done.
also updated the docs #17706

romani

items:

romani · 2025-08-28T12:37:39Z

...checkstyle/test/chapter4formatting/rule44columnlimit/InputFormattedTextBlockColumnLimit.java

+
+    String textblock2 =
+        """
+        Contrary to popular belief, Lorem Ipsum is not simply random text. It has roots in a piece of classical Latin literature from 45 BC, making it over 2000 years old. Richard McClintock, a Latin professor at Hampden-Sydney College in Virginia, looked up one of the more obscure Latin words, consectetur, from a Lorem Ipsum passage, and going through the cites of the word in classical literature, discovered the undoubtable source. Lorem Ipsum comes from sections 1.10.32 and 1.10.33 of "de Finibus Bonorum et Malorum" (The Extremes of Good and Evil) by Cicero, written in 45 BC. This book is a treatise on the theory of ethics, very popular during the Renaissance. The first line of Lorem Ipsum, "Lorem ipsum dolor sit amet..", comes from a line in section 1.10.32.


we do not need insanely long text, please shorten it to be slightly but visually catch-able above limit

mohitsatr · 2025-08-29T12:39:28Z

why build errors?

[ERROR] [checkstyle] [ERROR] /home/circleci/project/src/it/resources/com/google/checkstyle/test/chapter4formatting/rule44columnlimit/InputColumnLimitEdgeCase.java:7: Line should not be longer than 100 symbols [lineLength]
[ERROR] [checkstyle] [ERROR] /home/circleci/project/src/it/resources/com/google/checkstyle/test/chapter4formatting/rule44columnlimit/InputColumnLimitEdgeCase.java:12: Line should not be longer than 100 symbols [lineLength]
[ERROR] [checkstyle] [ERROR] /home/circleci/project/src/it/resources/com/google/checkstyle/test/chapter4formatting/rule44columnlimit/InputColumnLimitEdgeCase.java:18: Line should not be longer than 100 symbols [lineLength]
[ERROR] [checkstyle] [ERROR] /home/circleci/project/src/it/resources/com/google/checkstyle/test/chapter4formatting/rule44columnlimit/InputFormattedColumnLimitEdgeCase.java:12: Line should not be longer than 100 symbols [lineLength]
[ERROR] [checkstyle] [ERROR] /home/circleci/project/src/it/resources/com/google/checkstyle/test/chapter4formatting/rule44columnlimit/InputFormattedColumnLimitEdgeCase.java:18: Line should not be longer than 100 symbols [lineLength]

romani · 2025-08-29T12:49:39Z

put whole folder rule44columnlimit to

checkstyle/config/checkstyle-non-main-files-suppressions.xml

Lines 67 to 69 in 1e22276

    
           <!-- test resources are weird by design, no validations in them --> 
        
           <suppress id="lineLength" 
        
                  files="src[\\/]it[\\/]resources[\\/].*[\\/]Input.*ColumnLimit\.java"/>

this Check is by design needs violation here.
All other Inputs be validated to not be wild for no reason.

…k content

romani

Items

src/test/java/com/puppycrawl/tools/checkstyle/internal/XdocsPagesTest.java

romani

ok to merge.

mohitsatr commented Aug 21, 2025

View reviewed changes

Zopsss reviewed Aug 21, 2025

View reviewed changes

romani requested changes Aug 28, 2025

View reviewed changes

mohitsatr mentioned this pull request Aug 29, 2025

New Check: JavaLineLenghSuppress to avoid Line-Length violations for text-block content #17707

Open

mohitsatr force-pushed the supp-linelength branch 2 times, most recently from 481a6f7 to 3155ce5 Compare August 29, 2025 12:33

Issue checkstyle#11867: Suppress Line-Length violations for text-bloc…

7ddea2b

…k content

mohitsatr force-pushed the supp-linelength branch from 3155ce5 to 7ddea2b Compare August 29, 2025 13:41

romani requested changes Aug 30, 2025

View reviewed changes

src/test/java/com/puppycrawl/tools/checkstyle/internal/XdocsPagesTest.java Show resolved Hide resolved

romani approved these changes Sep 7, 2025

View reviewed changes

romani assigned Zopsss Sep 7, 2025

Zopsss approved these changes Sep 7, 2025

View reviewed changes

romani merged commit e81bf10 into checkstyle:master Sep 7, 2025
119 checks passed

mohitsatr deleted the supp-linelength branch September 8, 2025 05:09

Uh oh!

Issue #11867: Suppress Line-Length violations for text-block content #17666

Issue #11867: Suppress Line-Length violations for text-block content #17666

Uh oh!

Conversation

mohitsatr commented Aug 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Zopsss Aug 21, 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!

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!

mohitsatr Aug 26, 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!

mohitsatr Aug 26, 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!

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!

mohitsatr Aug 29, 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!

mohitsatr commented Aug 21, 2025

Uh oh!

github-actions bot commented Aug 21, 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!

mohitsatr Aug 29, 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!

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!

mohitsatr commented Aug 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

romani commented Aug 29, 2025

Uh oh!

romani left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

romani left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mohitsatr commented Aug 21, 2025 •

edited

Loading

Zopsss Aug 21, 2025 •

edited

Loading

mohitsatr Aug 26, 2025 •

edited

Loading

mohitsatr Aug 26, 2025 •

edited

Loading

mohitsatr Aug 29, 2025 •

edited

Loading

mohitsatr Aug 29, 2025 •

edited

Loading

mohitsatr commented Aug 29, 2025 •

edited

Loading