From a41df604e558641b93d1b7d80c4f5995256110b1 Mon Sep 17 00:00:00 2001 From: Andreas Dangel Date: Tue, 5 Sep 2017 18:03:15 +0200 Subject: [PATCH] Update release notes, refs #585 --- docs/pages/release_notes.md | 15 ++++++++++++++- .../src/main/resources/rulesets/releases/600.xml | 14 ++++++++++++++ .../src/main/resources/rulesets/java/codesize.xml | 2 +- 3 files changed, 29 insertions(+), 2 deletions(-) create mode 100644 pmd-core/src/main/resources/rulesets/releases/600.xml diff --git a/docs/pages/release_notes.md b/docs/pages/release_notes.md index f5476aa72e..817581b6d3 100644 --- a/docs/pages/release_notes.md +++ b/docs/pages/release_notes.md @@ -19,7 +19,9 @@ This is a major release. * [Configuration Error Reporting](#configuration-error-reporting) * [Java Symbol Table](#java-symbol-table) * [Apex Parser Update](#apex-parser-update) + * [New Rules](#new-rules) * [Modified Rules](#modified-rules) + * [Deprecated Rules](#deprecated-rules) * [Removed Rules](#removed-rules) * [Fixed Issues](#fixed-issues) * [API Changes](#api-changes) @@ -77,6 +79,12 @@ providing configuration error reporting are: As we move forward we will be able to detect and report more configuration errors (ie: incomplete `auxclasspath`) and include them to such reports. +#### New Rules + +* The rule `NcssCount` (ruleset `java-codesize`) replaces the three rules "NcssConstructorCount", "NcssMethodCount", + and "NcssTypeCount". The new rule uses the metrics framework to achieve the same. It has two properties, to + define the report level for method and class sizes separately. Constructors and methods are considered the same. + #### Modified Rules * The rule `UnnecessaryFinalModifier` (ruleset `java-unnecessarycode`) has been revamped to detect more cases. @@ -94,6 +102,11 @@ and include them to such reports. * The rule `GodClass` (ruleset `java-design`) has been revamped to use the new metrics framework. +#### Deprecated Rules + +* The rules `NcssConstructorCount`, `NcssMethodCount`, and `NcssTypeCount` (ruleset `java-codesize`) have been + deprecated. They will be replaced by the new rule `NcssCount` in the same ruleset. + #### Removed Rules * The deprecated rule `UseSingleton` has been removed from the ruleset `java-design`. The rule has been renamed @@ -249,4 +262,4 @@ All existing rules have been updated to reflect these changes. If you have custo * [#579](https://github.com/pmd/pmd/pull/579): \[java] Update parsing to produce upper and lower bounds - [Bendegúz Nagy](https://github.com/WinterGrascph) * [#580](https://github.com/pmd/pmd/pull/580): \[core] Add AbstractMetric to topple the class hierarchy of metrics - [Clément Fournier](https://github.com/oowekyala) * [#581](https://github.com/pmd/pmd/pull/581): \[java] Relax AbstractClassWithoutAnyMethod when class is annotated by @AutoValue - [Niklas Baudy](https://github.com/vanniktech) - +* [#585](https://github.com/pmd/pmd/pull/585): \[java] Moved NcssCountRule to codesize.xml - [Clément Fournier](https://github.com/oowekyala) diff --git a/pmd-core/src/main/resources/rulesets/releases/600.xml b/pmd-core/src/main/resources/rulesets/releases/600.xml new file mode 100644 index 0000000000..4c7bc8b288 --- /dev/null +++ b/pmd-core/src/main/resources/rulesets/releases/600.xml @@ -0,0 +1,14 @@ + + + + +This ruleset contains links to rules that are new in PMD v6.0.0 + + + + + + diff --git a/pmd-java/src/main/resources/rulesets/java/codesize.xml b/pmd-java/src/main/resources/rulesets/java/codesize.xml index c1b3f44a9e..2d4be9bebd 100644 --- a/pmd-java/src/main/resources/rulesets/java/codesize.xml +++ b/pmd-java/src/main/resources/rulesets/java/codesize.xml @@ -453,7 +453,7 @@ public class Foo extends Bar {