pmd/docs/pages/release_notes.md

title	permalink	keywords
PMD Release Notes	pmd_release_notes.html	changelog, release notes

{{ site.pmd.date }} - {{ site.pmd.version }}

The PMD team is pleased to announce PMD {{ site.pmd.version }}.

This is a {{ site.pmd.release_type }} release.

{% tocmaker is_release_notes_processor %}

New and noteworthy

Modified Rules

• The Java rules {% rule "java/errorprone/InvalidSlf4jMessageFormat" %} and {% rule "java/errorprone/MoreThanOneLogger" %} (java-errorprone) now both support Log4j2.

• The Java rule {% rule "java/design/LawOfDemeter" %} (java-design) ignores now also Builders, that are not assigned to a local variable, but just directly used within a method call chain. The method, that creates the builder needs to end with "Builder", e.g. newBuilder() or initBuilder() works. This change fixes a couple of false positives.

• The Java rule {% rule "java/errorprone/DataflowAnomalyAnalysis" %} (java-errorprone) doesn't check for UR anomalies (undefined and then referenced) anymore. These checks were all false-positives, since actual UR occurrences would lead to compile errors.

• The java rule {% rule "java/multithreading/DoNotUseThreads" %} (java-multithreading) has been changed to not report usages of java.lang.Runnable anymore. Just using Runnable does not automatically create a new thread. While the check for Runnable has been removed, the rule now additionally checks for usages of Executors and ExecutorService. Both create new threads, which are not managed by a J2EE server.

Fixed Issues

• core
  • #2014: [core] Making add(SourceCode sourceCode) public for alternative file systems
  • #2036: [core] Wrong include/exclude patterns are silently ignored
  • #2067: [core] Build issue on Windows
  • #2071: [ci] Add travis build on windows
  • #2072: [test][core] Not enough info in "test setup error" when numbers of lines do not match
• java
  • #2042: [java] PMD crashes with ClassFormatError: Absent Code attribute...
• java-bestpractices
  • #1531: [java] UnusedPrivateMethod false-positive with method result
  • #2025: [java] UnusedImports when @see / @link pattern includes a FQCN
• java-codestyle
  • #2017: [java] UnnecessaryFullyQualifiedName triggered for inner class
• java-design
  • #1912: [java] Metrics not computed correctly with annotations
• java-errorprone
  • #336: [java] InvalidSlf4jMessageFormat applies to log4j2
  • #1636: [java] Stop checking UR anomalies for DataflowAnomalyAnalysis
• java-multithreading
  • #1627: [java] DoNotUseThreads should not warn on Runnable
• doc
  • #2058: [doc] CLI reference for -norulesetcompatibility shows a boolean default value

API Changes

Deprecated APIs

For removal

• pmd-core
  • All the package {% jdoc_package core::dcd %} and its subpackages. See {% jdoc core::dcd.DCD %}.
  • In {% jdoc core::lang.LanguageRegistry %}:
    • {% jdoc core::lang.LanguageRegistry#commaSeparatedTerseNamesForLanguageVersion(List) %}
    • {% jdoc core::lang.LanguageRegistry#commaSeparatedTerseNamesForLanguage(List) %}
    • {% jdoc core::lang.LanguageRegistry#findAllVersions() %}
    • {% jdoc core::lang.LanguageRegistry#findLanguageVersionByTerseName(String) %}
    • {% jdoc core::lang.LanguageRegistry#getInstance() %}
  • {% jdoc !!core::RuleSet#getExcludePatterns() %}. Use the new method {% jdoc core::RuleSet#getFileExclusions() %} instead.
  • {% jdoc !!core::RuleSet#getIncludePatterns() %}. Use the new method {% jdoc core::RuleSet#getFileInclusions() %} instead.
  • {% jdoc !!core::lang.Parser#canParse() %}
• pmd-java
  • {% jdoc java::lang.java.ast.CanSuppressWarnings %} and its implementations
  • {% jdoc java::lang.java.rule.AbstractJavaRule#isSuppressed(Node) %}
  • {% jdoc java::lang.java.rule.JavaRuleViolation#isSupressed(Node,Rule) %}
  • {% jdoc java::lang.java.ast.ASTMethodDeclarator %}
  • {% jdoc java::lang.java.ast.ASTMethodDeclaration#getMethodName() %}
  • {% jdoc java::lang.java.ast.ASTMethodDeclaration#getBlock() %}
  • {% jdoc java::lang.java.ast.ASTConstructorDeclaration#getParameterCount() %}
• pmd-apex
  • {% jdoc apex::lang.apex.ast.CanSuppressWarnings %} and its implementations
  • {% jdoc apex::lang.apex.rule.ApexRuleViolation#isSupressed(Node,Rule) %}

Internal APIs

• pmd-core
  • All the package {% jdoc_package core::util %} and its subpackages, except {% jdoc_package core::util.datasource %} and {% jdoc_package core::util.database %}.
  • {% jdoc core::cpd.GridBagHelper %}
  • {% jdoc core::renderers.ColumnDescriptor %}

External Contributions

• #2010: [java] LawOfDemeter to support inner builder pattern - Gregor Riegler
• #2012: [java] Fixes 336, slf4j log4j2 support - Mark Hall
• #2032: [core] Allow adding SourceCode directly into CPD - Nathan Braun
• #2047: [java] Fix computation of metrics with annotations - Andi
• #2065: [java] Stop checking UR anomalies - Carlos Macasaet
• #2070: [core] Fix renderer tests for windows builds - Saladoc
• #2073: [test][core] Add expected and actual line of numbers to message wording - snuyanzin
• #2078: [java] DoNotUseThreads should not warn on Runnable #1627 - Michael Clay

{% endtocmaker %}