PMD 6.30.0 released

12 December 2020

---

12-December-2020 - 6.30.0

The PMD team is pleased to announce PMD 6.30.0.

This is a minor release.

Table Of Contents

• New and noteworthy * CPD * Type information for VisualForce
• Fixed Issues
• API Changes
  • Deprecated API
    • Around RuleSet parsing
    • Around the PMD class
    • Miscellaneous
  • Internal API
• External Contributions
• Stats

New and noteworthy

CPD

• The C# module now supports the new option --ignore-literal-sequences, which can be used to avoid detection of some uninteresting clones. Support for other languages may be added in the future. See #2945

• The Scala module now supports suppression through CPD-ON/CPD-OFF comment pairs. See #2929

Type information for VisualForce

The Visualforce AST now can resolve the data type of Visualforce expressions that reference Apex Controller properties and Custom Object fields. This feature improves the precision of existing rules, like VfUnescapeEl.

This can be configured using two environment variables:

• PMD_VF_APEXDIRECTORIES: Comma separated list of directories for Apex classes. Absolute or relative to the Visualforce directory. Default is ../classes. Specifying an empty string will disable data type resolution for Apex Controller properties.
• PMD_VF_OBJECTSDIRECTORIES: Comma separated list of directories for Custom Objects. Absolute or relative to the Visualforce directory. Default is ../objects. Specifying an empty string will disable data type resolution for Custom Object fields.

This feature is experimental, in particular, expect changes to the way the configuration is specified. We’ll probably extend the CLI instead of relying on environment variables in a future version.

Thanks to Jeff Bartolotta and Roopa Mohan for contributing this!

Fixed Issues

• core
  • #1939: [core] XPath expressions return handling
  • #1961: [core] Text renderer should include name of violated rule
  • #2874: [core] Fix XMLRenderer with UTF-16
• cs
  • #2938: [cs] CPD: ignoring using directives could not be disabled
• java
  • #2911: [java] ClassTypeResolver#searchNodeNameForClass leaks memory
  • #2934: [java] CompareObjectsWithEquals / UseEqualsToCompareStrings - False negatives with fields
  • #2940: [java] Catch additional TypeNotPresentExceptions / LinkageErrors
• scala
  • #2480: [scala] Support CPD suppressions

API Changes

Deprecated API

Around RuleSet parsing

• RuleSetFactory and RulesetsFactoryUtils have been deprecated in favor of RuleSetLoader. This is easier to configure, and more maintainable than the multiple overloads of RuleSetFactoryUtils.
• Some static creation methods have been added to RuleSet for simple cases, eg forSingleRule. These replace some counterparts in RuleSetFactory
• Since RuleSets is also deprecated, many APIs that require a RuleSets instance now are deprecated, and have a counterpart that expects a List<RuleSet>.
• RuleSetReferenceId, RuleSetReference, RuleSetFactoryCompatibility are deprecated. They are most likely not relevant outside of the implementation of pmd-core.

Around the PMD class

Many classes around PMD’s entry point (PMD) have been deprecated as internal, including:

• The contents of the packages net.sourceforge.pmd.cli, net.sourceforge.pmd.processor
• SourceCodeProcessor
• The constructors of PMD (the class will be made a utility class)

Miscellaneous

• ASTPackageDeclaration#getPackageNameImage, ASTTypeParameter#getParameterName and the corresponding XPath attributes. In both cases they’re replaced with a new method getName, the attribute is @Name.
• ASTClassOrInterfaceBody#isAnonymousInnerClass, and ASTClassOrInterfaceBody#isEnumChild, refs #905

Internal API

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.

• net.sourceforge.pmd.lang.ecmascript.Ecmascript3Handler
• net.sourceforge.pmd.lang.ecmascript.Ecmascript3Parser
• EcmascriptParser#parserOptions
• EcmascriptParser#getSuppressMap
• net.sourceforge.pmd.lang.rule.ParametricRuleViolation
• ParserOptions#suppressMarker
• net.sourceforge.pmd.lang.modelica.rule.ModelicaRuleViolationFactory

External Contributions

• #2864: [vf] Provide expression type information to Visualforce rules to avoid false positives - Jeff Bartolotta
• #2914: [core] Include rule name in text renderer - Gunther Schrijvers
• #2925: Cleanup: Correct annotation array initializer indents from checkstyle #8083 - Abhishek Kumar
• #2929: [scala] Add support for CPD-ON and CPD-OFF special comments - Andy Robinson
• #2936: [java] (doc) Fix typo: “an accessor” not “a” - Igor Moreno
• #2938: [cs] CPD: fix issue where ignoring using directives could not be disabled - Maikel Steneker
• #2945: [cs] Add option to ignore sequences of literals - Maikel Steneker
• #2962: [cpp] Add support for C++ 14 binary literals - Maikel Steneker

Stats

• 190 commits
• 25 closed tickets & PRs
• Days since last release: 49