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

Update documentation

Browse Source 
TRAVIS_JOB_NUMBER=4396.2
TRAVIS_COMMIT_RANGE=deec9c44b28b...8e745acf37c6
This commit is contained in:
Travis CI (pmd-bot)
2019-10-31 18:41:58 +00:00
parent 09c5f28381
commit 576c2b7af3
108 changed files with 818 additions and 719 deletions
Download Patch File Download Diff File Expand all files Collapse all files

182
pmd_release_notes.html
View File

@@ -173,7 +173,7 @@
<ul id="mysidebar" class="nav">
<li class="sidebarTitle">PMD 6.19.0</li>
<li class="sidebarTitle">PMD 6.20.0</li>
@@ -1284,194 +1284,20 @@ $('#toc').toc({ minimumHeaders: 0, listType: 'ul', showSpeed: 0, headers: 'h2,h3
<h2 id="-october-2019---6190">??-October-2019 - 6.19.0</h2>
<h2 id="-november-2019---6200">??-November-2019 - 6.20.0</h2>
<p>The PMD team is pleased to announce PMD 6.19.0.</p>
<p>The PMD team is pleased to announce PMD 6.20.0.</p>
<p>This is a minor release.</p>
<h3 id="new-and-noteworthy">New and noteworthy</h3>
<h4 id="updated-pmd-designer">Updated PMD Designer</h4>
<p>This PMD release ships a new version of the pmd-designer.
For the changes, see <a href="https://github.com/pmd/pmd-designer/releases/tag/6.19.0">PMD Designer Changelog</a>.</p>
<h4 id="java-metrics">Java Metrics</h4>
<ul>
<li>The new metric “Class Fan Out Complexity” has been added. See
<a href="pmd_java_metrics_index.html#class-fan-out-complexity-class_fan_out">Java Metrics Documentation</a> for details.</li>
</ul>
<h4 id="modified-rules">Modified Rules</h4>
<ul>
<li>
<p>The Java rules <a href="pmd_rules_java_errorprone.html#invalidlogmessageformat"><code class="highlighter-rouge">InvalidLogMessageFormat</code></a> and <a href="pmd_rules_java_errorprone.html#morethanonelogger"><code class="highlighter-rouge">MoreThanOneLogger</code></a>
(<code class="highlighter-rouge">java-errorprone</code>) now both support <a href="https://logging.apache.org/log4j/2.x/">Log4j2</a>. Note that the
rule “InvalidSlf4jMessageFormat” has been renamed to “InvalidLogMessageFormat” to reflect the fact, that it now
supports more than slf4j.</p>
</li>
<li>
<p>The Java rule <a href="pmd_rules_java_design.html#lawofdemeter"><code class="highlighter-rouge">LawOfDemeter</code></a> (<code class="highlighter-rouge">java-design</code>) 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. <code class="highlighter-rouge">newBuilder()</code> or <code class="highlighter-rouge">initBuilder()</code> works. This change
fixes a couple of false positives.</p>
</li>
<li>
<p>The Java rule <a href="pmd_rules_java_errorprone.html#dataflowanomalyanalysis"><code class="highlighter-rouge">DataflowAnomalyAnalysis</code></a> (<code class="highlighter-rouge">java-errorprone</code>) 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.</p>
</li>
<li>
<p>The java rule <a href="pmd_rules_java_multithreading.html#donotusethreads"><code class="highlighter-rouge">DoNotUseThreads</code></a> (<code class="highlighter-rouge">java-multithreading</code>) has been changed
to not report usages of <code class="highlighter-rouge">java.lang.Runnable</code> anymore. Just using <code class="highlighter-rouge">Runnable</code> does not automatically create
a new thread. While the check for <code class="highlighter-rouge">Runnable</code> has been removed, the rule now additionally checks for
usages of <code class="highlighter-rouge">Executors</code> and <code class="highlighter-rouge">ExecutorService</code>. Both create new threads, which are not managed by a J2EE
server.</p>
</li>
</ul>
<h4 id="renamed-rules">Renamed Rules</h4>
<ul>
<li>The Java rule <a href="pmd_rules_java_errorprone.html#invalidslf4jmessageformat"><code class="highlighter-rouge">InvalidSlf4jMessageFormat</code></a> has been renamed to
<a href="pmd_rules_java_errorprone.html#invalidlogmessageformat"><code class="highlighter-rouge">InvalidLogMessageFormat</code></a> since it supports now both slf4j and log4j2
message formats.</li>
</ul>
<h3 id="fixed-issues">Fixed Issues</h3>
<ul>
<li>core
<ul>
<li><a href="https://github.com/pmd/pmd/issues/1978">#1978</a>: [core] PMD fails on excluding unknown rules</li>
<li><a href="https://github.com/pmd/pmd/issues/2014">#2014</a>: [core] Making add(SourceCode sourceCode) public for alternative file systems</li>
<li><a href="https://github.com/pmd/pmd/issues/2020">#2020</a>: [core] Wrong deprecation warnings for unused XPath attributes</li>
<li><a href="https://github.com/pmd/pmd/issues/2036">#2036</a>: [core] Wrong include/exclude patterns are silently ignored</li>
<li><a href="https://github.com/pmd/pmd/issues/2048">#2048</a>: [core] Enable type resolution by default for XPath rules</li>
<li><a href="https://github.com/pmd/pmd/issues/2067">#2067</a>: [core] Build issue on Windows</li>
<li><a href="https://github.com/pmd/pmd/pull/2068">#2068</a>: [core] Rule loader should use the same resources loader for the ruleset</li>
<li><a href="https://github.com/pmd/pmd/issues/2071">#2071</a>: [ci] Add travis build on windows</li>
<li><a href="https://github.com/pmd/pmd/issues/2072">#2072</a>: [test][core] Not enough info in “test setup error” when numbers of lines do not match</li>
<li><a href="https://github.com/pmd/pmd/issues/2082">#2082</a>: [core] Incorrect logging of deprecated/renamed rules</li>
</ul>
</li>
<li>java
<ul>
<li><a href="https://github.com/pmd/pmd/issues/2042">#2042</a>: [java] PMD crashes with ClassFormatError: Absent Code attribute…</li>
</ul>
</li>
<li>java-bestpractices
<ul>
<li><a href="https://github.com/pmd/pmd/issues/1531">#1531</a>: [java] UnusedPrivateMethod false-positive with method result</li>
<li><a href="https://github.com/pmd/pmd/issues/2025">#2025</a>: [java] UnusedImports when @see / @link pattern includes a FQCN</li>
</ul>
</li>
<li>java-codestyle
<ul>
<li><a href="https://github.com/pmd/pmd/issues/2017">#2017</a>: [java] UnnecessaryFullyQualifiedName triggered for inner class</li>
</ul>
</li>
<li>java-design
<ul>
<li><a href="https://github.com/pmd/pmd/issues/1912">#1912</a>: [java] Metrics not computed correctly with annotations</li>
</ul>
</li>
<li>java-errorprone
<ul>
<li><a href="https://github.com/pmd/pmd/issues/336">#336</a>: [java] InvalidSlf4jMessageFormat applies to log4j2</li>
<li><a href="https://github.com/pmd/pmd/issues/1636">#1636</a>: [java] Stop checking UR anomalies for DataflowAnomalyAnalysis</li>
</ul>
</li>
<li>java-multithreading
<ul>
<li><a href="https://github.com/pmd/pmd/issues/1627">#1627</a>: [java] DoNotUseThreads should not warn on Runnable</li>
</ul>
</li>
<li>doc
<ul>
<li><a href="https://github.com/pmd/pmd/issues/2058">#2058</a>: [doc] CLI reference for <code class="highlighter-rouge">-norulesetcompatibility</code> shows a boolean default value</li>
</ul>
</li>
</ul>
<h3 id="api-changes">API Changes</h3>
<h4 id="deprecated-apis">Deprecated APIs</h4>
<h5 id="for-removal">For removal</h5>
<ul>
<li>pmd-core
<ul>
<li>All the package <a href="https://javadoc.io/page/net.sourceforge.pmd/pmd-core/6.19.0/net/sourceforge/pmd/dcd/package-summary.html#"><code class="highlighter-rouge">net.sourceforge.pmd.dcd</code></a> and its subpackages. See <a href="https://javadoc.io/page/net.sourceforge.pmd/pmd-core/6.19.0/net/sourceforge/pmd/dcd/DCD.html#"><code class="highlighter-rouge">DCD</code></a>.</li>
<li>In <a href="https://javadoc.io/page/net.sourceforge.pmd/pmd-core/6.19.0/net/sourceforge/pmd/lang/LanguageRegistry.html#"><code class="highlighter-rouge">LanguageRegistry</code></a>:
<ul>
<li><a href="https://javadoc.io/page/net.sourceforge.pmd/pmd-core/6.19.0/net/sourceforge/pmd/lang/LanguageRegistry.html#commaSeparatedTerseNamesForLanguageVersion(List)"><code class="highlighter-rouge">commaSeparatedTerseNamesForLanguageVersion</code></a></li>
<li><a href="https://javadoc.io/page/net.sourceforge.pmd/pmd-core/6.19.0/net/sourceforge/pmd/lang/LanguageRegistry.html#commaSeparatedTerseNamesForLanguage(List)"><code class="highlighter-rouge">commaSeparatedTerseNamesForLanguage</code></a></li>
<li><a href="https://javadoc.io/page/net.sourceforge.pmd/pmd-core/6.19.0/net/sourceforge/pmd/lang/LanguageRegistry.html#findAllVersions()"><code class="highlighter-rouge">findAllVersions</code></a></li>
<li><a href="https://javadoc.io/page/net.sourceforge.pmd/pmd-core/6.19.0/net/sourceforge/pmd/lang/LanguageRegistry.html#findLanguageVersionByTerseName(String)"><code class="highlighter-rouge">findLanguageVersionByTerseName</code></a></li>
<li><a href="https://javadoc.io/page/net.sourceforge.pmd/pmd-core/6.19.0/net/sourceforge/pmd/lang/LanguageRegistry.html#getInstance()"><code class="highlighter-rouge">getInstance</code></a></li>
</ul>
</li>
<li><a href="https://javadoc.io/page/net.sourceforge.pmd/pmd-core/6.19.0/net/sourceforge/pmd/RuleSet.html#getExcludePatterns()"><code class="highlighter-rouge">RuleSet#getExcludePatterns</code></a>. Use the new method <a href="https://javadoc.io/page/net.sourceforge.pmd/pmd-core/6.19.0/net/sourceforge/pmd/RuleSet.html#getFileExclusions()"><code class="highlighter-rouge">getFileExclusions</code></a> instead.</li>
<li><a href="https://javadoc.io/page/net.sourceforge.pmd/pmd-core/6.19.0/net/sourceforge/pmd/RuleSet.html#getIncludePatterns()"><code class="highlighter-rouge">RuleSet#getIncludePatterns</code></a>. Use the new method <a href="https://javadoc.io/page/net.sourceforge.pmd/pmd-core/6.19.0/net/sourceforge/pmd/RuleSet.html#getFileInclusions()"><code class="highlighter-rouge">getFileInclusions</code></a> instead.</li>
<li><a href="https://javadoc.io/page/net.sourceforge.pmd/pmd-core/6.19.0/net/sourceforge/pmd/lang/Parser.html#canParse()"><code class="highlighter-rouge">Parser#canParse</code></a></li>
<li><a href="https://javadoc.io/page/net.sourceforge.pmd/pmd-core/6.19.0/net/sourceforge/pmd/lang/Parser.html#getSuppressMap()"><code class="highlighter-rouge">Parser#getSuppressMap</code></a></li>
<li><a href="https://javadoc.io/page/net.sourceforge.pmd/pmd-core/6.19.0/net/sourceforge/pmd/rules/RuleBuilder.html#RuleBuilder(String,String,String)"><code class="highlighter-rouge">RuleBuilder#RuleBuilder</code></a>. Use the new constructor with the correct ResourceLoader instead.</li>
<li><a href="https://javadoc.io/page/net.sourceforge.pmd/pmd-core/6.19.0/net/sourceforge/pmd/rules/RuleFactory.html#RuleFactory()"><code class="highlighter-rouge">RuleFactory#RuleFactory</code></a>. Use the new constructor with the correct ResourceLoader instead.</li>
</ul>
</li>
<li>pmd-java
<ul>
<li><a href="https://javadoc.io/page/net.sourceforge.pmd/pmd-java/6.19.0/net/sourceforge/pmd/lang/java/ast/CanSuppressWarnings.html#"><code class="highlighter-rouge">CanSuppressWarnings</code></a> and its implementations</li>
<li><a href="https://javadoc.io/page/net.sourceforge.pmd/pmd-java/6.19.0/net/sourceforge/pmd/lang/java/rule/AbstractJavaRule.html#isSuppressed(Node)"><code class="highlighter-rouge">isSuppressed</code></a></li>
<li><a href="https://javadoc.io/page/net.sourceforge.pmd/pmd-java/6.19.0/net/sourceforge/pmd/lang/java/rule/AbstractJavaRule.html#getDeclaringType(Node)"><code class="highlighter-rouge">getDeclaringType</code></a>.</li>
<li><a href="https://javadoc.io/page/net.sourceforge.pmd/pmd-java/6.19.0/net/sourceforge/pmd/lang/java/rule/JavaRuleViolation.html#isSupressed(Node,Rule)"><code class="highlighter-rouge">isSupressed</code></a></li>
<li><a href="https://javadoc.io/page/net.sourceforge.pmd/pmd-java/6.19.0/net/sourceforge/pmd/lang/java/ast/ASTMethodDeclarator.html#"><code class="highlighter-rouge">ASTMethodDeclarator</code></a></li>
<li><a href="https://javadoc.io/page/net.sourceforge.pmd/pmd-java/6.19.0/net/sourceforge/pmd/lang/java/ast/ASTMethodDeclaration.html#getMethodName()"><code class="highlighter-rouge">getMethodName</code></a></li>
<li><a href="https://javadoc.io/page/net.sourceforge.pmd/pmd-java/6.19.0/net/sourceforge/pmd/lang/java/ast/ASTMethodDeclaration.html#getBlock()"><code class="highlighter-rouge">getBlock</code></a></li>
<li><a href="https://javadoc.io/page/net.sourceforge.pmd/pmd-java/6.19.0/net/sourceforge/pmd/lang/java/ast/ASTConstructorDeclaration.html#getParameterCount()"><code class="highlighter-rouge">getParameterCount</code></a></li>
</ul>
</li>
<li>pmd-apex
<ul>
<li><a href="https://javadoc.io/page/net.sourceforge.pmd/pmd-apex/6.19.0/net/sourceforge/pmd/lang/apex/ast/CanSuppressWarnings.html#"><code class="highlighter-rouge">CanSuppressWarnings</code></a> and its implementations</li>
<li><a href="https://javadoc.io/page/net.sourceforge.pmd/pmd-apex/6.19.0/net/sourceforge/pmd/lang/apex/rule/ApexRuleViolation.html#isSupressed(Node,Rule)"><code class="highlighter-rouge">isSupressed</code></a></li>
</ul>
</li>
</ul>
<h5 id="internal-apis">Internal APIs</h5>
<ul>
<li>pmd-core
<ul>
<li>All the package <a href="https://javadoc.io/page/net.sourceforge.pmd/pmd-core/6.19.0/net/sourceforge/pmd/util/package-summary.html#"><code class="highlighter-rouge">net.sourceforge.pmd.util</code></a> and its subpackages,
except <a href="https://javadoc.io/page/net.sourceforge.pmd/pmd-core/6.19.0/net/sourceforge/pmd/util/datasource/package-summary.html#"><code class="highlighter-rouge">net.sourceforge.pmd.util.datasource</code></a> and <a href="https://javadoc.io/page/net.sourceforge.pmd/pmd-core/6.19.0/net/sourceforge/pmd/util/database/package-summary.html#"><code class="highlighter-rouge">net.sourceforge.pmd.util.database</code></a>.</li>
<li><a href="https://javadoc.io/page/net.sourceforge.pmd/pmd-core/6.19.0/net/sourceforge/pmd/cpd/GridBagHelper.html#"><code class="highlighter-rouge">GridBagHelper</code></a></li>
<li><a href="https://javadoc.io/page/net.sourceforge.pmd/pmd-core/6.19.0/net/sourceforge/pmd/renderers/ColumnDescriptor.html#"><code class="highlighter-rouge">ColumnDescriptor</code></a></li>
</ul>
</li>
</ul>
<h3 id="external-contributions">External Contributions</h3>
<ul>
<li><a href="https://github.com/pmd/pmd/pull/2010">#2010</a>: [java] LawOfDemeter to support inner builder pattern - <a href="https://github.com/gregorriegler">Gregor Riegler</a></li>
<li><a href="https://github.com/pmd/pmd/pull/2012">#2012</a>: [java] Fixes 336, slf4j log4j2 support - <a href="https://github.com/markhall82">Mark Hall</a></li>
<li><a href="https://github.com/pmd/pmd/pull/2032">#2032</a>: [core] Allow adding SourceCode directly into CPD - <a href="https://github.com/nbraun-Google">Nathan Braun</a></li>
<li><a href="https://github.com/pmd/pmd/pull/2047">#2047</a>: [java] Fix computation of metrics with annotations - <a href="https://github.com/andipabst">Andi Pabst</a></li>
<li><a href="https://github.com/pmd/pmd/pull/2065">#2065</a>: [java] Stop checking UR anomalies - <a href="https://github.com/l0s">Carlos Macasaet</a></li>
<li><a href="https://github.com/pmd/pmd/pull/2068">#2068</a>: [core] Rule loader should use the same resources loader for the ruleset - <a href="https://github.com/willamette">Chen Yang</a></li>
<li><a href="https://github.com/pmd/pmd/pull/2070">#2070</a>: [core] Fix renderer tests for windows builds - <a href="https://github.com/Saladoc">Saladoc</a></li>
<li><a href="https://github.com/pmd/pmd/pull/2073">#2073</a>: [test][core] Add expected and actual line of numbers to message wording - <a href="https://github.com/snuyanzin">snuyanzin</a></li>
<li><a href="https://github.com/pmd/pmd/pull/2076">#2076</a>: [java] Add Metric ClassFanOutComplexity - <a href="https://github.com/andipabst">Andi Pabst</a></li>
<li><a href="https://github.com/pmd/pmd/pull/2078">#2078</a>: [java] DoNotUseThreads should not warn on Runnable #1627 - <a href="https://github.com/mclay">Michael Clay</a></li>
</ul>
<div class="tags">
@@ -1488,7 +1314,7 @@ except <a href="https://javadoc.io/page/net.sourceforge.pmd/pmd-core/6.19.0/net/
<div class="row">
<div class="col-lg-12 footer">
&copy;2019 PMD Open Source Project. All rights reserved. <br />
Site last generated: Oct 30, 2019 <br />
Site last generated: Oct 31, 2019 <br />
<p><img src="images/pmd-logo-small.png" alt="Company logo"/></p>
</div>
</div>