[apex] New Rule: Avoid boolean method parameters #5821
Merged
Conversation
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
…in public/global methods This commit introduces a new rule that flags boolean parameters in public and global Apex methods, encouraging the use of more descriptive alternatives. It includes the rule implementation, corresponding XML configuration, and test cases to validate its functionality.
|
Compared to main: (comment created at 2025-06-26 09:05:41+00:00 for 22fe512) |
AvoidBooleanMethodParameters rule
adangel
reviewed
Jun 18, 2025
...rc/main/java/net/sourceforge/pmd/lang/apex/rule/design/AvoidBooleanMethodParametersRule.java
Outdated
Show resolved
Hide resolved
adangel
added a commit
that referenced
this pull request
Jun 26, 2025
adangel
added a commit
that referenced
this pull request
Jun 26, 2025
Merge pull request #5821 from mitchspano:boolean_parameter
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Describe the PR
This PR implements a new Apex rule
AvoidBooleanMethodParametersRulethat detects boolean parameters in public and global methods. The rule discourages the use of Boolean parameters in public APIs as they can lead to ambiguity (especially with null handling in Apex) and make method calls harder to understand. Instead, the rule encourages developers to use more expressive alternatives such as separate methods with descriptive names, enums, or configuration objects.The rule specifically targets:
Related issues
Ready?
./mvnw clean verifypasses (checked automatically by github actions)