phoedos/pmd
1
1
Fork 1
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #3584 from adangel:issue-3563-classnamingconventions

Browse Source 
[java] ClassNamingConventions: Disable utilityClassPattern by default
#3584
This commit is contained in:
Andreas Dangel
2021-10-29 19:16:58 +02:00
parent 857894928a 3093013ff7
commit ac26d3dc6d
4 changed files with 67 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
docs/pages/release_notes.md
View File

@@ -112,6 +112,29 @@ This is a {{ site.pmd.release_type }} release.
}
```
* The Java rule {% rule java/codestyle/ClassNamingConventions %} uses a different default value of the
property `utilityClassPattern`: This rule was detecting utility classes by default since PMD 6.3.0
and enforcing the naming convention that utility classes has to be suffixed with Util or Helper or Constants.
However this turned out to be not so useful as a default configuration, as there is no standard
naming convention for utility classes.
With PMD 6.40.0, the default value of this property has been changed to `[A-Z][a-zA-Z0-9]*`
(Pascal case), effectively disabling the special handling of utility classes. This is the same default
pattern used for concrete classes.
This means, that the feature to enforce a naming convention for utility classes is now a opt-in
feature and can be enabled on demand.
To use the old behaviour, the property needs to be configured as follows:
```xml
<rule ref="category/java/codestyle.xml/ClassNamingConventions">
<properties>
<property name="utilityClassPattern" value="[A-Z][a-zA-Z0-9]+(Utils?|Helper|Constants)" />
</properties>
</rule>
### Fixed Issues
* apex
@@ -126,6 +149,9 @@ This is a {{ site.pmd.release_type }} release.
* [#3579](https://github.com/pmd/pmd/issues/3579): \[apex] ApexCRUDViolation: false negative with undelete
* java-bestpractices
* [#3542](https://github.com/pmd/pmd/issues/3542): \[java] MissingOverride: False negative for enum method
* java-codestyle
* [#1595](https://github.com/pmd/pmd/issues/1595): \[java] Discuss default for utility classes in ClassNamingConventions
* [#3563](https://github.com/pmd/pmd/issues/3563): \[java] The ClassNamingConventionsRule false-positive's on the class name "Constants"
* java-errorprone
* [#3560](https://github.com/pmd/pmd/issues/3560): \[java] InvalidLogMessageFormat: False positive with message and exception in a block inside a lambda
* java-performance