hiifong/pmd
1
0
Fork 0
forked from phoedos/pmd
Code Pull Requests Activity

Improve changelog format

Browse Source
This commit is contained in:
Andreas Dangel
2015-10-04 10:58:45 +02:00
parent b5c2932051
commit 6797742497
1 changed files with 119 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

161
src/site/markdown/overview/changelog.md
View File

@ -2,9 +2,20 @@
## ????? - 5.4.0-SNAPSHOT
**Note**: PMD 5.4.0 requires JDK 1.7 or above.
**New Supported Languages:**
<div style="border: 1px solid red; border-radius: 5px; border-left-width: 10px; padding: 5px 1em; background-color: lightyellow;">
**Note**:
PMD 5.4.0 requires JDK 1.7 or above.
</div>
**Summary:**
* 9 new rules
* 4 features requests
* 18 pull requests
**Feature Request and Improvements:**
@ -19,46 +30,106 @@
**New Rules:**
* New Rule: rulesets/java/design.xml/SingleMethodSingletonRule: Verifies that there is only one method called
"getInstance". If there are more methods that return the singleton, than it can easily happen, that these
are not the same instances - and thus no singleton.
* New Rule: rulesets/java/design.xml/SingletonClassReturningNewInstance: Verifies that the method called
"getInstance" returns a cached instance not always a fresh, new instance.
* New Rule: rulesets/pom/basic.xml/ProjectVersionAsDependencyVersion: Checks the usage of ${project.version} in
Maven POM files. This rule can be found in the pmd-xml module.
* New Rule: rulesets/pom/basic.xml/InvalidDependencyTypes: Verifies that only the default types (jar, war, ...)
for dependencies are used. This rule can be found in the pmd-xml module.
* New Rule: rulesets/java/comments.xml/CommentDefaultAccessModifier: In order to avoid mistakes with
forgotten access modifiers for methods, this rule ensures, that you explicitly mark the usage of the
default access modifier by placing a comment.
* New Rule: rulesets/java/basic.xml/SimplifiedTernary: Ternary operator with a boolean literal
can be simplified with a boolean expression.
* New Rule: rulesets/java/unnecessary.xml/UselessQualifiedThis: Flags unnecessary qualified usages
of this, when `this` alone would be unique. E.g. use just `this` instead of `Foo.this`.
* New Rule: rulesets/java/clone.xml/CloneMethodReturnTypeMustMatchClassName: If a class implements cloneable
the return type of the method clone() must be the class name.
* New Rule: rulesets/java/clone.xml/CloneMethodMustBePublic: The java manual says "By convention,
classes that implement the cloneable interface should override Object.clone (which is protected)
with a public method."
* Java:
* Basic: **SimplifiedTernary** (rulesets/java/basic.xml/SimplifiedTernary)
Ternary operator with a boolean literal can be simplified with a boolean expression.
* Clone: **CloneMethodMustBePublic** (rulesets/java/clone.xml/CloneMethodMustBePublic)
The java manual says "By convention,
classes that implement the `Cloneable` interface should override `Object.clone` (which is protected)
with a public method."
* Clone: **CloneMethodReturnTypeMustMatchClassName** (rulesets/java/clone.xml/CloneMethodReturnTypeMustMatchClassName)
If a class implements `Cloneable`
the return type of the method `clone()` must be the class name.
* Comments: **CommentDefaultAccessModifier** (rulesets/java/comments.xml/CommentDefaultAccessModifier)
In order to avoid mistakes with
forgotten access modifiers for methods, this rule ensures, that you explicitly mark the usage of the
default access modifier by placing a comment.
* Design: **SingletonClassReturningNewInstance** (rulesets/java/design.xml/SingletonClassReturningNewInstance)
Verifies that the method called `getInstance` returns a cached instance and not always a fresh, new instance.
* Design: **SingleMethodRule** (rulesets/java/design.xml/SingleMethodSingletonRule)
Verifies that there is only one method called
`getInstance`. If there are more methods that return the singleton, then it can easily happen, that these
are not the same instances - and thus no singleton.
* Unnecessary: **UselessQualifiedThis** (rulesets/java/unnecessary.xml/UselessQualifiedThis)
Flags unnecessary qualified usages
of this, when `this` alone would be unique. E.g. use just `this` instead of `Foo.this`.
* Maven POM: (The rules can be found in the *pmd-xml* module)
* Basic: **ProjectVersionAsDependencyVersion** (rulesets/pom/basic.xml/ProjectVersionAsDependencyVersion)
Checks the usage of `${project.version}` in Maven POM files.
* Basic: **InvalidDependencyTypes** (rulesets/pom/basic.xml/InvalidDependencyTypes)
Verifies that only the default types (jar, war, ...) for dependencies are used.
Ruleset snippet to activate the new rules:
<rule ref="rulesets/java/basic.xml/SimplifiedTernary"/>
<rule ref="rulesets/java/clone.xml/CloneMethodReturnTypeMustMatchClassName"/>
<rule ref="rulesets/java/clone.xml/CloneMethodMustBePublic"/>
<rule ref="rulesets/java/comments.xml/CommentDefaultAccessModifier"/>
<rule ref="rulesets/java/design.xml/SingleMethodSingleton"/>
<rule ref="rulesets/java/design.xml/SingletonClassReturningNewInstance"/>
<rule ref="rulesets/java/unnecessary.xml/UselessQualifiedThis"/>
<rule ref="rulesets/pom/basic.xml/ProjectVersionAsDependencyVersion"/>
<rule ref="rulesets/pom/basic.xml/InvalidDependencyTypes"/>
**Modified/Deprecated Rules:**
**Modified Rules:**
* Renamed Rule: Language Java, ruleset design.xml: The rule "UseSingleton" *has been renamed* to "UseUtilityClass".
See also bugs [#1059](https://sourceforge.net/p/pmd/bugs/1059) and [#1339](https://sourceforge.net/p/pmd/bugs/1339/).
* Modified Rule: rulesets/java/naming.xml/AbstractNaming: By default, this rule flags now classes,
that are named "Abstract" but are not abstract. This behavior can be disabled by setting
the new property "strict" to false.
* Modified Rule: rulesets/java/naming.xml/ShortVariable: Additional property `minimum` to configure
the minimum required length of a variable name.
* Modified Rule: rulesets/java/naming.xml/ShortMethodName: Additional property `minimum` to configure
the minimum required length of a method name.
* Modified Rule: rulesets/java/junit.xml/UseAssertTrueInsteadOfAssertEquals: This rule also flags
assertEquals, that use Boolean.TRUE/FALSE constants.
* Modified Rule: rulesets/java/basic.xml/CheckResultSet: Do not require to check the result of a navigation
method, if it is returned.
* Modified Rule: rulesets/java/unusedcode.xml/UnusedPrivateField: This rule won't trigger anymore if
[Lombok](https://projectlombok.org) is in use. See [#1420](https://sourceforge.net/p/pmd/bugs/1420/).
* Java
* Basic: **CheckResultSet** (rulesets/java/basic.xml/CheckResultSet)
Do not require to check the result of a navigation method, if it is returned.
* JUnit: **UseAssertTrueInsteadOfAssertEquals** (rulesets/java/junit.xml/UseAssertTrueInsteadOfAssertEquals)
This rule also flags assertEquals, that use Boolean.TRUE/FALSE constants.
* Naming: **AbstractNaming** (rulesets/java/naming.xml/AbstractNaming)
By default, this rule flags now classes,
that are named "Abstract" but are not abstract. This behavior can be disabled by setting
the new property `strict` to false.
* Naming: **ShortMethodName** (rulesets/java/naming.xml/ShortMethodName)
Additional property `minimum` to configure the minimum required length of a method name.
* Naming: **ShortVariable** (rulesets/java/naming.xml/ShortVariable)
Additional property `minimum` to configure the minimum required length of a variable name.
* UnusedCode: **UnusedPrivateField** (rulesets/java/unusedcode.xml/UnusedPrivateField)
This rule won't trigger anymore if [Lombok](https://projectlombok.org) is in use.
See [#1420](https://sourceforge.net/p/pmd/bugs/1420/).
**Renamed Rules:**
* Java
* Design: **<del>UseSingleton</del>** - **UseUtilityClass** (rulesets/java/design.xml/UseUtilityClass)
The rule "UseSingleton" *has been renamed* to "UseUtilityClass".
See also bugs [#1059](https://sourceforge.net/p/pmd/bugs/1059) and [#1339](https://sourceforge.net/p/pmd/bugs/1339/).
**Pull Requests:**
@ -85,14 +156,20 @@
**Bugfixes:**
* java-unusedcode/UnusedPrivateMethod:
[#1412](https://sourceforge.net/p/pmd/bugs/1412/): UnusedPrivateMethod false positive: Issue #1403 not completely solved
* [#1412](https://sourceforge.net/p/pmd/bugs/1412/): UnusedPrivateMethod false positive: Issue #1403 not completely solved
**API Changes:**
* pmd requires now JDK 1.7 or above.
* pmd-core: `net.sourceforge.pmd.lang.symboltable.Scope`: The method `addNameOccurrence` returns now a Set of
* pmd-core: `net.sourceforge.pmd.lang.symboltable.Scope`:
The method `addNameOccurrence` returns now a Set of
NameDeclarations to which the given occurrence has been added. This is useful in case there are ambiguous declarations
of methods.
* pmd-core: `net.sourceforge.pmd.lang.symboltable.AbstractScope`: The method `findVariableHere` returns now
* pmd-core: `net.sourceforge.pmd.lang.symboltable.AbstractScope`:
The method `findVariableHere` returns now
a Set of NameDeclarations which match the given occurrence. This is useful in case there are ambiguous declarations
of methods.