Issue #16836: New Check HexLiteralCase #17233

zyadahmed · 2025-06-16T18:14:47Z

Issue: #16836
New HexLiteralCase check that verifies hexadecimal number literals contain only uppercase letters (A–F). If any lowercase letters are found, a violation is raised with the message: Should use uppercase hexadecimal digit instead of ''{0}'' where {0} is replaced with that violated digits.

New module config:
https://gist.githubusercontent.com/zyadahmed/8e0dfa0fc6f3a178fa0c18f3f7fac452/raw/77a0d5b0cfa7c9c965eadbbea5d0fb0d873090b9/gistfile1.txt

Contribution PR link: checkstyle/contribution#950

romani

thanks a lot,

Please read and watch videos at Starting_Development.
Please make CI green. There are videos on CI handling.

items:

...esources/com/puppycrawl/tools/checkstyle/checks/hexliteralcase/InputHexLiteralCaseCheck.java

src/main/resources/com/puppycrawl/tools/checkstyle/checks/messages_ru.properties

src/main/java/com/puppycrawl/tools/checkstyle/checks/HexLiteralCaseCheck.java

src/site/xdoc/checks/misc/hexliteralcase.xml

romani · 2025-06-25T00:00:03Z

All CIs should be green.
Please reply "done" to each comment as you finished addressing it

zyadahmed · 2025-06-25T22:50:07Z

All CIs should be green. Please reply "done" to each comment as you finished addressing it

for the ci/semaphore created pr in checkstyle/contribution and added the pr link in description is that the correct way or am i missing something ?

romani · 2025-06-27T01:49:46Z

This single failure is expected for new Check.
This is unfortunate until we fix #7304

romani · 2025-06-27T01:56:56Z

Please move to next phase, testing on real sources.

Please review #16946 , as example of how user put config in description of PR, and triggered execution by comment #16946 (comment)

romani

Items

romani · 2025-06-27T03:42:47Z

src/main/java/com/puppycrawl/tools/checkstyle/checks/HexLiteralCaseCheck.java

+ * <div>Checks that hexadecimal literals are defined using uppercase letters {@code (A-F)}
+ * rather than lowercase {@code (a-f)}. This follows the
+ * <a href="https://cr.openjdk.org/~alundblad/styleguide/index-v6.html#toc-literals">
+ * OpenJDK Style Guide</a>.


We can not rely on link for description.
It might be broken soon, we need to copy all details on how bit work to Check description

romani · 2025-06-27T03:45:01Z

src/test/java/com/puppycrawl/tools/checkstyle/checks/HexLiteralCaseCheckTest.java

+
+    @Test
+    public void testCheck()
+            throws Exception {


Move this method to the end of class , to group together technical coverage of token method

romani · 2025-06-27T03:47:04Z

...esources/com/puppycrawl/tools/checkstyle/checks/hexliteralcase/InputHexLiteralCaseCheck.java

+    int a = 0xABC;
+    int k = 0XCAFEBAB1;
+    long d = 0Xf123L; // violation  'Should use uppercase hexadecimal letters.'
+    int binaryValue = 0b1010;


For each line with violation please add kind of same line but without violation, that would be result of what vis expected refactoring from violated

romani · 2025-06-27T03:47:42Z

...esources/com/puppycrawl/tools/checkstyle/checks/hexliteralcase/InputHexLiteralCaseCheck.java

+    int binaryValue = 0b1010;
+    int num = 1;
+
+


Please add way more items to testing

romani · 2025-06-27T03:48:22Z

...xdocs-examples/resources/com/puppycrawl/tools/checkstyle/checks/hexliteralcase/Example1.java

+class Example1 {
+  int a =  0xabc;  // violation  'Should use uppercase hexadecimal letters.'
+  int b = 0xABC;
+  long l = 0Xf123L; // violation  'Should use uppercase hexadecimal letters.'


All from examples guidelines should be as examples in our website

All from issue description, should be in example.

romani · 2025-06-27T03:49:08Z

src/it/java/org/checkstyle/suppressionxpathfilter/XpathRegressionHexLiteralCaseTest.java

+        runVerifications(config, fileProcess, expected, expectedXpathQueries);
+    }
+
+}


Please add one more, we usually ask for 3 tests for xpath

zyadahmed · 2025-06-27T12:35:58Z

github, generate report

zyadahmed · 2025-06-27T13:31:10Z

github, generate report

romani · 2025-06-27T16:13:51Z

You need to put link to config in PR description .
Please read https://github.com/checkstyle/contribution/tree/master/checkstyle-tester#generation-examples
New module config:

zyadahmed · 2025-06-28T21:34:01Z

GitHub, generate report

zyadahmed · 2025-06-28T22:09:25Z

Github, generate report for configs in PR description

github-actions · 2025-06-28T22:11:01Z

Report generation failed. Please check the logs for more details.

Link: https://github.com/checkstyle/checkstyle/actions/runs/15948633638

zyadahmed · 2025-07-18T06:22:51Z

@romani can you help in remaing steps if possible

romani · 2025-07-20T22:36:07Z

you need to create in Gist config file that contains your new Check , and put in PR description after New module config:.
see example at #16489 , #17075
after that triggering report will work.
please rebase on latest code, a lot was changed in last 3 weeks, we are on jdk17 now.

zyadahmed · 2025-09-08T22:27:46Z

@romani hello romani i added Gist config and rebase but it seems something wrong with new jdk version apprecaite your support and sorry for long pr

romani · 2025-09-11T02:20:02Z

[ERROR] XdocsPagesTest.generateXdocContent:283 Â» NullPointer

Please debug this test, it is not a test actually, it is generator of xdoc files. You might need to update your documentation on Check to comply with our new rules on it.
Just look how it is done in sibling checks and in same way

zyadahmed · 2025-09-11T17:41:50Z

Github, generate report

zyadahmed · 2025-09-11T18:05:46Z

Github, generate report for configs in PR description

github-actions · 2025-09-11T18:07:36Z

Report generation failed. Please check the logs for more details.

Link: https://github.com/checkstyle/checkstyle/actions/runs/17653228519

zyadahmed · 2025-09-11T18:22:05Z

Github, generate report

zyadahmed · 2025-09-12T08:14:16Z

Github, generate report

zyadahmed · 2025-09-12T08:16:19Z

GitHub, generate website

github-actions · 2025-09-12T08:19:45Z

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

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

https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/a2eb848_20250912081910/checks/misc/hexliteralcase.html#

https://checkstyle-diff-reports.s3.us-east-2.amazonaws.com/a2eb848_20250912081910/checks/misc/index.html#Miscellaneous_Checks

zyadahmed · 2025-09-12T13:25:49Z

Github, generate report for configs in PR description

github-actions · 2025-09-12T13:33:24Z

Report generation failed. Please check the logs for more details.

Link: https://github.com/checkstyle/checkstyle/actions/runs/17675862817

romani requested changes Jun 22, 2025

View reviewed changes

zyadahmed force-pushed the HexLiteralCase branch 4 times, most recently from 91b3b7a to 6bcc5b5 Compare June 24, 2025 21:24

zyadahmed force-pushed the HexLiteralCase branch from 6bcc5b5 to f692241 Compare June 25, 2025 20:27

zyadahmed mentioned this pull request Jun 25, 2025

Config: New Check HexLiteralCase checkstyle/contribution#950

Open

zyadahmed force-pushed the HexLiteralCase branch 4 times, most recently from d0fe5c9 to 855949d Compare June 25, 2025 22:32

romani requested changes Jun 27, 2025

View reviewed changes

zyadahmed force-pushed the HexLiteralCase branch 2 times, most recently from 39473cd to 647dc3f Compare June 27, 2025 12:10

zyadahmed force-pushed the HexLiteralCase branch from 647dc3f to 1db13d3 Compare June 28, 2025 21:31

zyadahmed force-pushed the HexLiteralCase branch 2 times, most recently from 853e11f to e8c59a9 Compare June 28, 2025 21:46

zyadahmed force-pushed the HexLiteralCase branch from e8c59a9 to 0badf50 Compare September 8, 2025 21:25

zyadahmed force-pushed the HexLiteralCase branch from 0badf50 to 402782a Compare September 8, 2025 22:05

zyadahmed force-pushed the HexLiteralCase branch from 402782a to d7cec49 Compare September 11, 2025 16:32

Issue checkstyle#16836: New Check HexLiteralCase

a2eb848

zyadahmed force-pushed the HexLiteralCase branch from d7cec49 to a2eb848 Compare September 11, 2025 17:09

zyadahmed requested a review from romani September 12, 2025 08:25

Uh oh!

Issue #16836: New Check HexLiteralCase #17233

Are you sure you want to change the base?

Issue #16836: New Check HexLiteralCase #17233

Uh oh!

Conversation

zyadahmed commented Jun 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

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 commented Jun 25, 2025

Uh oh!

zyadahmed commented Jun 25, 2025

Uh oh!

romani commented Jun 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

romani commented Jun 27, 2025

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!

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!

zyadahmed commented Jun 27, 2025

Uh oh!

zyadahmed commented Jun 27, 2025

Uh oh!

romani commented Jun 27, 2025

Uh oh!

zyadahmed commented Jun 28, 2025

Uh oh!

zyadahmed commented Jun 28, 2025

Uh oh!

github-actions bot commented Jun 28, 2025

Uh oh!

zyadahmed commented Jul 18, 2025

Uh oh!

romani commented Jul 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

zyadahmed commented Sep 8, 2025

Uh oh!

romani commented Sep 11, 2025

Uh oh!

zyadahmed commented Sep 11, 2025

Uh oh!

zyadahmed commented Sep 11, 2025

Uh oh!

zyadahmed commented Jun 16, 2025 •

edited

Loading

romani commented Jun 27, 2025 •

edited

Loading

romani commented Jul 20, 2025 •

edited

Loading