24-January-2020 - 6.21.0
The PMD team is pleased to announce PMD 6.21.0.
This is a minor release.
New and noteworthy
Thanks to Anatoly Trosinenko PMD supports now a new language: Modelica is a language to model complex physical systems. Both PMD and CPD are supported and there are already 3 rules available. The PMD Designer supports syntax highlighting for Modelica.
While the language implementation is quite complete, Modelica support is considered experimental for now. This is to allow us to change the rule API (e.g. the AST classes) slightly and improve the implementation based on your feedback.
Simple XML dump of AST
We added a experimental feature to dump the AST of a source file into XML. The XML format is of course PMD specific and language dependent. That XML file can be used to execute (XPath) queries against without PMD. It can also be used as a textual visualization of the AST if you don’t want to use the Designer.
This feature is experimental and might change or even be removed in the future, if it is not useful. A short description how to use it is available under Creating XML dump of the AST.
Any feedback about it, especially about your use cases, is highly appreciated.
Updated Apex Support
- The Apex language support has been bumped to version 48 (Spring ‘20). All new language features are now properly parsed and processed.
CPD XML format
The CPD XML output format has been enhanced to also report column information for found duplications in addition to the line information. This allows to display the exact tokens, that are considered duplicate.
If a CPD language doesn’t provide these exact information, then these additional attributes are omitted.
<file> element in the XML format now has 3 new attributes:
beginColumn(if there is column information available)
endColumn(if there is column information available)
The Java rule
java-errorprone) has a new property
ignoreExpressions. This property is set by default to
truein order to maintain compatibility. If this property is set to false, then literals in more complex expressions are considered as well.
The Apex rule
apex-errorprone) has been moved from category “Security” to “Error Prone”. The Apex runtime already prevents DML statements from being executed, but only at runtime. So, if you try to do this, you’ll get an error at runtime, hence this is error prone. See also the discussion on #2064.
The Java rule
java-documentation) has a new property
classCommentRequirement. This replaces the now deprecated property
headerCommentRequirement, since the name was misleading. (File) header comments are not checked, but class comments are.
- #2208: [apex] ASTFormalComment should implement ApexNode<T>
- #1984: [java] Cyclomatic complexity is misreported (lack of clearing metrics cache)
- #2006: [core] PMD should warn about multiple instances of the same rule in a ruleset
- #2161: [core] ResourceLoader is deprecated and marked as internal but is exposed
- #2170: [core] DocumentFile doesn’t preserve newlines
- #2214: [doc] Link broken in pmd documentation for writing Xpath rules
- #2212: [java] JavaRuleViolation reports wrong class name
- #2149: [java] JUnitAssertionsShouldIncludeMessage - False positive with assertEquals and JUnit5
- #2167: [java] UnnecessaryLocalBeforeReturn false positive with variable captured by method reference
- #1683: [java] CommentRequired property names are inconsistent
- #2141: [java] StringInstatiation: False negative with String-array access
Those APIs are not intended to be used by clients, and will be hidden or removed with PMD 7.0.0.
You can identify them with the
@InternalApi annotation. You’ll also get a deprecation warning.
- Implementations of
RuleViolationFactoryin each language module, eg
JavaRuleViolationFactory. See javadoc of
- Constructors of
RuleSetFactory, use factory methods from
SimpleCharStream: these are APIs used by our JavaCC implementations and that will be moved/refactored for PMD 7.0.0. They should not be used, extended or implemented directly.
- All classes generated by JavaCC, eg
JJTJavaParserState. This includes token classes, which will be replaced with a single implementation, and subclasses of
ParseException, whose usages will be replaced by just that superclass.
net.sourceforge.pmd.lang.java.qnameand its contents
ASTAnyTypeDeclaration#getImagewill be removed. Please use
getSimpleName()instead. This affects
- Several methods of
ASTTryStatement, replacements with other names have been added. This includes the XPath attribute
@Finally, replace it with a test for
- Several methods named
getGuardExpressionNodeare replaced with
getCondition. This affects the following nodes: WhileStatement, DoStatement, ForStatement, IfStatement, AssertStatement, ConditionalExpression.
ASTYieldStatementwill not implement
TypeNodeanymore come 7.0.0. Test the type of the expression nested within it.
- #2041: [modelica] Initial implementation for PMD - Anatoly Trosinenko
- #2051: [doc] Update the docs on adding a new language - Anatoly Trosinenko
- #2069: [java] CommentRequired: make property names consistent - snuyanzin
- #2169: [modelica] Follow-up fixes for Modelica language module - Anatoly Trosinenko
- #2193: [core] Fix odd logic in test runner - Egor Bredikhin
- #2194: [java] Fix odd logic in AvoidUsingHardCodedIPRule - Egor Bredikhin
- #2195: [modelica] Normalize invalid node ranges - Anatoly Trosinenko
- #2199: [modelica] Fix Javadoc tags - Anatoly Trosinenko
- #2225: [core] CPD: report endLine / column informations for found duplications - Maikel Steneker