Issue #18494: Add GoogleNonConstantFieldNameCheck for Google Java Style compliance by vivek-0509 · Pull Request #18657 · checkstyle/checkstyle

Diff report is very huge hard to get actual diff.
Please generate report in comparison to old module that covered this to catch actual diff. Messages likely should be overriden to be same to avoid diff in wording to be a reason of diff.

vivek-0509 · 2026-01-16T06:09:36Z

GitHub, generate report

github-actions · 2026-01-16T06:52:36Z

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

vivek-0509 · 2026-01-16T08:16:18Z

Hi @romani , I have generated a comparison diff report. I have overridden the messages to be identical. Here is the report https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/649199d_2026065114/reports/diff/index.html. Please let me know if I have understood your request correctly or if any changes are needed.

romani · 2026-01-16T13:37:40Z

diff is still wild.
please give same id to both Checks to try avoid diff detection that is purely due to name of Check.

vivek-0509 · 2026-01-16T14:17:49Z

GitHub, generate report

github-actions · 2026-01-16T15:12:14Z

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

vivek-0509 · 2026-01-16T16:11:07Z

@romani I updated the configurations to use the same id for both checks, but they still appear as Red/Green pairs. It seems the report tool uses the full Check class name for the rule name, so MemberName and GoogleMemberName are treated as different rules despite the shared ID. Am I missing something?

vivek-0509 · 2026-01-16T23:46:42Z

@romani
I was investigating the report generation tool and i find that currently, the diff report compares violations using the full source string in
https://github.com/checkstyle/contribution/blob/4ac81f9f9928d695869b93c568fced0d98a1e781/patch-diff-report-tool/src/main/java/com/github/checkstyle/data/CheckstyleRecord.java#L249-L252

When an explicit id is set in the config, the ID is appended to the class name in the format ClassName#id (e.g., MemberNameCheck#GoogleMemberNameDiff). This means when two different checks share the same id, their source strings still differ because of the class name prefix (e.g., MemberNameCheck#GoogleMemberNameDiff vs GoogleMemberNameCheck#GoogleMemberNameDiff). As a result, violations with identical line, column, severity, and message are incorrectly reported as "removed" from base and "added" in patch.

the fix can be that, If source contains # (indicating an explicit module ID was set), compare only the portion after # instead of the full string. This would allow proper matching of violations from different checks that share the same ID, and the diff report would show only true behavioral differences.

romani · 2026-01-17T05:39:54Z

tools is right, we tried to hack it, but tool is right in it behavior to show diff.

romani · 2026-01-17T05:49:19Z

so, we can look at diff and see why we have more violations that it used to be.

https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/649199d_2026150917/reports/diff/elasticsearch/index.html#A1
is good example, previosly we did not do violation, now we do.
https://google.github.io/styleguide/javaguide.html#s5.2.4-constant-names

google state that type immutability if critical point in decision. Checkstyle is not type aware, we can not make decision if it is immutable or not. So better to not give violation.
False positive will make users be frustrated, as it will block them, but false-negative (absence of violation) will not make users angry.

vivek-0509 · 2026-01-17T08:15:54Z

Understood, will change the scope to skip all static fields and update the issue accordingly.

vivek-0509 · 2026-01-17T10:13:31Z

GitHub, generate report

github-actions · 2026-01-17T11:01:11Z

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

vivek-0509 · 2026-01-17T11:19:48Z

@romani updated the scope for the check to skip static member names
here is the report the false negatives are now getting correcty flagged below are some examples from the report
https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/f342244_2026110001/reports/diff/openjdk25/index.html#A15156

https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/f342244_2026110001/reports/diff/openjdk25/index.html#A33718

https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/f342244_2026110001/reports/diff/nbia-dcm4che-tools/index.html#A9

romani

items:

vivek-0509 · 2026-02-13T17:58:59Z

@Zopsss
https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/60f0289_2026020714/reports/diff/openjdk25/index.html#A493
one example of such new file which was not there in the old report

vivek-0509 · 2026-02-13T18:08:37Z

TestPhaseIRMatching.java
https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/60f0289_2026020714/reports/diff/openjdk25/index.html#A15910
Also, this file shows an increased number of violations. We can see that even the old violations now appear on different line numbers, which indicates that the file was modified between the generation of the old and the new reports. so we catched more vioaltions that the new changes in TestPhaseIRMatching.java have introduced

In Old report

In New report

Zopsss

Really sorry for all the delays, everything looks fine now. Thanks a lot for all the hardwork!!!!

vivek-0509 · 2026-02-16T05:00:58Z

@Zopsss Thankyou very much for reviewing

vivek-0509 · 2026-02-16T19:57:09Z

@romani PR is waiting for your approval.

vivek-0509 · 2026-02-16T20:13:10Z

GitHub, generate report

vivek-0509 · 2026-02-16T20:13:22Z

GitHub, generate website

github-actions · 2026-02-16T20:24:12Z

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

https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/60f0289_20260216202150/checks.html#Standard_Checks

https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/60f0289_20260216202150/checks/naming/googlenonconstantfieldname.html#

https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/60f0289_20260216202150/checks/naming/index.html#Naming_Conventions_Checks

github-actions · 2026-02-16T21:03:49Z

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

vivek-0509 · 2026-02-24T13:41:39Z

@romani Let me know if any changes are needed ...

romani

items:

romani · 2026-02-25T13:16:26Z

+     * @return true if this variable should be checked
+     */
+    private static boolean shouldCheckFieldName(DetailAST ast) {
+        final DetailAST modifiersAST = NullUtil.notNull(ast.findFirstToken(TokenTypes.MODIFIERS));


why we think that modifiers always exists?
they defineterly not present always in code, is this our AST feature to have always this node , even it is empty ?

Yes, modifiers is always present in the AST for VARIABLE_DEF nodes, even when no modifiers are explicitly written in code (e.g., int x; still has an empty MODIFIERS node). This is a Checkstyle AST feature. Existing checks like MemberNameCheck, ConstantNameCheck all use ast.findFirstToken(TokenTypes.MODIFIERS) directly without null checks.
https://checkstyle.org/apidocs/com/puppycrawl/tools/checkstyle/api/TokenTypes.html#MODIFIERS

I thinks awesome knowledge, please create special method getModifiers(ast) in this Check and put this init javadoc, eventually this method will be moved to some util, no need to do this now.

vivek-0509 · 2026-02-25T17:54:06Z

GitHub, generate report

vivek-0509 · 2026-02-25T17:54:11Z

GitHub, generate website

github-actions · 2026-02-25T20:38:52Z

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

https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/40d2c54_20260225202921/checks.html#Standard_Checks

https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/40d2c54_20260225202921/checks/naming/googlenonconstantfieldname.html#

https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/40d2c54_20260225202921/checks/naming/index.html#Naming_Conventions_Checks

github-actions · 2026-02-25T21:18:28Z

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

vivek-0509 · 2026-02-25T22:18:03Z

@romani All the changes done PR is ready for review

romani

absolutely last:

romani · 2026-02-26T13:23:46Z

+        final List<String> expectedXpathQueries = List.of(
+            "/COMPILATION_UNIT/CLASS_DEF"
+                + "[./IDENT[@text='InputXpathGoogleNonConstantFieldNameSingleChar']]"
+                + "/OBJBLOCK/VARIABLE_DEF/IDENT[@text='a']"


All 3 examples should be different by Xpath structure.

Please make: as filed of class, as field of inner interface, as filed of inner record or anonymous class.

Used class inside interface for input3 since interface fields are implicitly public static final and can't produce violations and used anonymous class for input3.

romani · 2026-02-26T13:25:22Z

+
+  public final int httpClient = 0;
+  public final int mValue = 0;
+  // violation above, 'avoid single lowercase letter followed by uppercase'


public final int myValue = 0; public final int mValue = 0;

line above shows a suggested fix for line with violation.

romani · 2026-02-26T13:25:44Z

+  private final int f = 0; // violation, 'be at least 2 chars'
+
+  protected final int fooBar1_1 = 0;
+  protected final int foo_bar = 0;


protected final int fooBar = 0; protected final int foo_bar = 0;

apply same for all others.

vivek-0509 · 2026-02-26T15:49:34Z

GitHub, generate website

github-actions · 2026-02-26T16:02:46Z

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

https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/d049a65_20260226155656/checks.html#Standard_Checks

https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/d049a65_20260226155656/checks/naming/googlenonconstantfieldname.html#

https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/d049a65_20260226155656/checks/naming/index.html#Naming_Conventions_Checks

…e Java Style compliance

vivek-0509 · 2026-02-26T16:13:51Z

GitHub, generate website

github-actions · 2026-02-26T16:24:49Z

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

https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/024ed2e_20260226162102/checks.html#Standard_Checks

https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/024ed2e_20260226162102/checks/naming/googlenonconstantfieldname.html#

https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/024ed2e_20260226162102/checks/naming/index.html#Naming_Conventions_Checks

vivek-0509 · 2026-02-26T16:45:31Z

@romani PR is ready for review

romani

Thanks a lot for hard work on this module

Please start activation Google style of it

vivek-0509 marked this pull request as draft January 15, 2026 16:13

vivek-0509 force-pushed the addingNewGoogleMemberNameCheck branch from 2508be9 to 0621ade Compare January 15, 2026 16:39

vivek-0509 marked this pull request as ready for review January 15, 2026 18:10

vivek-0509 changed the title ~~Issue #17842: Add GoogleMemberNameCheck for Google Java Style compliance~~ Issue #18494: Add GoogleMemberNameCheck for Google Java Style compliance Jan 15, 2026

vivek-0509 force-pushed the addingNewGoogleMemberNameCheck branch from 0621ade to 649199d Compare January 15, 2026 20:41

vivek-0509 force-pushed the addingNewGoogleMemberNameCheck branch from 649199d to f342244 Compare January 17, 2026 10:03

romani requested changes Jan 17, 2026

View reviewed changes

Comment thread ...main/java/com/puppycrawl/tools/checkstyle/checks/naming/GoogleNonConstantFieldNameCheck.java

Comment thread src/main/java/com/puppycrawl/tools/checkstyle/checks/naming/GoogleMemberNameCheck.java Outdated

vivek-0509 force-pushed the addingNewGoogleMemberNameCheck branch from f342244 to 4024f27 Compare January 18, 2026 12:19

Zopsss approved these changes Feb 16, 2026

View reviewed changes

romani requested changes Feb 25, 2026

View reviewed changes

vivek-0509 force-pushed the addingNewGoogleMemberNameCheck branch from 60f0289 to 40d2c54 Compare February 25, 2026 17:52

romani requested changes Feb 26, 2026

View reviewed changes

vivek-0509 force-pushed the addingNewGoogleMemberNameCheck branch from 40d2c54 to d049a65 Compare February 26, 2026 15:13

Issue checkstyle#18494: Add GoogleNonConstantFieldNameCheck for Googl…

024ed2e

…e Java Style compliance

vivek-0509 force-pushed the addingNewGoogleMemberNameCheck branch from d049a65 to 024ed2e Compare February 26, 2026 16:13

romani approved these changes Feb 26, 2026

View reviewed changes

romani merged commit 9259fc6 into checkstyle:master Feb 26, 2026
123 checks passed

vivek-0509 mentioned this pull request Feb 27, 2026

Issue #17842: Activate GoogleNonConstantFieldName in google_checks.xml #19043

Merged

romani mentioned this pull request Mar 1, 2026

XpathRegressionXxxxxxXxxxxxTest should have 3 test methods #19064

Closed

Uh oh!

Conversation

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

Uh oh!

Rules Enforced

Scope

Uh oh!

vivek-0509 commented Jan 15, 2026

Uh oh!

vivek-0509 commented Jan 15, 2026

Uh oh!

github-actions Bot commented Jan 15, 2026

Uh oh!

github-actions Bot commented Jan 15, 2026

Uh oh!

vivek-0509 commented Jan 15, 2026

Uh oh!

github-actions Bot commented Jan 15, 2026

Uh oh!

vivek-0509 commented Jan 15, 2026

Uh oh!

romani commented Jan 16, 2026

Uh oh!

vivek-0509 commented Jan 16, 2026

Uh oh!

github-actions Bot commented Jan 16, 2026

Uh oh!

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

Uh oh!

Uh oh!

romani commented Jan 16, 2026

Uh oh!

vivek-0509 commented Jan 16, 2026

Uh oh!

github-actions Bot commented Jan 16, 2026

Uh oh!

vivek-0509 commented Jan 16, 2026

Uh oh!

vivek-0509 commented Jan 16, 2026

Uh oh!

romani commented Jan 17, 2026

Uh oh!

romani commented Jan 17, 2026

Uh oh!

vivek-0509 commented Jan 17, 2026

Uh oh!

vivek-0509 commented Jan 17, 2026

Uh oh!

github-actions Bot commented Jan 17, 2026

Uh oh!

vivek-0509 commented Jan 17, 2026

Uh oh!

romani left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

vivek-0509 commented Feb 13, 2026

Uh oh!

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

Uh oh!

Uh oh!

Zopsss left a comment

Choose a reason for hiding this comment

Uh oh!

vivek-0509 commented Feb 16, 2026

Uh oh!

vivek-0509 commented Feb 16, 2026

Uh oh!

vivek-0509 commented Feb 16, 2026

Uh oh!

vivek-0509 commented Feb 16, 2026

Uh oh!

github-actions Bot commented Feb 16, 2026

Uh oh!

github-actions Bot commented Feb 16, 2026

Uh oh!

vivek-0509 commented Feb 24, 2026

Uh oh!

romani left a comment

vivek-0509 commented Jan 15, 2026 •

edited

Loading

vivek-0509 commented Jan 16, 2026 •

edited

Loading

vivek-0509 commented Feb 13, 2026 •

edited

Loading