Issue #11939: New filter SuppressWithNearbyTextFilter by stoyanK7 · Pull Request #12151 · checkstyle/checkstyle

stoyanK7 · 2022-09-01T18:45:24Z

Resolves #11939

Diff Regression config: https://gist.githubusercontent.com/stoyanK7/c2a70dcd9dfc7ab1e689e54e3feba577/raw/ae91f59f217a8804d7d07cbbcfc7c8383108b490/config.xml
Diff Regression patch config: https://gist.githubusercontent.com/stoyanK7/934c2f859f7f9f97559bb339b3287deb/raw/edcc70b3257675a04e350f7ca8d614bd3c9cee06/config.xml

stoyanK7 · 2022-09-01T18:50:57Z

Github, generate site

github-actions · 2022-09-01T18:52:20Z

Site generation job failed on phase "parse_pr_info", step "React with rocket on run".
Link: https://github.com/checkstyle/checkstyle/actions/runs/2974139316

github-actions · 2022-09-01T18:58:46Z

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

stoyanK7 · 2022-09-04T19:07:44Z

@nrmancuso I think the failing check is not related to my changes, right?

nrmancuso · 2022-09-04T19:59:52Z

@stoyanK7 thanks for bringing this to my attention, inspections failure is not from your changes. I have changed some settings and restarted IDEA inspections. In the future, please put a link to failing build (and maybe snippet of output) in your comment, it will help us to easily help you from mobile.

stoyanK7 · 2022-09-05T12:59:59Z

@romani ping

romani

items:

romani

Items

romani

Items

romani

items:

romani · 2022-09-11T21:57:29Z

Github, generate web site.

romani

items:

stoyanK7 · 2022-09-12T08:17:15Z

Github, generate site

github-actions · 2022-09-12T08:21:26Z

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

stoyanK7 · 2022-09-20T18:13:43Z

@romani is it currently possible we get some traction on this? I am keen on finishing it :)

romani · 2022-09-21T01:31:51Z

Sorry for being slow... You in visible top of my to do list.

romani · 2022-09-23T03:06:09Z

@rnveach , please help to review this PR while I am focusing on yours

rnveach

Also, Checker is failing the CI. Please make it so CI is green.

rnveach · 2022-09-30T14:33:06Z

    </section>

+    <section name="SuppressWithNearbyTextFilter">
+      <p>Since Checkstyle 10.3.4</p>


Since we had a release, this version and others in this PR needs to be updated.

This needs to be updated again.

Leaving this for the end.

rnveach · 2022-09-30T14:48:41Z

+ * &lt;module name=&quot;Checker&quot;&gt;
+ *   &lt;module name=&quot;SuppressWithNearbyTextFilter&quot;&gt;
+ *     &lt;property name=&quot;checkPattern&quot; value=&quot;LineLengthCheck&quot;/&gt;
+ *   &lt;/module&gt;


Can you show me this example in action through the CLI?
To me it looks like you must specify commentFormat as it still has SUPPRESS CHECKSTYLE, also I see other issues with this example.

Another question is, why are we using all Java examples for this? This check is built for other file types since it has no connection to the Java AST. I fine with 1 or 2 Java examples, but there should be more that are non Java and show the user how to configure them.

I fine with 1 or 2 Java examples, but there should be more that are non Java and show the user how to configure them

Valid point, don't know what I was thinking when writing those examples. Will switch them up a bit. Probably with something from the tests but simplified.

Now that you point it out, nearbyTextPattern needs to be set to .* for this to work. This example is completely messed up. It is the second line that should have violation, ugh. I will go trough them carefully now.

stoyan@ZenBook:~/Desktop/checkstyle$ cat config.xml

<?xml version="1.0"?> <!DOCTYPE module PUBLIC "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN" "https://checkstyle.org/dtds/configuration_1_3.dtd"> <module name="Checker"> <module name="SuppressWithNearbyTextFilter"> <property name="checkPattern" value="LineLengthCheck"/> <property name="nearbyTextPattern" value=".*"/> </module> <module name="LineLength"> <property name="max" value="40"/> </module> <module name="TreeWalker"> <module name="ConstantName"/> </module> </module>

stoyan@ZenBook:~/Desktop/checkstyle$ cat Test.java

public final class Test { static final int UPPER_CASE_CONSTANT1234567; static final int lowerCaseConstant3; static final int UPPER_CASE_CONSTANT4567891011; }

stoyan@ZenBook:~/Desktop/checkstyle$ java -jar /media/stoyan/Elements/Open\ Source/checkstyle/target/checkstyle-10.3.5-SNAPSHOT-all.jar -c config.xml Test.java

Starting audit... [ERROR] /home/stoyan/Desktop/checkstyle/Test.java:3:18: Name 'lowerCaseConstant3' must match pattern '^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$'. [ConstantName] Audit done. Checkstyle ends with 1 errors.

Done. Fixed examples and added SQL, XML ones.

romani · 2023-04-01T00:57:24Z

What needs to be done for failing CI?

I am not sure how to fix our CI execution.
It works to validate version to be same as in pom, in pom it is 10.9.4. but we will update it to 10.10.0 after a mere, as this is new module, so we bump second digit, there will be CI failures at GitHub action on release notes. We can not bump pom to 10.10.0 as we confident in version only based on merged changes.

Did we run any regression reports? I am not seeing a link to one.

Please suggest how to do this, it is filter. Both config and code should be updated to make it as diff.

rnveach · 2023-04-01T01:10:27Z

I recommend to create an issue to disable the ci item until after the work is merged if we will not create a fix before it is merged. We are not suppose to merge on a red ci.

For regression, just run a no harm with the filter on a random check. Before is only the check, after is check and filter. Just looking for issues or exceptions. I recommend suppression text be something simple and common that people would use like"ignore this".

romani · 2023-04-01T02:24:14Z

We need to have shell version of code that bump second digit at

checkstyle/.ci/validation.sh

Line 486 in bf9b7b2

CS_RELEASE_VERSION=$(echo "$CS_POM_VERSION" | cut -d '-' -f 1)

and make third digit as 0, and only if pom version is not finished on ".0"

romani · 2023-04-01T13:11:47Z

@rnveach , check-since-version is fixed in separate commit of this PR.
execution on my local:

New Check file: src/main/java/com/puppycrawl/tools/checkstyle/filters/SuppressWithNearbyTextFilter.java
New Check detected: src/main/java/com/puppycrawl/tools/checkstyle/filters/SuppressWithNearbyTextFilter.java
CS Release version: 10.9.4
Next release version is bug fix '10.9.4', we will bump second digit in it
Expected CS Release version after merge of target commit: 10.10.0
Grep for @since 10.10.0
 * @since 10.10.0

romani · 2023-04-01T13:20:54Z

@stoyanK7 , I pushed in your branch, before working on it, please pull from stratch from remote.
please provide regression report as @rnveach suggested.

@rnveach , please continue review, we just need to know that code is ok and you need only report.
After you, we need review from @nrmancuso.

rnveach · 2023-04-01T14:20:15Z

My review is done until regression report is provided.

stoyanK7 · 2023-04-01T17:17:44Z

Github, generate report

github-actions · 2023-04-01T18:45:14Z

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

romani · 2023-04-01T19:28:47Z

@rnveach , report looks good

rnveach · 2023-04-03T13:59:44Z

@stoyanK7 CI is failing. Is pitest fix now going to be in this PR?

stoyanK7 · 2023-04-03T15:00:27Z

@rnveach No, I will move it to a separate issue. Please proceed with the review.

romani · 2023-04-03T15:09:27Z

@stoyanK7 , please restore commit stoyanK7@eb46596 CI must be green to merge

nrmancuso · 2023-04-10T13:34:26Z

Github, generate site

github-actions · 2023-04-10T13:51:44Z

Site generation job failed on phase "generate_site",
step "Set output".
Link: https://github.com/checkstyle/checkstyle/actions/runs/4657917161

stoyanK7 · 2023-04-10T13:52:48Z

Github, generate site

github-actions · 2023-04-10T14:16:00Z

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

https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/4fbd639_2023141423/config_filters.html#SuppressWithNearbyCommentFilter_Parent_Module

nrmancuso

Items:

stoyanK7 · 2023-04-24T07:30:40Z

Github, generate site

github-actions · 2023-04-24T07:36:19Z

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

https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/5c48620_2023073401/config_filters.html#SuppressWithNearbyCommentFilter_Parent_Module

nrmancuso

Let's merge this

stoyanK7 commented Sep 1, 2022

View reviewed changes

Comment thread ...withnearbyplaintextcommentfilter/InputSuppressWithNearbyPlainTextCommentFilterCheckFormat.sh Outdated

stoyanK7 commented Sep 2, 2022

View reviewed changes

Comment thread ...ledeclarationusagedistance/InputVariableDeclarationUsageDistanceCheckSwitchExpressions2.java

stoyanK7 commented Sep 2, 2022

View reviewed changes

Comment thread config/checkstyle_checks.xml Outdated

stoyanK7 commented Sep 2, 2022

View reviewed changes

Comment thread ...n/java/com/puppycrawl/tools/checkstyle/filters/SuppressWithNearbyPlainTextCommentFilter.java Outdated

stoyanK7 marked this pull request as draft September 2, 2022 09:07

stoyanK7 commented Sep 2, 2022

View reviewed changes

Comment thread ...n/java/com/puppycrawl/tools/checkstyle/filters/SuppressWithNearbyPlainTextCommentFilter.java Outdated

stoyanK7 marked this pull request as ready for review September 4, 2022 10:49

romani requested changes Sep 5, 2022

View reviewed changes

romani requested changes Sep 7, 2022

View reviewed changes

stoyanK7 changed the title ~~Issue #11939: New filter SuppressWithNearbyPlainTextCommentFilter~~ Issue #11939: New filter SuppressWithNearbyTextFilter Sep 9, 2022

romani requested changes Sep 9, 2022

View reviewed changes

romani requested changes Sep 11, 2022

View reviewed changes

Comment thread config/checkstyle_checks.xml Outdated

romani requested changes Sep 11, 2022

View reviewed changes

Comment thread ...ytextfilter/InputSuppressWithNearbyTextFilterVariableNearbyTextPatternAndInfluenceFormat.xml Outdated

Comment thread src/xdocs/config_filters.xml Outdated

Comment thread src/xdocs/config_filters.xml Outdated

stoyanK7 commented Sep 12, 2022

View reviewed changes

Comment thread src/main/java/com/puppycrawl/tools/checkstyle/filters/SuppressWithNearbyTextFilter.java Outdated

romani assigned rnveach Sep 23, 2022

romani requested a review from rnveach September 23, 2022 03:05

rnveach suggested changes Sep 30, 2022

View reviewed changes

rnveach suggested changes Oct 1, 2022

View reviewed changes

stoyanK7 mentioned this pull request Apr 3, 2023

Kill surviving mutations in SuppressWithNearbyTextFilter #12952

Closed

rnveach approved these changes Apr 3, 2023

View reviewed changes

rnveach assigned nrmancuso and unassigned rnveach Apr 3, 2023

nrmancuso suggested changes Apr 13, 2023

View reviewed changes

stoyanK7 and others added 2 commits April 23, 2023 14:27

Issue #11939: New filter SuppressWithNearbyTextFilter

279b30c

infra: update check-since-version as it blocked #12151

5c48620

nrmancuso approved these changes Apr 26, 2023

View reviewed changes

nrmancuso merged commit a0df847 into checkstyle:master Apr 26, 2023

nrmancuso mentioned this pull request Apr 26, 2023

New filter: SuppressWithNearbyTextFilter to suppress checks with inline comments in any file type #11939

Closed

stoyanK7 deleted the issue/11939-new-filter-SuppressWithNearbyPlainTextCommentFilter branch April 26, 2023 06:55

romani mentioned this pull request Mar 23, 2025

Issue #12242: expand AuditEvents for fileContent #16505

Open

Uh oh!

Conversation

stoyanK7 commented Sep 1, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

stoyanK7 commented Sep 1, 2022

Uh oh!

github-actions Bot commented Sep 1, 2022

Uh oh!

github-actions Bot commented Sep 1, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

stoyanK7 commented Sep 4, 2022

Uh oh!

nrmancuso commented Sep 4, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

stoyanK7 commented Sep 5, 2022

Uh oh!

romani left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

romani left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

romani left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

romani left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

romani commented Sep 11, 2022

Uh oh!

romani left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

stoyanK7 commented Sep 12, 2022

Uh oh!

github-actions Bot commented Sep 12, 2022

Uh oh!

Uh oh!

stoyanK7 commented Sep 20, 2022

Uh oh!

romani commented Sep 21, 2022

Uh oh!

romani commented Sep 23, 2022

Uh oh!

rnveach left a comment

Choose a reason for hiding this comment

Uh oh!

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!

stoyanK7 commented Sep 1, 2022 •

edited

Loading

nrmancuso commented Sep 4, 2022 •

edited

Loading

romani commented Apr 1, 2023 •

edited

Loading