[#864] Undid Constant Name Rule In Checkstyles XML and Applied Formatting/Changes to HIRS_UTILS #865
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…le. Applied checkstyle changes to entire HIRS_UTILS module
ThatSilentCoder
changed the title
ThatSilentCoder
commented
Oct 31, 2024
| @@ -78,83 +78,83 @@ public final class SwidTagConstants { | |||
| public static final String FX_SEPARATOR = ":"; | |||
| public static final String RFC3852_PFX = "rcf3852"; | |||
| public static final String RFC3339_PFX = "rcf3339"; | |||
| public static final String _COLLOQUIAL_VERSION_STR = N8060_PFX + FX_SEPARATOR | |||
| public static final String COLLOQUIAL_VERSION_STR = N8060_PFX + FX_SEPARATOR | |||
There was a problem hiding this comment.
This was the only file that failed the checkstyle guidelines (after I changed the constant name module)
ThatSilentCoder
changed the title
chubtub
reviewed
Nov 1, 2024
Yes, that is supposed to happen. When you run the check command on the HIRS_UTILS module, there should be no checkstyle warnings. Because none of the other PR's for checkstyle warnings have been merged into main as of yet, you are still going to get checkstyle warnings for all the other modules when you try to build the entire application. |
chubtub
approved these changes
Nov 4, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
I recently modified one of the modules in checkstyles.xml to ignore checks for Java constants that begin with an underscore. However, after further research and discussions with my colleagues, I believe we should revert this rule and instead update the Java constants to align with recommended Java guidelines. This change will help maintain code consistency and adherence to best practices. Apply the new changes to the entire HIRS_UTILS module.
Other Changes You Might Have Noticed:
Asides from undoing one of the checkstyle modules in the checkstyles.xml file, I also "lombok-ed" a lot of java files in the UTILS files and a good portion of the files in the HIRS_UTILS module were formatted according to checkstyles guidelines.
Test Instructions:
./gradlew clean HIRS_UTILS:check --rerun-tasksin your terminal window to verify there are no checkstyle errors../gradlew clean build --rerun-tasksin your terminal window to verify there are no build errors.Issues this PR addresses:
Closes issue #864