Refactor code style to adhere to Checkstyle guidelines#3
Merged
Conversation
The executeCommand method in Parser handles user commands by splitting the input string into two parts: the command itself and any additional arguments. Currently, the split operation does not validate that the input string contains at least one element, which could potentially lead to unexpected behaviour or bugs if empty input is passed. To mitigate this, let's add an assert statement to ensure that the inputs array has at least one element. This ensures that the code always receives a valid command to process. In situations where assertions are enabled, this will help catch empty or invalid commands during development and testing. While this doesn't address user input validation directly (since assert can be disabled in production), it adds an extra layer of safety during development. This change also avoids unnecessary array access errors and improves the stability of the command handling logic.
This commit refactors the code to conform to the Checkstyle configuration, ensuring consistency and compliance with coding standards. Changes made: - Replaced wildcard imports (e.g., import static org.junit.jupiter.api.Assertions.*) with explicit imports for better clarity and to avoid unnecessary imports. - Corrected import order to follow the standard conventions, ensuring that java.* imports are grouped together and listed alphabetically. - Fixed spacing issues, such as ensuring a single space between comments and code, and after operators (e.g., =, +). - Improved overall code readability and conformance to Checkstyle rules by addressing minor formatting inconsistencies. These changes are intended to improve the maintainability of the codebase by ensuring that it follows consistent styling rules as enforced by Checkstyle. By doing this, we minimize the chances of formatting-related errors and enhance code readability across the project. All changes are purely stylistic and do not alter the functionality of the code.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
This commit refactors the code to conform to the Checkstyle configuration, ensuring consistency and compliance with coding standards.
Changes made:
These changes are intended to improve the maintainability of the codebase by ensuring that it follows consistent styling rules as enforced by Checkstyle. By doing this, we minimize the chances of formatting-related errors and enhance code readability across the project.
All changes are purely stylistic and do not alter the functionality of the code.