Old Release Notes

Previous versions of PMD can be downloaded here: Releases - pmd/pmd (GitHub)

29-November-2024 - 7.8.0

The PMD team is pleased to announce PMD 7.8.0.

This is a minor release.

Table Of Contents

• 🚀 New and noteworthy
• 🌟 New and changed rules
  • New Rules
• 🐛 Fixed Issues
• 🚨 API Changes
  • Deprecations
• ✨ Merged pull requests
• 📦 Dependency updates
• 📈 Stats

🚀 New and noteworthy

🌟 New and changed rules

New Rules

• The new Apex rule QueueableWithoutFinalizer detects when the Queueable interface is used but a Finalizer is not attached. Without attaching a Finalizer, there is no way of designing error recovery actions should the Queueable action fail.

🐛 Fixed Issues

• ant
  • #1860: [ant] Reflective access warnings on java > 9 and java < 17
• apex
  • #5302: [apex] New Rule: Queueable Should Attach Finalizer
  • #5333: [apex] Token recognition errors for string containing unicode escape sequence
• html
  • #5322: [html] CPD throws exception on when HTML file is missing closing tag
• java
  • #5283: [java] AssertionError “this should be unreachable” with scala library
  • #5293: [java] Deadlock when executing PMD in multiple threads
  • #5324: [java] Issue with type inference of nested lambdas
  • #5329: [java] Type inference issue with unknown method ref in call chain
  • #5338: [java] Unresolved target type for lambdas make overload resolution fail
• java-bestpractices
  • #4113: [java] JUnitTestsShouldIncludeAssert - false positive with SoftAssertionsExtension
  • #5083: [java] UnusedPrivateMethod false positive when method reference has no target type
  • #5097: [java] UnusedPrivateMethod FP with raw type missing from the classpath
  • #5318: [java] PreserveStackTraceRule: false-positive on Pattern Matching with instanceof
• java-codestyle
  • #5214: [java] Wrong message for LambdaCanBeMethodReference with method of enclosing class
  • #5263: [java] UnnecessaryFullyQualifiedName: false-positive in an enum that uses its own static variables
  • #5315: [java] UnnecessaryImport false positive for on-demand imports
• java-design
  • #4763: [java] SimplifyBooleanReturns - wrong suggested solution
• java-errorprone
  • #5070: [java] ConfusingArgumentToVarargsMethod FP when types are unresolved
• java-performance
  • #5287: [java] TooFewBranchesForSwitch false-positive with switch using list of case constants
  • #5314: [java] InsufficientStringBufferDeclarationRule: Lack of handling for char type parameters
  • #5320: [java] UseStringBufferLength: false-negative on StringBuffer of sb.toString().equals(“”)

🚨 API Changes

Deprecations

• pmd-coco
  • CocoBaseListener is deprecated for removal. This class was never intended to be generated. It will be removed with no replacement.
  • CocoBaseVisitor is deprecated for removal. This class was never intended to be generated. It will be removed with no replacement.
  • CocoListener is deprecated for removal. This class was never intended to be generated. It will be removed with no replacement.
  • CocoParser is deprecated for removal. This class was never intended to be generated. It will be removed with no replacement.
  • CocoVisitor is deprecated for removal. This class was never intended to be generated. It will be removed with no replacement.
• pmd-gherkin
  • GherkinBaseListener is deprecated for removal. This class was never intended to be generated. It will be removed with no replacement.
  • GherkinBaseVisitor is deprecated for removal. This class was never intended to be generated. It will be removed with no replacement.
  • GherkinListener is deprecated for removal. This class was never intended to be generated. It will be removed with no replacement.
  • GherkinParser is deprecated for removal. This class was never intended to be generated. It will be removed with no replacement.
  • GherkinVisitor is deprecated for removal. This class was never intended to be generated. It will be removed with no replacement.
• pmd-julia
  • JuliaBaseListener is deprecated for removal. This class was never intended to be generated. It will be removed with no replacement.
  • JuliaBaseVisitor is deprecated for removal. This class was never intended to be generated. It will be removed with no replacement.
  • JuliaListener is deprecated for removal. This class was never intended to be generated. It will be removed with no replacement.
  • JuliaParser is deprecated for removal. This class was never intended to be generated. It will be removed with no replacement.
  • JuliaVisitor is deprecated for removal. This class was never intended to be generated. It will be removed with no replacement.
• pmd-kotlin
  • UnicodeClasses is deprecated for removal. This class was never intended to be generated. It will be removed with no replacement.
• pmd-xml
  • XMLLexer is deprecated for removal. Use net.sourceforge.pmd.lang.xml.ast.XMLLexer instead (note different package ast instead of antlr4).

✨ Merged pull requests

• #5240: Release notes improvements - Andreas Dangel (@adangel)
• #5284: [apex] Use case-insensitive input stream to avoid choking on Unicode escape sequences - Willem A. Hajenius (@wahajenius)
• #5286: [ant] Formatter: avoid reflective access to determine console encoding - Andreas Dangel (@adangel)
• #5289: [java] TooFewBranchesForSwitch - allow list of case constants - Andreas Dangel (@adangel)
• #5296: [xml] Have pmd-xml Lexer in line with other antlr grammars - Juan Martín Sotuyo Dodero (@jsotuyod)
• #5300: Add rule test cases for issues fixed with PMD 7.0.0 - Andreas Dangel (@adangel)
• #5303: [apex] New Rule: Queueable Should Attach Finalizer - Mitch Spano (@mitchspano)
• #5309: [java] Fix #5293: Parse number of type parameters eagerly - Andreas Dangel (@adangel)
• #5310: [java] Fix #5283 - inner class has public private modifiers - Clément Fournier (@oowekyala)
• #5325: [java] Fix inference dependency issue with nested lambdas - Clément Fournier (@oowekyala)
• #5326: [java] UseStringBufferLength - consider sb.toString().equals(“”) - Andreas Dangel (@adangel)
• #5328: [html] Test for a closing tag when determining node positions - Andreas Dangel (@adangel)
• #5330: [java] Propagate unknown type better when mref is unresolved - Clément Fournier (@oowekyala)
• #5331: [java] PreserveStackTrace - consider instance type patterns - Andreas Dangel (@adangel)
• #5332: [java] InsufficientStringBufferDeclaration: Fix CCE for Character - Andreas Dangel (@adangel)
• #5334: [java] UnitTestShouldIncludeAssert - consider SoftAssertionsExtension - Andreas Dangel (@adangel)
• #5335: [kotlin] Prevent auxiliary grammars from generating lexers - Juan Martín Sotuyo Dodero (@jsotuyod)
• #5336: [gherkin] Remove generated gherkin code from coverage report - Juan Martín Sotuyo Dodero (@jsotuyod)
• #5337: [doc] Introducing PMD Guru on Gurubase.io - Kursat Aktas (@kursataktas)
• #5339: [java] Allow lambdas with unresolved target types to succeed inference - Clément Fournier (@oowekyala)
• #5340: [java] Fix #5097 - problem with unchecked conversion - Clément Fournier (@oowekyala)
• #5341: [java] Fix #5083 - UnusedPrivateMethod false positive with mref without target type but with exact method - Clément Fournier (@oowekyala)
• #5342: [julia] Ignore generated code in Julia module - Juan Martín Sotuyo Dodero (@jsotuyod)
• #5345: [coco] Remove generated coco files form coverage - Juan Martín Sotuyo Dodero (@jsotuyod)
• #5346: [typescript] Add cleanup after generating ts lexer - Juan Martín Sotuyo Dodero (@jsotuyod)
• #5347: [tsql] Flag generated lexer as generated - Juan Martín Sotuyo Dodero (@jsotuyod)
• #5352: [java] Add permitted subtypes to symbol API - Clément Fournier (@oowekyala)
• #5353: [java] Fix #5263 - UnnecessaryFullyQualifiedName FP with forward references - Clément Fournier (@oowekyala)
• #5354: [apex] Updated the docs for UnusedMethod as per discussion #5200 - samc-gearset (@sam-gearset)
• #5370: [java] Fix #5214 - LambdaCanBeMethodReference issue with method of enclosing class - Clément Fournier (@oowekyala)
• #5371: [doc] Improve docs on adding Antlr languages - Juan Martín Sotuyo Dodero (@jsotuyod)
• #5372: [java] Fix #5315 - UnusedImport FP with import on demand - Clément Fournier (@oowekyala)
• #5373: [java] Fix #4763 - wrong message for SimplifyBooleanReturns - Clément Fournier (@oowekyala)
• #5374: [java] Fix #5070 - confusing argument to varargs method FP when types are unknown - Clément Fournier (@oowekyala)

📦 Dependency updates

• #5285: Bump pmd from 7.5.0 to 7.7.0
• #5288: Bump asm from 9.7 to 9.7.1
• #5290: Bump org.apache.maven.plugins:maven-assembly-plugin from 3.6.0 to 3.7.1
• #5301: Bump gems and bundler
• #5307: Bump org.apache.maven.plugins:maven-clean-plugin from 3.3.2 to 3.4.0
• #5308: Bump webrick from 1.8.2 to 1.9.0 in /docs in the all-gems group across 1 directory
• #5312: Bump maven-pmd-plugin from 3.24.0 to 3.26.0
• #5316: Bump rouge from 4.4.0 to 4.5.0 in the all-gems group across 1 directory
• #5317: Bump org.apache.commons:commons-compress from 1.26.0 to 1.27.1
• #5348: Bump rouge from 4.5.0 to 4.5.1 in the all-gems group across 1 directory
• #5350: Bump org.apache.commons:commons-lang3 from 3.14.0 to 3.17.0
• #5356: Bump build-tools to 28
• #5357: Bump log4j.version from 2.23.0 to 2.24.2
• #5358: Bump org.apache.maven.plugins:maven-dependency-plugin from 3.7.1 to 3.8.1
• #5359: Bump org.apache.maven.plugins:maven-release-plugin from 3.0.1 to 3.1.1
• #5360: Bump io.github.apex-dev-tools:apex-ls_2.13 from 5.2.0 to 5.5.0
• #5361: Bump ant.version from 1.10.14 to 1.10.15
• #5362: Bump org.jetbrains:annotations from 24.1.0 to 26.0.1
• #5363: Bump com.puppycrawl.tools:checkstyle from 10.18.1 to 10.20.1
• #5364: Bump info.picocli:picocli from 4.7.5 to 4.7.6
• #5365: Bump com.github.hazendaz.maven:coveralls-maven-plugin from 4.5.0-M3 to 4.5.0-M5
• #5366: Bump org.mockito:mockito-core from 4.11.0 to 5.14.2
• #5367: Bump surefire.version from 3.2.5 to 3.5.2
• #5368: Bump org.junit.platform:junit-platform-suite from 1.11.2 to 1.11.3

📈 Stats

• 216 commits
• 55 closed tickets & PRs
• Days since last release: 35

25-October-2024 - 7.7.0

The PMD team is pleased to announce PMD 7.7.0.

This is a minor release.

Table Of Contents

• 🚀 New and noteworthy
  • CPD can now ignore literals and identifiers in C++ code
• 🌟 Rule Changes
  • Changed Rules
  • Renamed Rules
• 🐛 Fixed Issues
• 🚨 API Changes
• ✨ Merged pull requests
• 📦 Dependency updates
• 📈 Stats

🚀 New and noteworthy

CPD can now ignore literals and identifiers in C++ code

When searching for duplicated code in C++ differences in literals or identifiers can be ignored now (like in Java). This can be enabled via the command line options --ignore-literal and --ignore-identifiers.
See PR #5040 for details.

🌟 Rule Changes

Changed Rules

• SwitchStmtsShouldHaveDefault (Java Best Practices) doesn’t report empty switch statements anymore. To detect these, use EmptyControlStatement.
• UnitTestShouldUseAfterAnnotation (Java Best Practices) now also considers JUnit 5 and TestNG tests.
• UnitTestShouldUseBeforeAnnotation (Java Best Practices) now also considers JUnit 5 and TestNG tests.
• TooFewBranchesForSwitch (Java Performance) doesn’t report empty switches anymore. To detect these, use EmptyControlStatement.

Renamed Rules

• Several rules for unit testing have been renamed to better reflect their actual scope. Lots of them were called after JUnit / JUnit 4, even when they applied to JUnit 5 and / or TestNG.
  • UnitTestAssertionsShouldIncludeMessage (Java Best Practices) has been renamed from JUnitAssertionsShouldIncludeMessage.
  • UnitTestContainsTooManyAsserts (Java Best Practices) has been renamed from JUnitTestContainsTooManyAsserts.
  • UnitTestShouldIncludeAssert (Java Best Practices) has been renamed from JUnitTestsShouldIncludeAssert.
  • UnitTestShouldUseAfterAnnotation (Java Best Practices) has been renamed from JUnit4TestShouldUseAfterAnnotation.
  • UnitTestShouldUseBeforeAnnotation (Java Best Practices) has been renamed from JUnit4TestShouldUseBeforeAnnotation.
  • UnitTestShouldUseTestAnnotation (Java Best Practices) has been renamed from JUnit4TestShouldUseTestAnnotation.
• Several rules about switch statements and switch expression have been renamed, as they apply both to Switch Statements and to Switch Expressions:
  • DefaultLabelNotLastInSwitch (Java Best Practices) has been renamed from DefaultLabelNotLastInSwitchStmt.
  • NonCaseLabelInSwitch (Java Error Prone) has been renamed from NonCaseLabelInSwitchStatement.
  • TooFewBranchesForSwitch (Java Performance) has been renamed from TooFewBranchesForASwitchStatement.
  • NonExhaustiveSwitch (Java Best Practices) has been renamed from SwitchStmtsShouldHaveDefault.

The old rule names still work but are deprecated.

🐛 Fixed Issues

• apex-performance
  • #5270: [apex] AvoidNonRestrictiveQueries when LIMIT is followed by bind expression
• java
  • #4532: [java] Rule misnomer for JUnit* rules
  • #5261: [java] Record patterns with empty deconstructor lists lead to NPE
• java-bestpractices
  • #4286: [java] Rename rule SwitchStmtsShouldHaveDefault to NonExhaustiveSwitch
  • #4813: [java] SwitchStmtsShouldHaveDefault false positive with pattern matching
• java-codestyle
  • #5253: [java] BooleanGetMethodName: False-negatives with Boolean wrapper
• java-design
  • #5030: [java] SwitchDensity false positive with pattern matching
• java-errorprone
  • #3362: [java] ImplicitSwitchFallThrough should consider switch expressions
  • #5067: [java] CloseResource: False positive for FileSystems.getDefault()
  • #5244: [java] UselessOperationOnImmutable should detect java.time types
  • #5257: [java] NonCaseLabelInSwitch should consider switch expressions
• java-performance
  • #5249: [java] TooFewBranchesForASwitchStatement false positive for Pattern Matching
  • #5250: [java] TooFewBranchesForASwitchStatement should consider Switch Expressions

🚨 API Changes

• java-bestpractices
  • The old rule name JUnit4TestShouldUseAfterAnnotation has been deprecated. Use the new name UnitTestShouldUseAfterAnnotation instead.
  • The old rule name JUnit4TestShouldUseBeforeAnnotation has been deprecated. Use the new name UnitTestShouldUseBeforeAnnotation instead.
  • The old rule name JUnit4TestShouldUseTestAnnotation has been deprecated. Use the new name UnitTestShouldUseTestAnnotation instead.
  • The old rule name JUnitAssertionsShouldIncludeMessage has been deprecated. Use the new name UnitTestAssertionsShouldIncludeMessage instead.
  • The old rule name JUnitTestContainsTooManyAsserts has been deprecated. Use the new name UnitTestContainsTooManyAsserts instead.
  • The old rule name JUnitTestsShouldIncludeAssert has been deprecated. Use the new name UnitTestShouldIncludeAssert instead.
  • The old rule name DefaultLabelNotLastInSwitchStmt has been deprecated. Use the new name DefaultLabelNotLastInSwitch instead.
  • The old rule name SwitchStmtsShouldHaveDefault has been deprecated. USe the new name NonExhaustiveSwitch instead.
• java-errorprone
  • The old rule name NonCaseLabelInSwitchStatement has been deprecated. Use the new name NonCaseLabelInSwitch instead.
• java-performance
  • The old rule name TooFewBranchesForASwitchStatement has been deprecated. Use the new name TooFewBranchesForSwitch instead.

✨ Merged pull requests

• #4965: Fix #4532: [java] Rename JUnit rules with overly restrictive names - Juan Martín Sotuyo Dodero (@jsotuyod)
• #5040: [cpp] Ignore literals and ignore identifiers capability to C++ CPD - Jakub Dupak (@jdupak)
• #5225: Fix #5067: [java] CloseResource: False positive for FileSystems.getDefault() - Lukas Gräf (@lukasgraef)
• #5241: Ignore javacc code in coverage report - Juan Martín Sotuyo Dodero (@jsotuyod)
• #5245: [java] Improve UnitTestShouldUse{After,Before}Annotation rules to support JUnit5 and TestNG - Andreas Dangel (@adangel)
• #5247: Fix #5030: [java] SwitchDensity false positive with pattern matching - Andreas Dangel (@adangel)
• #5248: Fix #3362: [java] ImplicitSwitchFallThrough should consider switch expressions - Andreas Dangel (@adangel)
• #5251: Fix #5249 and #5250: [java] TooFewBranchesForSwitch ignore pattern matching and support switch expressions - Andreas Dangel (@adangel)
• #5252: Fix #4813: [java] SwitchStmtsShouldHaveDefault false positive with pattern matching - Andreas Dangel (@adangel)
• #5255: [java] Rename rule DefaultLabelNotLastInSwitch - Andreas Dangel (@adangel)
• #5256: Fix #5257: [java] NonCaseLabelInSwitch - support switch expressions - Andreas Dangel (@adangel)
• #5258: Ignore generated antlr classes in coverage reports - Juan Martín Sotuyo Dodero (@jsotuyod)
• #5264: Fix #5261: [java] Fix NPE with empty pattern list - Clément Fournier (@oowekyala)
• #5267: [java] Rename rule SwitchStmtsShouldHaveDefault to NonExhaustiveSwitch - Andreas Dangel (@adangel)
• #5269: Fix #5253: [java] Support Boolean wrapper class for BooleanGetMethodName rule - Aryant Tripathi (@Aryant-Tripathi)
• #5273: Fix #5270: [apex] AvoidNonRestrictiveQueries: Fix regex for detecting LIMIT clause - Andreas Dangel (@adangel)
• #5275: Use plugin-classpath to simplify javacc-wrapper.xml - Andreas Dangel (@adangel)
• #5278: [java] CouplingBetweenObjects: improve violation message - Andreas Dangel (@adangel)
• #5279: Fix #5244: [java] UselessOperationOnImmutable: consider java.time.* types - Andreas Dangel (@adangel)

📦 Dependency updates

• #5234: Bump com.google.protobuf:protobuf-java from 3.25.3 to 4.28.2
• #5274: Bump org.junit from 5.8.2 to 5.11.2
• #5276: Bump org.checkerframework:checker-qual from 2.11.1 to 3.48.1
• #5280: Bump danger from 9.5.0 to 9.5.1 in the all-gems group across 1 directory
• #5281: Bump org.scala-lang:scala-reflect from 2.13.13 to 2.13.15

📈 Stats

• 98 commits
• 32 closed tickets & PRs
• Days since last release: 27

27-September-2024 - 7.6.0

The PMD team is pleased to announce PMD 7.6.0.

This is a minor release.

Table Of Contents

• 🚀 New and noteworthy
  • New Git default branch - “main”
• 🐛 Fixed Issues
• 🚨 API Changes
• ✨ Merged pull requests
• 📦 Dependency updates
• 📈 Stats

🚀 New and noteworthy

New Git default branch - “main”

We are joining the Git community and updating “master” to “main”. Using the term “master” for the main development branch can be offensive to some people. Existing versions of Git have been always capable of working with any branch name and since 2.28.0 (July 2020) the default initial branch is configurable (init.defaultBranch). Since October 2020, the default branch for new repositories on GitHub is “main”. Finally, PMD will also use this new name for the main branch in all our own repositories.

Why “main”? PMD uses a very simple branching model - pull requests with feature branches and one main development branch, from which releases are created. That’s why “main” is currently the best fitting name.

More information:

• https://sfconservancy.org/news/2020/jun/23/gitbranchname/
• https://github.blog/changelog/2020-10-01-the-default-branch-for-newly-created-repositories-is-now-main/

What changes?

• We change the default branch on GitHub, so that pull requests are automatically created against main from now on.
• If you have already a local clone of PMD’s repository, you’ll need to rename the old master branch locally:

  git branch --move master main
  git fetch origin
  git branch --set-upstream-to=origin/main main
  git remote set-head origin --auto
  

  More info: https://git-scm.com/book/en/v2/Git-Branching-Branch-Management#_changing_master and https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/renaming-a-branch#updating-a-local-clone-after-a-branch-name-changes

• If you created a fork on GitHub, you’ll need to change the default branch in your fork to main as well (Settings > Default Branch).
• Some time after this release, we’ll delete the old master branch on GitHub. Then only main can be used.
• This change is expanded to the other PMD repositories as well, e.g. pmd-designer and pmd-regression-tester.

🐛 Fixed Issues

• apex
  • #5138: [apex] Various false-negatives since 7.3.0 when using triggers (ApexCRUDViolation, CognitiveComplexity, OperationWithLimitsInLoop)
  • #5163: [apex] Parser error when using toLabel in SOSL query
  • #5182: [apex] Parser error when using GROUPING in a SOQL query
  • #5218: [apex] Parser error when using nested subqueries in SOQL
  • #5228: [apex] Parser error when using convertCurrency() in SOQL
• core
  • #5059: [core] xml output doesn’t escape CDATA inside its own CDATA
  • #5201: [core] PMD sarif schema file points to nonexistent location
  • #5222: [core] RuleReference/RuleSetWriter don’t handle changed default property values correctly
  • #5229: [doc] CLI flag --show-suppressed needs to mention xml, html, summaryhtml
• java
  • #5190: [java] NPE in type inference
• java-codestyle
  • #5046: [java] LocalVariableCouldBeFinal false positive with try/catch
• java-errorprone
  • #5068: [java] MissingStaticMethodInNonInstantiatableClass: false positive with builder pattern
  • #5207: [java] CheckSkipResult: false positve for a private method void skip(int) in a subclass of FilterInputStream

🚨 API Changes

No changes.

✨ Merged pull requests

• #5186: [java] Cleanup things about implicit classes - Clément Fournier (@oowekyala)
• #5188: [apex] Use new apex-parser 4.2.0 - Andreas Dangel (@adangel)
• #5191: [java] Fix #5046 - FPs in LocalVariableCouldBeFinal - Clément Fournier (@oowekyala)
• #5192: [java] Fix #5190 - NPE in type inference caused by null type - Clément Fournier (@oowekyala)
• #5195: [apex] Fix various FNs when using triggers - Andreas Dangel (@adangel)
• #5202: [core] Sarif format: refer to schemastore.org - David Schach (@dschach)
• #5208: [doc] Added Codety to “Tools / Integrations” - Tony (@random1223)
• #5210: [core] Fix PMD’s XMLRenderer to escape CDATA - Andreas Dangel (@adangel)
• #5211: Change branch master to main - Andreas Dangel (@adangel)
• #5212: [java] Adjust signature matching in CheckSkipResultRule - Juan Martín Sotuyo Dodero (@jsotuyod)
• #5223: [core] Fix RuleReference / RuleSetWriter handling of properties - Andreas Dangel (@adangel)
• #5224: [java] Fix #5068: Class incorrectly identified as non-instantiatable - Lukas Gräf (@lukasgraef)
• #5230: [doc] Documentation update for –show-suppressed flag - David Schach (@dschach)
• #5237: [apex] Support convertCurrency() in SOQL/SOSL - Andreas Dangel (@adangel)

📦 Dependency updates

• #5185: Bump checkstyle from 10.14.0 to 10.18.1
• #5187: Bump org.apache.maven.plugins:maven-install-plugin from 3.1.1 to 3.1.3
• #5199: Bump org.apache.maven.plugins:maven-deploy-plugin from 3.1.1 to 3.1.3
• #5216: Bump com.github.siom79.japicmp:japicmp-maven-plugin from 0.20.0 to 0.23.0
• #5226: Bump rouge from 4.3.0 to 4.4.0 in the all-gems group across 1 directory
• #5227: Bump com.google.code.gson:gson from 2.10.1 to 2.11.0
• #5232: Bump com.google.protobuf:protobuf-java from 3.25.3 to 3.25.5
• #5233: Bump webrick from 1.8.1 to 1.8.2 in /docs

📈 Stats

• 60 commits
• 27 closed tickets & PRs
• Days since last release: 27

30-August-2024 - 7.5.0

The PMD team is pleased to announce PMD 7.5.0.

This is a minor release.

Table Of Contents

• 🚀 New: Java 23 Support
• 🌟 New Rules
• 🐛 Fixed Issues
• 🚨 API Changes
  • Deprecations
  • Experimental
• ✨ External Contributions
• 📦 Dependency updates
• 📈 Stats

🚀 New: Java 23 Support

This release of PMD brings support for Java 23. There are no new standard language features, but a couple of preview language features:

• JEP 455: Primitive Types in Patterns, instanceof, and switch (Preview)
• JEP 476: Module Import Declarations (Preview)
• JEP 477: Implicitly Declared Classes and Instance Main Methods (Third Preview)
• JEP 482: Flexible Constructor Bodies (Second Preview)

Note that String Templates (introduced as preview in Java 21 and 22) are not supported anymore in Java 23, see JDK-8329949 for details.

In order to analyze a project with PMD that uses these preview language features, you’ll need to enable it via the environment variable PMD_JAVA_OPTS and select the new language version 23-preview:

export PMD_JAVA_OPTS=--enable-preview
pmd check --use-version java-23-preview ...

Note: Support for Java 21 preview language features have been removed. The version “21-preview” are no longer available.

🌟 New Rules

• The new Java rule AvoidSynchronizedStatement finds synchronization blocks that could cause performance issues with virtual threads due to pinning.
• The new JavaScript rule AvoidConsoleStatements finds any function calls on the Console API (e.g. console.log). Using these in production code might negatively impact performance.

🐛 Fixed Issues

• apex-performance
  • #5139: [apex] OperationWithHighCostInLoop: false negative for triggers
• java
  • #5062: [java] Support Java 23
  • #5167: [java] java.lang.IllegalArgumentException: <?> cannot be a wildcard bound
• java-bestpractices
  • #3602: [java] GuardLogStatement: False positive when compile-time constant is created from external constants
  • #4731: [java] GuardLogStatement: Documentation is unclear why getters are flagged
  • #5145: [java] UnusedPrivateMethod: False positive with method calls inside lambda
  • #5151: [java] GuardLogStatement: Should not need to guard parameterized log messages where the replacement arg is a constant from another class
  • #5152: [java] GuardLogStatement: Should not need to guard parameterized log messages where the replacement arg is “this”
  • #5153: [java] GuardLogStatement: Should not need to guard parameterized log messages where the replacement arg is an array element
• java-design
  • #5048: [java] CognitiveComplexity: Exception when using Map.of()
  • #5162: [java] SingularField: False-positive when preceded by synchronized block
• java-multithreading
  • #5175: [java] Update AvoidSynchronizedAtMethodLevel message to mention ReentrantLock, new rule AvoidSynchronizedStatement
• javascript-performance
  • #5105: [javascript] Prohibit any console methods
• plsql
  • #5125: [plsql] Improve merge statement (order of merge insert/update flexible, allow prefixes in column names)
• plsql-bestpractices
  • #5132: [plsql] TomKytesDespair: XPathException for more complex exception handler

🚨 API Changes

Deprecations

• pmd-jsp
  • JspParserImpl is deprecated now. It should have been package-private because this is an implementation class that should not be used directly.
• pmd-plsql
  • MergeUpdateClausePrefix is deprecated. This production is not used anymore and will be removed. Note: The whole parser implementation class has been deprecated since 7.3.0, as it is supposed to be internalized.
• pmd-velocity
  • VtlParserImpl is deprecated now. It should have been package-private because this is an implementation class that should not be used directly.
• pmd-visualforce
  • VfParserImpl is deprecated now. It should have been package-private because this is an implementation class that should not be used directly.

Experimental

• pmd-java
  • Renamed isUnnamedClass() to ASTCompilationUnit#isSimpleCompilationUnit
  • ASTImplicitClassDeclaration
  • ASTImportDeclaration#isModuleImport
  • JavaVisitorBase#visit(ASTImplicitClassDeclaration, P)

✨ External Contributions

• #5125: [plsql] Improve merge statement (order of merge insert/update flexible, allow prefixes in column names) - Arjen Duursma (@duursma)
• #5175: [java] Update AvoidSynchronizedAtMethodLevel message to mention ReentrantLock, new rule AvoidSynchronizedStatement - Chas Honton (@chonton)

📦 Dependency updates

• #5100: Enable Dependabot
• #5141: Bump org.apache.maven.plugins:maven-checkstyle-plugin from 3.3.1 to 3.4.0
• #5142: Bump org.apache.maven.plugins:maven-compiler-plugin from 3.12.1 to 3.13.0
• #5144: Bump org.codehaus.mojo:versions-maven-plugin from 2.16.2 to 2.17.1
• #5148: Bump org.apache.commons:commons-text from 1.11.0 to 1.12.0
• #5149: Bump org.apache.maven.plugins:maven-site-plugin from 4.0.0-M13 to 4.0.0-M16
• #5160: Bump org.pcollections:pcollections from 3.2.0 to 4.0.2
• #5161: Bump danger from 9.4.3 to 9.5.0 in the all-gems group across 1 directory
• #5164: Bump org.apache.maven.plugins:maven-dependency-plugin from 3.6.1 to 3.7.1
• #5165: Bump the all-gems group across 1 directory with 2 updates
• #5171: Bump net.bytebuddy:byte-buddy-agent from 1.14.12 to 1.14.19
• #5180: Bump net.sf.saxon:Saxon-HE from 12.4 to 12.5

📈 Stats

• 87 commits
• 25 closed tickets & PRs
• Days since last release: 35

26-July-2024 - 7.4.0

The PMD team is pleased to announce PMD 7.4.0.

This is a minor release.

Table Of Contents

• 🌟 New and changed rules
  • New Rules
  • Changed rules
  • Renamed rules
• 🐛 Fixed Issues
• 🚨 API Changes
• ✨ External Contributions
• 📈 Stats

🌟 New and changed rules

New Rules

• The new Apex rule AvoidNonRestrictiveQueries finds SOQL and SOSL queries without a where or limit statement. This can quickly cause governor limit exceptions.

Changed rules

• ClassNamingConventions (Apex Codestyle): Two new properties to configure different patterns for inner classes and interfaces: innerClassPattern and innerInterfacePattern.

Renamed rules

• InaccurateNumericLiteral (JavaScript Error Prone) has been renamed from InnaccurateNumericLiteral. The old rule name still works but is deprecated.

🐛 Fixed Issues

• apex
  • #5094: [apex] “No adapter exists for type” error message printed to stdout instead of stderr
• apex-bestpractices
  • #5095: [apex] ApexUnitTestShouldNotUseSeeAllDataTrue false negative due to casing (regression in PMD 7)
• apex-codestyle
  • #4800: [apex] ClassNamingConvention: Support naming convention for inner classes
• apex-performance
  • #635: [apex] New Rule: Avoid soql/sosl queries without a where clause or limit statement
• java-bestpractices
  • #5106: [java] AccessorClassGeneration: Node was null for default constructor
  • #5110: [java] UnusedPrivateMethod for method referenced by lombok.Builder.ObtainVia
  • #5117: [java] UnusedPrivateMethod for methods annotated with jakarta.annotation.PostConstruct or PreDestroy
• java-errorprone
  • #1488: [java] MissingStaticMethodInNonInstantiatableClass: False positive with Lombok Builder on Constructor
• javascript-errorprone
  • #2367: [javascript] InnaccurateNumericLiteral is misspelled
  • #4716: [javascript] InaccurateNumericLiteral with number 259200000
• plsql
  • #5086: [plsql] Fixed issue with missing optional table alias in MERGE usage
  • #5087: [plsql] Add support for SQL_MACRO
  • #5088: [plsql] Add support for ‘DEFAULT’ clause on the arguments of some oracle functions
  • #5133: [plsql] AssertionError: Root of the tree should implement RootNode for a PL/SQL type declaration
• cli
  • #5120: [cli] Can’t start designer under Windows
• core
  • #5091: [core] PMD CPD v7.3.0 gives deprecation warning for skipLexicalErrors even when not used

🚨 API Changes

• javascript
  • The old rule name InnaccurateNumericLiteral has been deprecated. Use the new name InaccurateNumericLiteral instead.

✨ External Contributions

• #5048: [apex] Added Inner Classes to Apex Class Naming Conventions Rule - Justin Stroud (@justinstroudbah / @sgnl-labs)
• #5086: [plsql] Fixed issue with missing optional table alias in MERGE usage - Arjen Duursma (@duursma)
• #5087: [plsql] Add support for SQL_MACRO - Arjen Duursma (@duursma)
• #5088: [plsql] Add support for ‘DEFAULT’ clause on the arguments of some oracle functions - Arjen Duursma (@duursma)
• #5107: [doc] Update maven.md - Typo fixed for maven target - karthikaiyasamy (@karthikaiyasamy)
• #5109: [java] Exclude constructor with lombok.Builder for MissingStaticMethodInNonInstantiatableClass - Krzysztof Debski (@kdebski85)
• #5111: [java] Fix UnusedPrivateMethod for @lombok.Builder.ObtainVia - Krzysztof Debski (@kdebski85)
• #5118: [java] FP for UnusedPrivateMethod with Jakarta @PostConstruct/PreDestroy annotations - Krzysztof Debski (@kdebski85)
• #5121: [plsql] Fixed issue with missing optional table alias in MERGE usage - Arjen Duursma (@duursma)

📈 Stats

• 81 commits
• 32 closed tickets & PRs
• Days since last release: 27

28-June-2024 - 7.3.0

The PMD team is pleased to announce PMD 7.3.0.

This is a minor release.

Table Of Contents

• 🚀 New and noteworthy
  • ✨ New Rules
  • 💥 pmd-compat6 removed (breaking)
• 🐛 Fixed Issues
• 🚨 API Changes
  • CPD Report Format XML
  • CLI
  • Ant
  • Deprecated API
  • Breaking changes: pmd-compat6 removed
• 📈 Stats

🚀 New and noteworthy

✨ New Rules

• The new Java rule UseEnumCollections reports usages for HashSet and HashMap when the keys are of an enum type. The specialized enum collections are more space- and time-efficient.

💥 pmd-compat6 removed (breaking)

The already deprecated PMD 6 compatibility module (pmd-compat6) has been removed. It was intended to be used with older versions of the maven-pmd-plugin, but since maven-pmd-plugin 3.22.0, PMD 7 is supported directly and this module is not needed anymore.

If you currently use this dependency (net.sourceforge.pmd:pmd-compat6), remove it and upgrade maven-pmd-plugin to the latest version (3.23.0 or newer).

See also Maven PMD Plugin.

🐛 Fixed Issues

• cli
  • #2827: [cli] Consider processing errors in exit status
• core
  • #4396: [core] CPD is always case sensitive
  • #4992: [core] CPD: Include processing errors in XML report
  • #5066: [core] CPD throws java.lang.OutOfMemoryError: Java heap space (since 7.1.0)
• apex
  • #4922: [apex] SOQL syntax error with TYPEOF in sub-query
  • #5053: [apex] CPD fails to parse string literals with escaped characters
  • #5055: [apex] SOSL syntax error with WITH USER_MODE or WITH SYSTEM_MODE
• apex-bestpractices
  • #5000: [apex] UnusedLocalVariable FP with binds in SOSL / SOQL
• java
  • #4885: [java] AssertionError: Method should be accessible
  • #5050: [java] Problems with pattern variables in switch branches
• java-bestpractices
  • #577: [java] New Rule: Check that Map<K,V> is an EnumMap if K is an enum value
  • #5047: [java] UnusedPrivateMethod FP for Generics & Overloads
• plsql
  • #1934: [plsql] ParseException with MERGE statement in anonymous block
  • #2779: [plsql] Error while parsing statement with (Oracle) DML Error Logging
  • #4270: [plsql] Parsing exception COMPOUND TRIGGER with EXCEPTION handler

🚨 API Changes

CPD Report Format XML

There are some important changes:

1. The XML format will now use an XSD schema, that is available at https://pmd.github.io/schema/cpd-report_1_0_0.xsd. This schema defines the valid elements and attributes that one can expect from a CPD report.
2. The root element pmd-cpd contains the new attributes pmdVersion, timestamp and version. The latter is the schema version and is currently “1.0.0”.
3. The CPD XML report will now also contain recoverable errors as additional <error> elements.

See Report formats for CPD for an example.

The XML format should be compatible as only attributes and elements have been added. However, if you parse the document with a namespace aware parser, you might encounter some issues like no elements being found. In case the new format doesn’t work for you (e.g. namespaces, unexpected error elements), you can go back using the old format with the renderer “xmlold” (XMLOldRenderer). Note, that this old renderer is deprecated and only there for compatibility reasons. Whatever tooling is used to read the XML format should be updated.

CLI

• New exit code 5 introduced. PMD and CPD will exit now by default with exit code 5, if any recoverable error (e.g. parsing exception, lexing exception or rule exception) occurred. PMD will still create a report with all detected violations or duplications if recoverable errors occurred. Such errors mean, that the report might be incomplete, as either violations or duplications for an entire file or for a specific rule are missing. These cases can be considered as false-negatives.

  In any case, the root cause should be investigated. If it’s a problem in PMD itself, please create a bug report.

• New CLI parameter --no-fail-on-error to ignore such errors and not exit with code 5. By default, a build with errors will now fail and with that parameter, the previous behavior can be restored. This parameter is available for both PMD and CPD.

• The CLI parameter --skip-lexical-errors is deprecated. By default, lexical errors are skipped but the build is failed. Use the new parameter --[no-]fail-on-error instead to control whether to fail the build or not.

Ant

• CPDTask has a new parameter failOnError. It controls, whether to fail the build if any recoverable error occurred. By default, the build will fail. CPD will still create a report with all detected duplications, but the report might be incomplete.
• The parameter skipLexicalError in CPDTask is deprecated and ignored. Lexical errors are now always skipped. Use the new parameter failOnError instead to control whether to fail the build or not.

Deprecated API

• pmd-ant
  • CPDTask#setSkipLexicalErrors: Use setFailOnError instead to control, whether to ignore errors or fail the build.
• pmd-core
  • CPDConfiguration#isSkipLexicalErrors and setSkipLexicalErrors: Use setFailOnError to control whether to ignore errors or fail the build.
  • net.sourceforge.pmd.cpd.XMLOldRenderer (the CPD format “xmlold”).
  • The constructor AntlrToken#AntlrToken shouldn’t be used directly. Use AntlrTokenManager instead.
• pmd-java
  • ASTResource#getStableName and the corresponding attribute @StableName.
  • ASTRecordPattern#getVarId This method was added here by mistake. Record patterns don’t declare a pattern variable for the whole pattern, but rather for individual record components, which can be accessed via getComponentPatterns.
• pmd-plsql
  • PLSQLParserImpl is deprecated now. It should have been package-private because this is an implementation class that should not be used directly.
  • The node ASTKEYWORD_UNRESERVED is deprecated and is now removed from the AST.

Breaking changes: pmd-compat6 removed

The already deprecated PMD 6 compatibility module (pmd-compat6) has been removed. See above for details.

📈 Stats

• 88 commits
• 32 closed tickets & PRs
• Days since last release: 27

31-May-2024 - 7.2.0

The PMD team is pleased to announce PMD 7.2.0.

This is a minor release.

Table Of Contents

• 🚀 New and noteworthy
  • Collections exposed as XPath attributes
  • Updated PMD Designer
• 🐛 Fixed Issues
• 🚨 API Changes
  • Deprecated API
• ✨ External Contributions
• 📈 Stats

🚀 New and noteworthy

Collections exposed as XPath attributes

Up to now, all AST node getters would be exposed to XPath, as long as the return type was a primitive (boxed or unboxed), String or Enum. That meant that collections, even of these basic types, were not exposed, so for instance accessing Apex’s ASTUserClass.getInterfaceNames() to list the interfaces implemented by a class was impossible from XPath, and would require writing a Java rule to check it.

Since this release, PMD will also expose any getter returning a collection of any supported type as a sequence through an XPath attribute. They would require to use apropriate XQuery functions to manipulate the sequence. So for instance, to detect any given ASTUserClass in Apex that implements Queueable, it is now possible to write:

/UserClass[@InterfaceNames = 'Queueable']

Updated PMD Designer

This PMD release ships a new version of the pmd-designer. For the changes, see PMD Designer Changelog (7.2.0).

🐛 Fixed Issues

• core
  • #4467: [core] Expose collections from getters as XPath sequence attributes
  • #4978: [core] Referenced Rulesets do not emit details on validation errors
  • #4983: [cpd] Fix CPD crashes about unicode escapes
  • #5009: [core] Kotest tests aren’t picked up by surefire
• java
  • #4912: [java] Unable to parse some Java9+ resource references
  • #4973: [java] Stop parsing Java for CPD
  • #4980: [java] Bad intersection, unrelated class types java.lang.Object[] and java.lang.Number
  • #4988: [java] Fix impl of ASTVariableId::isResourceDeclaration / VariableId/@ResourceDeclaration
  • #4990: [java] Add an attribute @PackageQualifier to ASTClassType
  • #5006: [java] Bad intersection, unrelated class types Child and Parent<? extends Child>
  • #5029: [java] PMD 7.x throws stack overflow in TypeOps$ProjectionVisitor while parsing a Java class
• java-bestpractices
  • #4278: [java] UnusedPrivateMethod FP with Junit 5 @MethodSource and default factory method name
  • #4852: [java] ReplaceVectorWithList false-positive (neither Vector nor List usage)
  • #4975: [java] UnusedPrivateMethod false positive when using @MethodSource on a @Nested test
  • #4985: [java] UnusedPrivateMethod false-positive / method reference in combination with custom object
• java-codestyle
  • #1619: [java] LocalVariableCouldBeFinal on ‘size’ variable in for loop
  • #3122: [java] LocalVariableCouldBeFinal should consider blank local variables
  • #4903: [java] UnnecessaryBoxing, but explicit conversion is necessary
  • #4924: [java] UnnecessaryBoxing false positive in PMD 7.0.0 in lambda
  • #4930: [java] EmptyControlStatement should not allow empty try with concise resources
  • #4954: [java] LocalVariableNamingConventions should allow unnamed variables by default
  • #5028: [java] FormalParameterNamingConventions should accept unnamed parameters by default
• java-errorprone
  • #4042: [java] A false negative about the rule StringBufferInstantiationWithChar
  • #5007: [java] AvoidUsingOctalValues triggers on non-octal double literals with a leading 0
• java-multithreading
  • #2368: [java] False positive UnsynchronizedStaticFormatter in static initializer

🚨 API Changes

Deprecated API

• pmd-java
  • ASTResource#getStableName and the corresponding attribute @StableName

✨ External Contributions

• #5020: [java] Fix AvoidUsingOctalValues false-positive - Gold856 (@Gold856)

📈 Stats

• 152 commits
• 46 closed tickets & PRs
• Days since last release: 35

26-April-2024 - 7.1.0

The PMD team is pleased to announce PMD 7.1.0.

This is a minor release.

Table Of Contents

• 🚀 New and noteworthy
  • More robust CPD reports
  • ✨ New Rules
  • 🌟 Rule Changes
• 🐛 Fixed Issues
• 🚨 API Changes
  • Deprecated methods
• ✨ External Contributions
• 📈 Stats

🚀 New and noteworthy

More robust CPD reports

There were a number of circumstances, specially around (but not limited to) literal sequences, were CPD would report duplicate overlapping or partially overlapping matches. These have now been fixed, and CPD will report only the longest non-overlapping duplicate.

These improvements apply to all supported languages, irrespective of supported flags.

✨ New Rules

• The new Java rule UnnecessaryVarargsArrayCreation reports explicit array creation when a varargs is expected. This is more heavy to read and could be simplified.
• The new Java rule ConfusingArgumentToVarargsMethod reports some confusing situations where a varargs method is called with an inexact argument type. These may end up in a mismatch between the expected parameter type and the actual value.
• The new Java rule LambdaCanBeMethodReference reports lambda expressions that can be replaced with a method reference. Please read the documentation of the rule for more info. This rule is now part of the Quickstart ruleset.

🌟 Rule Changes

• JUnitTestsShouldIncludeAssert and JUnitTestContainsTooManyAsserts have a new property named extraAssertMethodNames. With this property, you can configure which additional static methods should be considered as valid verification methods. This allows to use custom mocking or assertion libraries.

🐛 Fixed Issues

• core
  • #494: [core] Adopt JApiCmp to enforce control over API changes
  • #4942: [core] CPD: --skip-duplicate-files has no effect (7.0.0 regression)
  • #4959: [core] Upgrade saxon to 12.4
• cli
  • #4791: [cli] Could not find or load main class
  • #4913: [cli] cpd-gui closes immediately
• doc
  • #4901: [doc] Improve documentation on usage of violationSuppressXPath
• apex
  • #4418: [apex] ASTAnnotation.getImage() does not return value as written in the class
• apex-errorprone
  • #3953: [apex] EmptyCatchBlock false positive with formal (doc) comments
• cpp
  • #2438: [cpp] Repeated Duplication blocks
• java
  • #4899: [java] Parsing failed in ParseLock#doParse() java.io.IOException: Stream closed
  • #4902: [java] “Bad intersection, unrelated class types” for Constable[] and Enum[]
  • #4947: [java] Broken TextBlock parser
• java-bestpractices
  • #1084: [java] Allow JUnitTestsShouldIncludeAssert to configure verification methods
  • #3216: [java] New rule: UnnecessaryVarargsArrayCreation
  • #4435: [java] [7.0-rc1] UnusedAssignment for used field
  • #4569: [java] ForLoopCanBeForeach reports on loop for (int i = 0; i < list.size(); i += 2)
  • #4618: [java] UnusedAssignment false positive with conditional assignments of fields
• java-codestyle
  • #4602: [java] UnnecessaryImport: false positives with static imports
  • #4785: [java] False Positive: PMD Incorrectly report violation for UnnecessaryImport
  • #4779: [java] Examples in documentation of MethodArgumentCanBeFinal do not trigger the rule
  • #4881: [java] ClassNamingConventions: interfaces are identified as abstract classes (regression in 7.0.0)
• java-design
  • #2440: [java] FinalFieldCouldBeStatic FN when the right side of the assignment is a constant expression
  • #3694: [java] SingularField ignores static variables
  • #4873: [java] AvoidCatchingGenericException: Can no longer suppress on the exception itself
• java-errorprone
  • #2056: [java] CloseResource false-positive with URLClassLoader in cast expression
  • #4751: [java] PMD crashes when analyzing CloseResource Rule
  • #4928: [java] EmptyCatchBlock false negative when allowCommentedBlocks=true
  • #4948: [java] ImplicitSwitchFallThrough: False-positive with nested switch statements
• java-performance
  • #3845: [java] InsufficientStringBufferDeclaration should consider literal expression
  • #4874: [java] StringInstantiation: False-positive when using new String(charArray)
  • #4886: [java] BigIntegerInstantiation: False Positive with Java 17 and BigDecimal.TWO
• pom-errorprone
  • #4388: [pom] InvalidDependencyTypes doesn’t consider dependencies at all
• misc
  • #4967: Fix reproducible build issues with 7.0.0

🚨 API Changes

Deprecated methods

• pmd-java
  • ASTLambdaExpression#getBlock and ASTLambdaExpression#getExpression
  • SingularFieldRule#mayBeSingular has been deprecated for removal. The method is only useful for the rule itself and shouldn’t be used otherwise.

✨ External Contributions

• #4864: Fix #1084 [Java] add extra assert method names to Junit rules - Erwan Moutymbo (@emouty)
• #4894: Fix #4791 Error caused by space in JDK path - Scrates1 (@Scrates1)

📈 Stats

• 205 commits
• 71 closed tickets & PRs
• Days since last release: 34

22-March-2024 - 7.0.0

🎉 After a long time, we’re excited to bring you now the next major version of PMD! 🎉

Since this is a big release, we provide here only a concise version of the release notes. We prepared a separate page with the full Detailed Release Notes for PMD 7.0.0.

🤝🙏 Many thanks to all users and contributors who were testing the release candidates and provided feedback and/or PRs!

✨ PMD 7…

• …has a new logo
• …analyzes Java 21 and Java 22 projects with even better type resolution and symbol table support
• …analyzes Kotlin and Swift
• …analyzes Apex with a new parser
• …finds duplicated code in Coco, Julia, TypeScript
• …ships 11 new rules and tons of improvements for existing rules
• …provides a new CLI interface with progress bar
• …supports Antlr based languages
• …and many more enhancements

💥 Note: Since PMD 7 is a major release, it is not a drop-in replacement for PMD 6.55.0. A detailed documentation of required changes are available in the Migration Guide for PMD 7.

<dependency>
  <groupId>net.sourceforge.pmd</groupId>
  <artifactId>pmd-compat6</artifactId>
  <version>${pmdVersion}</version>
</dependency>

export PMD_JAVA_OPTS=--enable-preview
pmd check --use-version java-22-preview ...

export PMD_JAVA_OPTS=--enable-preview
pmd check --use-version java-22-preview ...

30-September-2023 - 7.0.0-rc4

We’re excited to bring you the next major version of PMD!

Since this is a big release, we provide here only a concise version of the release notes. We prepared a separate page with the full Detailed Release Notes for PMD 7.0.0.

Table Of Contents

• Changes since 7.0.0-rc3
  • New and Noteworthy
    • Migration Guide for PMD 7
    • Apex Jorje Updated
    • Java 21 Support
  • Fixed issues
  • API Changes
    • pmd-java
    • Rule properties
    • New Programmatic API for CPD
    • Removed classes and methods
    • Moved packages
    • Changed types and other changes
    • Internal APIs
    • Deprecated API
    • Experimental APIs
  • External Contributions
• 🚀 Major Features and Enhancements
  • New official logo
  • Revamped Java module
  • Revamped Command Line Interface
  • Full Antlr support
  • Updated PMD Designer
  • New CPD report format cpdhtml-v2.xslt
• 🎉 Language Related Changes
  • New: Swift support
  • New: Kotlin support (experimental)
  • New: CPD support for TypeScript
  • New: CPD support for Julia
  • New: CPD support for Coco
  • New: Java 21 Support
  • Changed: JavaScript support
  • Changed: Language versions
  • Changed: CPP can now ignore identifiers in sequences (CPD)
  • Changed: Apex Jorje Updated
  • Changed: Rule properties
• 🌟 New and changed rules
  • New Rules
  • Changed Rules
  • Removed Rules
• 🚨 API
• 💥 Compatibility and migration notes
• 🐛 Fixed Issues
• ✨ External Contributions
• 📈 Stats

Changes since 7.0.0-rc3

This section lists the most important changes from the last release candidate. The remaining section describes the complete release notes for 7.0.0.

New and Noteworthy

Migration Guide for PMD 7

A detailed documentation of required changes are available in the Migration Guide for PMD 7.

Apex Jorje Updated

With the new version of Apex Jorje, the new language constructs like User Mode Database Operations can be parsed now. PMD should now be able to parse Apex code up to version 59.0 (Winter ‘23).

Java 21 Support

This release of PMD brings support for Java 21. There are the following new standard language features, that are supported now:

• JEP 440: Record Patterns
• JEP 441: Pattern Matching for switch

PMD also supports the following preview language features:

• JEP 430: String Templates (Preview)
• JEP 443: Unnamed Patterns and Variables (Preview)
• JEP 445: Unnamed Classes and Instance Main Methods (Preview)

In order to analyze a project with PMD that uses these language features, you’ll need to enable it via the environment variable PMD_JAVA_OPTS and select the new language version 21-preview:

export PMD_JAVA_OPTS=--enable-preview
pmd check --use-version java-21-preview ...

Note: Support for Java 19 preview language features have been removed. The version “19-preview” is no longer available.

Fixed issues

• miscellaneous
  • #4582: [dist] Download link broken
  • #4691: [CVEs] Critical and High CEVs reported on PMD and PMD dependencies
• core
  • #1204: [core] Allow numeric properties in XML to be within an unbounded range
  • #3919: [core] Merge CPD and PMD language
  • #4204: [core] Provide a CpdAnalysis class as a programmatic entry point into CPD
  • #4301: [core] Remove deprecated property concrete classes
  • #4302: [core] Migrate Property Framework API to Java 8
  • #4323: [core] Refactor CPD integration
  • #4397: [core] Refactor CPD
  • #4611: [core] Fix loading language properties from env vars
  • #4621: [core] Make ClasspathClassLoader::getResource child first
• cli
  • #4423: [cli] Fix NPE when only --file-list is specified
• doc
  • #4294: [doc] Migration Guide for upgrading PMD 6 ➡️ 7
  • #4303: [doc] Document new property framework
  • #4521: [doc] Website is not mobile friendly
• apex
  • #3973: [apex] Update parser to support new ‘as user’ keywords (User Mode for Database Operations)
  • #4453: [apex] [7.0-rc1] Exception while initializing Apexlink (Index 34812 out of bounds for length 34812)
• apex-design
  • #4596: [apex] ExcessivePublicCount ignores properties
• apex-security
  • #4646: [apex] ApexSOQLInjection does not recognise SObjectType or SObjectField as safe variable types
• java
  • #4401: [java] PMD 7 fails to build under Java 19
  • #4583: [java] Support JDK 21 (LTS)
• java-bestpractices
  • #4634: [java] JUnit4TestShouldUseTestAnnotation false positive with TestNG

API Changes

pmd-java

• Support for Java 19 preview language features have been removed. The version “19-preview” is no longer available.

Rule properties

• The old deprecated classes like IntProperty and StringProperty have been removed. Please use PropertyFactory to create properties.
• All properties which accept multiple values now use a comma (,) as a delimiter. The previous default was a pipe character (|). The delimiter is not configurable anymore. If needed, the comma can be escaped with a backslash.
• The min and max attributes in property definitions in the XML are now optional and can appear separately or be omitted.

New Programmatic API for CPD

See Detailed Release Notes for PMD 7 and PR #4397 for details.

Removed classes and methods

The following previously deprecated classes have been removed:

• pmd-core
  • net.sourceforge.pmd.cpd.AbstractTokenizer ➡️ use AnyTokenizer instead
  • net.sourceforge.pmd.cpd.CPD ➡️ use PmdCli from pmd-cli module for CLI support or use CpdAnalysis for programmatic API
  • net.sourceforge.pmd.cpd.GridBagHelper (now package private)
  • net.sourceforge.pmd.cpd.TokenEntry.State
  • net.sourceforge.pmd.lang.document.CpdCompat
  • net.sourceforge.pmd.properties.BooleanMultiProperty
  • net.sourceforge.pmd.properties.BooleanProperty
  • net.sourceforge.pmd.properties.CharacterMultiProperty
  • net.sourceforge.pmd.properties.CharacterProperty
  • net.sourceforge.pmd.properties.DoubleMultiProperty
  • net.sourceforge.pmd.properties.DoubleProperty
  • net.sourceforge.pmd.properties.EnumeratedMultiProperty
  • net.sourceforge.pmd.properties.EnumeratedProperty
  • net.sourceforge.pmd.properties.EnumeratedPropertyDescriptor
  • net.sourceforge.pmd.properties.FileProperty (note: without replacement)
  • net.sourceforge.pmd.properties.FloatMultiProperty
  • net.sourceforge.pmd.properties.FloatProperty
  • net.sourceforge.pmd.properties.IntegerMultiProperty
  • net.sourceforge.pmd.properties.IntegerProperty
  • net.sourceforge.pmd.properties.LongMultiProperty
  • net.sourceforge.pmd.properties.LongProperty
  • net.sourceforge.pmd.properties.MultiValuePropertyDescriptor
  • net.sourceforge.pmd.properties.NumericPropertyDescriptor
  • net.sourceforge.pmd.properties.PropertyDescriptorField
  • net.sourceforge.pmd.properties.RegexProperty
  • net.sourceforge.pmd.properties.SingleValuePropertyDescriptor
  • net.sourceforge.pmd.properties.StringMultiProperty
  • net.sourceforge.pmd.properties.StringProperty
  • net.sourceforge.pmd.properties.ValueParser
  • net.sourceforge.pmd.properties.ValueParserConstants
  • net.sourceforge.pmd.properties.builders.MultiNumericPropertyBuilder
  • net.sourceforge.pmd.properties.builders.MultiPackagedPropertyBuilder
  • net.sourceforge.pmd.properties.builders.MultiValuePropertyBuilder
  • net.sourceforge.pmd.properties.builders.PropertyDescriptorBuilder
  • net.sourceforge.pmd.properties.builders.PropertyDescriptorBuilderConversionWrapper
  • net.sourceforge.pmd.properties.builders.PropertyDescriptorExternalBuilder
  • net.sourceforge.pmd.properties.builders.SingleNumericPropertyBuilder
  • net.sourceforge.pmd.properties.builders.SinglePackagedPropertyBuilder
  • net.sourceforge.pmd.properties.builders.SingleValuePropertyBuilder
  • net.sourceforge.pmd.properties.modules.EnumeratedPropertyModule
  • net.sourceforge.pmd.properties.modules.NumericPropertyModule

The following previously deprecated methods have been removed:

• pmd-core
  • net.sourceforge.pmd.properties.PropertyBuilder.GenericCollectionPropertyBuilder#delim(char)
  • net.sourceforge.pmd.properties.PropertySource#setProperty(...)
  • net.sourceforge.pmd.properties.internal.PropertyTypeId#factoryFor(...)
  • net.sourceforge.pmd.properties.internal.PropertyTypeId#typeIdFor(...)
  • net.sourceforge.pmd.properties.PropertyDescriptor: removed methods errorFor, type, isMultiValue, uiOrder, compareTo, isDefinedExternally, valueFrom, asDelimitedString

The following methods have been removed:

• pmd-core
  • CPDConfiguration
    • #sourceCodeFor(File), #postConstruct(), #tokenizer(), #filenameFilter() removed
  • Mark
    • #getSourceSlice(), #setLineCount(int), #getLineCount(), #setSourceCode(SourceCode) removed
    • #getBeginColumn(), #getBeginLine(), #getEndLine(), #getEndColumn() removed ➡️ use getLocation instead
  • Match
    • #LABEL_COMPARATOR removed
    • #setMarkSet(...), #setLabel(...), #getLabel(), #addTokenEntry(...) removed
    • #getSourceCodeSlice() removed ➡️ use CPDReport#getSourceCodeSlice instead
  • TokenEntry
    • #getEOF(), #clearImages(), #getIdentifier(), #getIndex(), #setHashCode(int) removed
    • #EOF removed ➡️ use isEof instead
  • Parser.ParserTask
    • #getFileDisplayName() removed ➡️ use getFileId instead (getFileId().getAbsolutePath())

The following classes have been removed:

• pmd-core
  • net.sourceforge.pmd.cpd.AbstractLanguage
  • net.sourceforge.pmd.cpd.AnyLanguage
  • net.sourceforge.pmd.cpd.Language
  • net.sourceforge.pmd.cpd.LanguageFactory
  • net.sourceforge.pmd.cpd.MatchAlgorithm (now package private)
  • net.sourceforge.pmd.cpd.MatchCollector (now package private)
  • net.sourceforge.pmd.cpd.SourceCode (and all inner classes like FileCodeLoader, …)
  • net.sourceforge.pmd.cpd.token.TokenFilter

Moved packages

• pmd-core
  • NumericConstraints (old package: net.sourceforge.pmd.properties.constraints.NumericConstraints)
  • PropertyConstraint (old package: net.sourceforge.pmd.properties.constraints.PropertyConstraint)
    • not experimental anymore
  • ReportException (old package: net.sourceforge.pmd.cpd, moved to module pmd-ant)
    • it is now a RuntimeException
  • CPDReportRenderer (old package: net.sourceforge.pmd.cpd.renderer)
  • AntlrTokenFilter (old package: net.sourceforge.pmd.cpd.token)
  • BaseTokenFilter (old package: net.sourceforge.pmd.cpd.token.internal)
  • JavaCCTokenFilter (old package: net.sourceforge.pmd.cpd.token)

Changed types and other changes

• pmd-core
  • PropertyDescriptor is now a class (was an interface) and it is not comparable anymore.
  • AbstractConfiguration#setSourceEncoding
    • previously this method took a simple String for the encoding.
  • PmdConfiguration and CPDConfiguration
    • many getters and setters have been moved to the parent class AbstractConfiguration
  • CPDListener#addedFile
    • no File parameter anymore
  • CPDReport#getNumberOfTokensPerFile returns a Map of FileId,Integer instead of String
  • CPDReport#filterMatches now takes a java.util.function.Predicate as parameter
  • Tokenizer
    • constants are now PropertyDescriptor instead of String, to be used as language properties
    • tokenize changed parameters. Now takes a TextDocument and a TokenFactory (instead of SourceCode and Tokens)
  • Language
    • method #createProcessor(LanguagePropertyBundle) moved to PmdCapableLanguage
  • StringUtil#linesWithTrimIndent now takes a Chars instead of a String.
• All language modules (like pmd-apex, pmd-cpp, …)
  • consistent package naming: net.sourceforge.pmd.lang.<langId>.cpd
  • adapted to use CpdCapableLanguage
  • consistent static method #getInstance()
  • removed constants like ID, TERSE_NAME or NAME. Use getInstance().getName() etc. instead

Internal APIs

• Tokens
• PropertyTypeId

Deprecated API

• Language#getTerseName ➡️ use getId instead

• The method ASTPattern#getParenthesisDepth has been deprecated and will be removed. It was introduced for supporting parenthesized patterns, but that was removed with Java 21. It is only used when parsing code as java-19-preview.

Experimental APIs

• To support the Java preview language features “String Templates” and “Unnamed Patterns and Variables”, the following AST nodes have been introduced as experimental:
  • ASTTemplateExpression
  • ASTTemplate
  • ASTTemplateFragment
  • ASTUnnamedPattern
• The AST nodes for supporting “Record Patterns” and “Pattern Matching for switch” are not experimental anymore:
  • ASTRecordPattern
  • ASTPatternList (Note: it was renamed from ASTComponentPatternList)
  • ast (Note: it was renamed from ASTSwitchGuard)

External Contributions

• #4528: [apex] Update to apexlink - Kevin Jones (@nawforce)
• #4637: [java] fix #4634 - JUnit4TestShouldUseTestAnnotation false positive with TestNG - Krystian Dabrowski (@krdabrowski)
• #4649: [apex] Add SObjectType and SObjectField to list of injectable SOQL variable types - Richard Corfield (@rcorfieldffdc)
• #4651: [doc] Add “Tencent Cloud Code Analysis” in Tools / Integrations - yale (@cyw3)
• #4664: [cli] CPD: Fix NPE when only --file-list is specified - Wener (@wener-tiobe)
• #4665: [java] Doc: Fix references AutoClosable -> AutoCloseable - Andrey Bozhko (@AndreyBozhko)

🚀 Major Features and Enhancements

New official logo

The new official logo of PMD:

Revamped Java module

• Java grammar substantially refactored - more correct regarding the Java Language Specification (JLS)
• Built-in rules have been upgraded for the changed AST
• Rewritten type resolution framework and symbol table correctly implements the JLS
• AST exposes more semantic information (method calls, field accesses)

For more information, see the Detailed Release Notes for PMD 7.

Contributors: Clément Fournier (@oowekyala), Andreas Dangel (@adangel), Juan Martín Sotuyo Dodero (@jsotuyod)

Revamped Command Line Interface

• unified and consistent Command Line Interface for both Linux/Unix and Windows across our different utilities
• single script pmd (pmd.bat for Windows) to launch the different utilities:
  • pmd check to run PMD rules and analyze a project
  • pmd cpd to run CPD (copy paste detector)
  • pmd designer to run the PMD Rule Designer
• progress bar support for pmd check
• shell completion

For more information, see the Detailed Release Notes for PMD 7.

Contributors: Juan Martín Sotuyo Dodero (@jsotuyod)

Full Antlr support

• Antlr based grammars can now be used to build full-fledged PMD rules.
• Previously, Antlr grammar could only be used for CPD
• New supported languages: Swift and Kotlin

For more information, see the Detailed Release Notes for PMD 7.

Contributors: Lucas Soncini (@lsoncini), Matías Fraga (@matifraga), Tomás De Lucca (@tomidelucca)

Updated PMD Designer

This PMD release ships a new version of the pmd-designer. For the changes, see PMD Designer Changelog.

New CPD report format cpdhtml-v2.xslt

Thanks to @mohan-chinnappan-n a new CPD report format has been added which features a data table. It uses an XSLT stylesheet to convert CPD’s XML format into HTML.

See the example report.

🎉 Language Related Changes

Note that this is just a concise listing of the highlight. For more information on the languages, see the Detailed Release Notes for PMD 7.

New: Swift support

• use PMD to analyze Swift code with PMD rules
• initially 4 built-in rules

Contributors: Lucas Soncini (@lsoncini), Matías Fraga (@matifraga), Tomás De Lucca (@tomidelucca)

New: Kotlin support (experimental)

• use PMD to analyze Kotlin code with PMD rules
• Support for Kotlin 1.8 grammar
• initially 2 built-in rules

New: CPD support for TypeScript

Thanks to a contribution, CPD now supports the TypeScript language. It is shipped with the rest of the JavaScript support in the module pmd-javascript.

Contributors: Paul Guyot (@pguyot)

New: CPD support for Julia

Thanks to a contribution, CPD now supports the Julia language. It is shipped in the new module pmd-julia.

Contributors: Wener (@wener-tiobe)

New: CPD support for Coco

Thanks to a contribution, CPD now supports Coco, a modern programming language designed specifically for building event-driven software. It is shipped in the new module pmd-coco.

Contributors: Wener (@wener-tiobe)

New: Java 21 Support

This release of PMD brings support for Java 21. There are the following new standard language features, that are supported now:

• JEP 440: Record Patterns
• JEP 441: Pattern Matching for switch

PMD also supports the following preview language features:

• JEP 430: String Templates (Preview)
• JEP 443: Unnamed Patterns and Variables (Preview)
• JEP 445: Unnamed Classes and Instance Main Methods (Preview)

In order to analyze a project with PMD that uses these language features, you’ll need to enable it via the environment variable PMD_JAVA_OPTS and select the new language version 21-preview:

export PMD_JAVA_OPTS=--enable-preview
pmd check --use-version java-21-preview ...

Note: Support for Java 19 preview language features have been removed. The version “19-preview” is no longer available.

Changed: JavaScript support

• latest version supports ES6 and also some new constructs (see Rhino])
• comments are retained

Changed: Language versions

• more predefined language versions for each supported language
• can be used to limit rule execution for specific versions only with minimumLanguageVersion and maximumLanguageVersion attributes.

Changed: CPP can now ignore identifiers in sequences (CPD)

• new command line option for CPD: --ignore-sequences.
• This option is used for CPP only: with the already existing option --ignore-literal-sequences, only literals were ignored. The new option additional ignores identifiers as well in sequences.
• See PR #4470 for details.

Changed: Apex Jorje Updated

With the new version of Apex Jorje, the new language constructs like User Mode Database Operations can be parsed now. PMD should now be able to parse Apex code up to version 59.0 (Winter ‘23).

Changed: Rule properties

• The old deprecated classes like IntProperty and StringProperty have been removed. Please use PropertyFactory to create properties.
• All properties which accept multiple values now use a comma (,) as a delimiter. The previous default was a pipe character (|). The delimiter is not configurable anymore. If needed, the comma can be escaped with a backslash.
• The min and max attributes in property definitions in the XML are now optional and can appear separately or be omitted.

🌟 New and changed rules

New Rules

Apex

• UnusedMethod finds unused methods in your code.

Java

• UnnecessaryBoxing reports boxing and unboxing conversions that may be made implicit.

Kotlin

• FunctionNameTooShort
• OverrideBothEqualsAndHashcode

Swift

• ProhibitedInterfaceBuilder
• UnavailableFunction
• ForceCast
• ForceTry

Changed Rules

General changes

• All statistical rules (like ExcessiveClassLength, ExcessiveParameterList) have been simplified and unified. The properties topscore and sigma have been removed. The property minimum is still there, however the type is not a decimal number anymore but has been changed to an integer. This affects rules in the languages Apex, Java, PLSQL and Velocity Template Language (vm):
  • Apex: ExcessiveClassLength, ExcessiveParameterList, ExcessivePublicCount, NcssConstructorCount, NcssMethodCount, NcssTypeCount
  • Java: ExcessiveImports, ExcessiveParameterList, ExcessivePublicCount, SwitchDensity
  • PLSQL: ExcessiveMethodLength, ExcessiveObjectLength, ExcessivePackageBodyLength, ExcessivePackageSpecificationLength, ExcessiveParameterList, ExcessiveTypeLength, NcssMethodCount, NcssObjectCount, NPathComplexity
  • VM: ExcessiveTemplateLength
• The general property violationSuppressXPath which is available for all rules to suppress warnings now uses XPath version 3.1 by default. This version of the XPath language is mostly identical to XPath 2.0. In PMD 6, XPath 1.0 has been used. If you upgrade from PMD 6, you need to verify your violationSuppressXPath properties.

Apex General changes

• The properties cc_categories, cc_remediation_points_multiplier, cc_block_highlighting have been removed from all rules. These properties have been deprecated since PMD 6.13.0. See issue #1648 for more details.

Java General changes

• Violations reported on methods or classes previously reported the line range of the entire method or class. With PMD 7.0.0, the reported location is now just the identifier of the method or class. This affects various rules, e.g. CognitiveComplexity.

  The report location is controlled by the overrides of the method getReportLocation in different node types.

  See issue #4439 and issue #730 for more details.

Java Best Practices

• ArrayIsStoredDirectly: Violations are now reported on the assignment and not anymore on the formal parameter. The reported line numbers will probably move.
• AvoidReassigningLoopVariables: This rule might not report anymore all reassignments of the control variable in for-loops when the property forReassign is set to skip. See issue #4500 for more details.
• LooseCoupling: The rule has a new property to allow some types to be coupled to (allowedTypes).
• UnusedLocalVariable: This rule has some important false-negatives fixed and finds many more cases now. For details see issues #2130, #4516, and #4517.

Java Codestyle

• MethodNamingConventions: The property checkNativeMethods has been removed. The property was deprecated since PMD 6.3.0. Use the property nativePattern to control whether native methods should be considered or not.
• ShortVariable: This rule now also reports short enum constant names.
• UseDiamondOperator: The property java7Compatibility has been removed. The rule now handles Java 7 properly without a property.
• UnnecessaryFullyQualifiedName: The rule has two new properties, to selectively disable reporting on static field and method qualifiers. The rule also has been improved to be more precise.
• UselessParentheses: The rule has two new properties which control how strict the rule should be applied. With ignoreClarifying (default: true) parentheses that are strictly speaking not necessary are allowed, if they separate expressions of different precedence. The other property ignoreBalancing (default: true) is similar, in that it allows parentheses that help reading and understanding the expressions.

Java Design

• CyclomaticComplexity: The property reportLevel has been removed. The property was deprecated since PMD 6.0.0. The report level can now be configured separated for classes and methods using classReportLevel and methodReportLevel instead.
• ImmutableField: The property ignoredAnnotations has been removed. The property was deprecated since PMD 6.52.0.
• LawOfDemeter: The rule has a new property trustRadius. This defines the maximum degree of trusted data. The default of 1 is the most restrictive.
• NPathComplexity: The property minimum has been removed. It was deprecated since PMD 6.0.0. Use the property reportLevel instead.
• SingularField: The properties checkInnerClasses and disallowNotAssignment have been removed. The rule is now more precise and will check these cases properly.
• UseUtilityClass: The property ignoredAnnotations has been removed.

Java Documentation

• CommentContent: The properties caseSensitive and disallowedTerms are removed. The new property forbiddenRegex can be used now to define the disallowed terms with a single regular expression.
• CommentRequired:
  • Overridden methods are now detected even without the @Override annotation. This is relevant for the property methodWithOverrideCommentRequirement. See also pull request #3757.
  • Elements in annotation types are now detected as well. This might lead to an increased number of violations for missing public method comments.
• CommentSize: When determining the line-length of a comment, the leading comment prefix markers (e.g. * or //) are ignored and don’t add up to the line-length. See also pull request #4369.

Java Error Prone

• AvoidDuplicateLiterals: The property exceptionfile has been removed. The property was deprecated since PMD 6.10.0. Use the property exceptionList instead.
• DontImportSun: sun.misc.Signal is not special-cased anymore.
• EmptyCatchBlock: CloneNotSupportedException and InterruptedException are not special-cased anymore. Rename the exception parameter to ignored to ignore them.
• ImplicitSwitchFallThrough: Violations are now reported on the case statements rather than on the switch statements. This is more accurate but might result in more violations now.

Removed Rules

Many rules, that were previously deprecated have been finally removed. See Detailed Release Notes for PMD 7 for the complete list.

🚨 API

The API of PMD has been growing over the years and needed some cleanup. The goal is, to have a clear separation between a well-defined API and the implementation, which is internal. This should help us in future development.

Also, there are some improvement and changes in different areas. For the detailed description of the changes listed here, see Detailed Release Notes for PMD 7.

• Miscellaneous smaller changes and cleanups
• XPath 3.1 support for XPath-based rules
• Node stream API for AST traversal
• Metrics framework
• Testing framework
• Language Lifecycle and Language Properties
• Rule Properties
• New Programmatic API for CPD

💥 Compatibility and migration notes

A detailed documentation of required changes are available in the Migration Guide for PMD 7.

See also Detailed Release Notes for PMD 7.

🐛 Fixed Issues

• miscellaneous
  • #881: [all] Breaking API changes for 7.0.0
  • #896: [all] Use slf4j
  • #1431: [ui] Remove old GUI applications (designerold, bgastviewer)
  • #1451: [core] RulesetFactoryCompatibility stores the whole ruleset file in memory as a string
  • #2496: Update PMD 7 Logo on landing page
  • #2497: PMD 7 Logo page
  • #2498: Update PMD 7 Logo in documentation
  • #3797: [all] Use JUnit5
  • #4462: Provide Software Bill of Materials (SBOM)
  • #4460: Fix assembly-plugin warnings
  • #4582: [dist] Download link broken
  • #4691: [CVEs] Critical and High CEVs reported on PMD and PMD dependencies
• ant
  • #4080: [ant] Split off Ant integration into a new submodule
• core
  • #880: [core] Make visitors generic
  • #1204: [core] Allow numeric properties in XML to be within an unbounded range
  • #1622: [core] NodeStream API
  • #1687: [core] Deprecate and Remove XPath 1.0 support
  • #1785: [core] Allow abstract node types to be valid rulechain visits
  • #1825: [core] Support NoAttribute for XPath
  • #2038: [core] Remove DCD
  • #2218: [core] isFindBoundary should not be an attribute
  • #2234: [core] Consolidate PMD CLI into a single command
  • #2239: [core] Merging Javacc build scripts
  • #2500: [core] Clarify API for ANTLR based languages
  • #2518: [core] Language properties
  • #2602: [core] Remove ParserOptions
  • #2614: [core] Upgrade Saxon, add XPath 3.1, remove Jaxen
  • #2696: [core] Remove DFA
  • #2821: [core] Rule processing error filenames are missing paths
  • #2873: [core] Utility classes in pmd 7
  • #2885: [core] Error recovery mode
  • #3203: [core] Replace RuleViolationFactory implementations with ViolationDecorator
  • #3692: [core] Analysis listeners
  • #3782: [core] Language lifecycle
  • #3815: [core] Update Saxon HE to 10.7
  • #3893: [core] Text documents
  • #3902: [core] Violation decorators
  • #3918: [core] Make LanguageRegistry non static
  • #3919: [core] Merge CPD and PMD language
  • #3922: [core] Better error reporting for the ruleset parser
  • #4035: [core] ConcurrentModificationException in DefaultRuleViolationFactory
  • #4120: [core] Explicitly name all language versions
  • #4204: [core] Provide a CpdAnalysis class as a programmatic entry point into CPD
  • #4301: [core] Remove deprecated property concrete classes
  • #4302: [core] Migrate Property Framework API to Java 8
  • #4323: [core] Refactor CPD integration
  • #4353: [core] Micro optimizations for Node API
  • #4365: [core] Improve benchmarking
  • #4397: [core] Refactor CPD
  • #4420: [core] Remove PMD.EOL
  • #4425: [core] Replace TextFile::pathId
  • #4454: [core] “Unknown option: ‘-min’” but is referenced in documentation
  • #4611: [core] Fix loading language properties from env vars
  • #4621: [core] Make ClasspathClassLoader::getResource child first
• cli
  • #2234: [core] Consolidate PMD CLI into a single command
  • #3828: [core] Progress reporting
  • #4079: [cli] Split off CLI implementation into a pmd-cli submodule
  • #4423: [cli] Fix NPE when only --file-list is specified
  • #4482: [cli] pmd.bat can only be executed once
  • #4484: [cli] ast-dump with no properties produce an NPE
• doc
  • #2501: [doc] Verify ANTLR Documentation
  • #4294: [doc] Migration Guide for upgrading PMD 6 ➡️ 7
  • #4303: [doc] Document new property framework
  • #4438: [doc] Documentation links in VS Code are outdated
  • #4521: [doc] Website is not mobile friendly
• testing
  • #2435: [test] Remove duplicated Dummy language module
  • #4234: [test] Tests that change the logging level do not work

Language specific fixes:

• apex
  • #1937: [apex] Apex should only have a single RootNode
  • #1648: [apex,vf] Remove CodeClimate dependency
  • #1750: [apex] Remove apex statistical rules
  • #2836: [apex] Remove Apex ProjectMirror
  • #3973: [apex] Update parser to support new ‘as user’ keywords (User Mode for Database Operations)
  • #4427: [apex] ApexBadCrypto test failing to detect inline code
  • #4453: [apex] [7.0-rc1] Exception while initializing Apexlink (Index 34812 out of bounds for length 34812)
• apex-design
  • #2667: [apex] Integrate nawforce/ApexLink to build robust Unused rule
  • #4509: [apex] ExcessivePublicCount doesn’t consider inner classes correctly
  • #4596: [apex] ExcessivePublicCount ignores properties
• apex-security
  • #4646: [apex] ApexSOQLInjection does not recognise SObjectType or SObjectField as safe variable types
• java
  • #520: [java] Allow @SuppressWarnings with constants instead of literals
  • #864: [java] Similar/duplicated implementations for determining FQCN
  • #905: [java] Add new node for anonymous class declaration
  • #910: [java] AST inconsistency between primitive and reference type arrays
  • #997: [java] Java8 parsing corner case with annotated array types
  • #998: [java] AST inconsistencies around FormalParameter
  • #1019: [java] Breaking Java Grammar changes for PMD 7.0.0
  • #1124: [java] ImmutableList implementation in the qname codebase
  • #1128: [java] Improve ASTLocalVariableDeclaration
  • #1150: [java] ClassOrInterfaceType AST improvements
  • #1207: [java] Resolve explicit types using FQCNs, without hitting the classloader
  • #1367: [java] Parsing error on annotated inner class
  • #1661: [java] About operator nodes
  • #2366: [java] Remove qualified names
  • #2819: [java] GLB bugs in pmd 7
  • #3642: [java] Parse error on rare extra dimensions on method return type on annotation methods
  • #3763: [java] Ambiguous reference error in valid code
  • #3749: [java] Improve isOverridden in ASTMethodDeclaration
  • #3750: [java] Make symbol table support instanceof pattern bindings
  • #3752: [java] Expose annotations in symbol API
  • #4237: [java] Cleanup handling of Java comments
  • #4317: [java] Some AST nodes should not be TypeNodes
  • #4359: [java] Type resolution fails with NPE when the scope is not a type declaration
  • #4367: [java] Move testrule TypeResTest into internal
  • #4383: [java] IllegalStateException: Object is not an array type!
  • #4401: [java] PMD 7 fails to build under Java 19
  • #4405: [java] Processing error with ArrayIndexOutOfBoundsException
  • #4583: [java] Support JDK 21 (LTS)
• java-bestpractices
  • #342: [java] AccessorMethodGeneration: Name clash with another public field not properly handled
  • #755: [java] AccessorClassGeneration false positive for private constructors
  • #770: [java] UnusedPrivateMethod yields false positive for counter-variant arguments
  • #807: [java] AccessorMethodGeneration false positive with overloads
  • #833: [java] ForLoopCanBeForeach should consider iterating on this
  • #1189: [java] UnusedPrivateMethod false positive from inner class via external class
  • #1205: [java] Improve ConstantsInInterface message to mention alternatives
  • #1212: [java] Don’t raise JUnitTestContainsTooManyAsserts on JUnit 5’s assertAll
  • #1422: [java] JUnitTestsShouldIncludeAssert false positive with inherited @Rule field
  • #1455: [java] JUnitTestsShouldIncludeAssert: False positives for assert methods named “check” and “verify”
  • #1563: [java] ForLoopCanBeForeach false positive with method call using index variable
  • #1565: [java] JUnitAssertionsShouldIncludeMessage false positive with AssertJ
  • #1747: [java] PreserveStackTrace false-positive
  • #1969: [java] MissingOverride false-positive triggered by package-private method overwritten in another package by extending class
  • #1998: [java] AccessorClassGeneration false-negative: subclass calls private constructor
  • #2130: [java] UnusedLocalVariable: false-negative with array
  • #2147: [java] JUnitTestsShouldIncludeAssert - false positives with lambdas and static methods
  • #2464: [java] LooseCoupling must ignore class literals: ArrayList.class
  • #2542: [java] UseCollectionIsEmpty can not detect the case foo.bar().size()
  • #2650: [java] UseTryWithResources false positive when AutoCloseable helper used
  • #2796: [java] UnusedAssignment false positive with call chains
  • #2797: [java] MissingOverride long-standing issues
  • #2806: [java] SwitchStmtsShouldHaveDefault false-positive with Java 14 switch non-fallthrough branches
  • #2822: [java] LooseCoupling rule: Extend to cover user defined implementations and interfaces
  • #2843: [java] Fix UnusedAssignment FP with field accesses
  • #2882: [java] UseTryWithResources - false negative for explicit close
  • #2883: [java] JUnitAssertionsShouldIncludeMessage false positive with method call
  • #2890: [java] UnusedPrivateMethod false positive with generics
  • #2946: [java] SwitchStmtsShouldHaveDefault false positive on enum inside enums
  • #3672: [java] LooseCoupling - fix false positive with generics
  • #3675: [java] MissingOverride - fix false positive with mixing type vars
  • #3858: [java] UseCollectionIsEmpty should infer local variable type from method invocation
  • #4433: [java] [7.0-rc1] ReplaceHashtableWithMap on java.util.Properties
  • #4492: [java] GuardLogStatement gives false positive when argument is a Java method reference
  • #4503: [java] JUnitTestsShouldIncludeAssert: false negative with TestNG
  • #4516: [java] UnusedLocalVariable: false-negative with try-with-resources
  • #4517: [java] UnusedLocalVariable: false-negative with compound assignments
  • #4518: [java] UnusedLocalVariable: false-positive with multiple for-loop indices
  • #4634: [java] JUnit4TestShouldUseTestAnnotation false positive with TestNG
• java-codestyle
  • #1208: [java] PrematureDeclaration rule false-positive on variable declared to measure time
  • #1429: [java] PrematureDeclaration as result of method call (false positive)
  • #1480: [java] IdenticalCatchBranches false positive with return expressions
  • #1673: [java] UselessParentheses false positive with conditional operator
  • #1790: [java] UnnecessaryFullyQualifiedName false positive with enum constant
  • #1918: [java] UselessParentheses false positive with boolean operators
  • #2134: [java] PreserveStackTrace not handling Throwable.addSuppressed(...)
  • #2299: [java] UnnecessaryFullyQualifiedName false positive with similar package name
  • #2391: [java] UseDiamondOperator FP when expected type and constructed type have a different parameterization
  • #2528: [java] MethodNamingConventions - JUnit 5 method naming not support ParameterizedTest
  • #2739: [java] UselessParentheses false positive for string concatenation
  • #2748: [java] UnnecessaryCast false positive with unchecked cast
  • #2973: [java] New rule: UnnecessaryBoxing
  • #3195: [java] Improve rule UnnecessaryReturn to detect more cases
  • #3218: [java] Generalize UnnecessaryCast to flag all unnecessary casts
  • #3221: [java] PrematureDeclaration false positive for unused variables
  • #3238: [java] Improve ExprContext, fix FNs of UnnecessaryCast
  • #3500: [java] UnnecessaryBoxing - check for Integer.valueOf(String) calls
  • #4268: [java] CommentDefaultAccessModifier: false positive with TestNG annotations
  • #4273: [java] CommentDefaultAccessModifier ignoredAnnotations should include “org.junit.jupiter.api.extension.RegisterExtension” by default
  • #4357: [java] Fix IllegalStateException in UseDiamondOperator rule
  • #4432: [java] [7.0-rc1] UnnecessaryImport - Unused static import is being used
  • #4455: [java] FieldNamingConventions: false positive with lombok’s @UtilityClass
  • #4487: [java] UnnecessaryConstructor: false-positive with @Inject and @Autowired
  • #4511: [java] LocalVariableCouldBeFinal shouldn’t report unused variables
  • #4512: [java] MethodArgumentCouldBeFinal shouldn’t report unused parameters
  • #4557: [java] UnnecessaryImport FP with static imports of overloaded methods
• java-design
  • #1014: [java] LawOfDemeter: False positive with lambda expression
  • #1605: [java] LawOfDemeter: False positive for standard UTF-8 charset name
  • #2160: [java] Issues with Law of Demeter
  • #2175: [java] LawOfDemeter: False positive for chained methods with generic method call
  • #2179: [java] LawOfDemeter: False positive with static property access - should treat class-level property as global object, not dot-accessed property
  • #2180: [java] LawOfDemeter: False positive with Thread and ThreadLocalRandom
  • #2182: [java] LawOfDemeter: False positive with package-private access
  • #2188: [java] LawOfDemeter: False positive with fields assigned to local vars
  • #2536: [java] ClassWithOnlyPrivateConstructorsShouldBeFinal can’t detect inner class
  • #3668: [java] ClassWithOnlyPrivateConstructorsShouldBeFinal - fix FP with inner private classes
  • #3754: [java] SingularField false positive with read in while condition
  • #3786: [java] SimplifyBooleanReturns should consider operator precedence
  • #3840: [java] LawOfDemeter disallows method call on locally created object
  • #4238: [java] Make LawOfDemeter not use the rulechain
  • #4254: [java] ImmutableField - false positive with Lombok @Setter
  • #4434: [java] [7.0-rc1] ExceptionAsFlowControl when simply propagating
  • #4456: [java] FinalFieldCouldBeStatic: false positive with lombok’s @UtilityClass
  • #4477: [java] SignatureDeclareThrowsException: false-positive with TestNG annotations
  • #4490: [java] ImmutableField - false negative with Lombok @Getter
  • #4549: [java] Make LawOfDemeter results deterministic
• java-documentation
  • #4369: [java] Improve CommentSize
  • #4416: [java] Fix reported line number in CommentContentRule
• java-errorprone
  • #659: [java] MissingBreakInSwitch - last default case does not contain a break
  • #1005: [java] CloneMethodMustImplementCloneable triggers for interfaces
  • #1669: [java] NullAssignment - FP with ternay and null as constructor argument
  • #1899: [java] Recognize @SuppressWanings(“fallthrough”) for MissingBreakInSwitch
  • #2320: [java] NullAssignment - FP with ternary and null as method argument
  • #2532: [java] AvoidDecimalLiteralsInBigDecimalConstructor can not detect the case new BigDecimal(Expression)
  • #2579: [java] MissingBreakInSwitch detects the lack of break in the last case
  • #2880: [java] CompareObjectsWithEquals - false negative with type res
  • #2893: [java] Remove special cases from rule EmptyCatchBlock
  • #2894: [java] Improve MissingBreakInSwitch
  • #3071: [java] BrokenNullCheck FP with PMD 6.30.0
  • #3087: [java] UnnecessaryBooleanAssertion overlaps with SimplifiableTestAssertion
  • #3100: [java] UseCorrectExceptionLogging FP in 6.31.0
  • #3173: [java] UseProperClassLoader false positive
  • #3351: [java] ConstructorCallsOverridableMethod ignores abstract methods
  • #3400: [java] AvoidUsingOctalValues FN with underscores
  • #3843: [java] UseEqualsToCompareStrings should consider return type
  • #4063: [java] AvoidBranchingStatementAsLastInLoop: False-negative about try/finally block
  • #4356: [java] Fix NPE in CloseResourceRule
  • #4449: [java] AvoidAccessibilityAlteration: Possible false positive in AvoidAccessibilityAlteration rule when using Lambda expression
  • #4457: [java] OverrideBothEqualsAndHashcode: false negative with anonymous classes
  • #4493: [java] MissingStaticMethodInNonInstantiatableClass: false-positive about @Inject
  • #4505: [java] ImplicitSwitchFallThrough NPE in PMD 7.0.0-rc1
  • #4510: [java] ConstructorCallsOverridableMethod: false positive with lombok’s @Value
  • #4513: [java] UselessOperationOnImmutable various false negatives with String
  • #4514: [java] AvoidLiteralsInIfCondition false positive and negative for String literals when ignoreExpressions=true
  • #4546: [java] OverrideBothEqualsAndHashCode ignores records
• java-multithreading
  • #2537: [java] DontCallThreadRun can’t detect the case that call run() in this.run()
  • #2538: [java] DontCallThreadRun can’t detect the case that call run() in foo.bar.run()
  • #2577: [java] UseNotifyAllInsteadOfNotify falsely detect a special case with argument: foo.notify(bar)
  • #4483: [java] NonThreadSafeSingleton false positive with double-checked locking
• java-performance
  • #1224: [java] InefficientEmptyStringCheck false negative in anonymous class
  • #2587: [java] AvoidArrayLoops could also check for list copy through iterated List.add()
  • #2712: [java] SimplifyStartsWith false-positive with AssertJ
  • #3486: [java] InsufficientStringBufferDeclaration: Fix NPE
  • #3848: [java] StringInstantiation: false negative when using method result
  • #4070: [java] A false positive about the rule RedundantFieldInitializer
  • #4458: [java] RedundantFieldInitializer: false positive with lombok’s @Value
• kotlin
  • #419: [kotlin] Add support for Kotlin
  • #4389: [kotlin] Update grammar to version 1.8
• swift
  • #1877: [swift] Feature/swift rules
  • #1882: [swift] UnavailableFunction Swift rule
• xml
  • #1800: [xml] Unimplement org.w3c.dom.Node from the XmlNodeWrapper

✨ External Contributions

• #1658: [core] Node support for Antlr-based languages - Matías Fraga (@matifraga)
• #1698: [core] [swift] Antlr Base Parser adapter and Swift Implementation - Lucas Soncini (@lsoncini)
• #1774: [core] Antlr visitor rules - Lucas Soncini (@lsoncini)
• #1877: [swift] Feature/swift rules - Matías Fraga (@matifraga)
• #1881: [doc] Add ANTLR documentation - Matías Fraga (@matifraga)
• #1882: [swift] UnavailableFunction Swift rule - Tomás de Lucca (@tomidelucca)
• #2830: [apex] Apexlink POC - Kevin Jones (@nawforce)
• #3866: [core] Add CLI Progress Bar - @JerritEic (@JerritEic)
• #4402: [javascript] CPD: add support for Typescript using antlr4 grammar - Paul Guyot (@pguyot)
• #4403: [julia] CPD: Add support for Julia code duplication - Wener (@wener-tiobe)
• #4412: [doc] Added new error msg to ConstantsInInterface - David Ljunggren (@dague1)
• #4426: [cpd] New XML to HTML XLST report format for PMD CPD - mohan-chinnappan-n (@mohan-chinnappan-n)
• #4428: [apex] ApexBadCrypto bug fix for #4427 - inline detection of hard coded values - Steven Stearns (@sfdcsteve)
• #4431: [coco] CPD: Coco support for code duplication detection - Wener (@wener-tiobe)
• #4444: [java] CommentDefaultAccessModifier - ignore org.junit.jupiter.api.extension.RegisterExtension by default - Nirvik Patel (@nirvikpatel)
• #4450: [java] Fix #4449 AvoidAccessibilityAlteration: Correctly handle Lambda expressions in PrivilegedAction scenarios - Seren (@mohui1999)
• #4452: [doc] Update PMD_APEX_ROOT_DIRECTORY documentation reference - nwcm (@nwcm)
• #4470: [cpp] CPD: Added strings as literal and ignore identifiers in sequences - Wener (@wener-tiobe)
• #4474: [java] ImmutableField: False positive with lombok (fixes #4254) - Pim van der Loos (@PimvanderLoos)
• #4488: [java] Fix #4477: A false-positive about SignatureDeclareThrowsException - AnnaDev (@LynnBroe)
• #4494: [java] Fix #4487: A false-positive about UnnecessaryConstructor and @Inject and @Autowired - AnnaDev (@LynnBroe)
• #4495: [java] Fix #4493: false-positive about MissingStaticMethodInNonInstantiatableClass and @Inject - AnnaDev (@LynnBroe)
• #4507: [java] Fix #4503: A false negative about JUnitTestsShouldIncludeAssert and testng - AnnaDev (@LynnBroe)
• #4520: [doc] Fix typo: missing closing quotation mark after CPD-END - João Dinis Ferreira (@joaodinissf)
• #4528: [apex] Update to apexlink - Kevin Jones (@nawforce)
• #4533: [java] Fix #4063: False-negative about try/catch block in Loop - AnnaDev (@LynnBroe)
• #4536: [java] Fix #4268: CommentDefaultAccessModifier - false positive with TestNG’s @Test annotation - AnnaDev (@LynnBroe)
• #4537: [java] Fix #4455: A false positive about FieldNamingConventions and UtilityClass - AnnaDev (@LynnBroe)
• #4538: [java] Fix #4456: A false positive about FinalFieldCouldBeStatic and UtilityClass - AnnaDev (@LynnBroe)
• #4540: [java] Fix #4457: false negative about OverrideBothEqualsAndHashcode - AnnaDev (@LynnBroe)
• #4541: [java] Fix #4458: A false positive about RedundantFieldInitializer and @Value - AnnaDev (@LynnBroe)
• #4542: [java] Fix #4510: A false positive about ConstructorCallsOverridableMethod and @Value - AnnaDev (@LynnBroe)
• #4553: [java] Fix #4492: GuardLogStatement gives false positive when argument is a Java method reference - Anastasiia Koba (@anastasiia-koba)
• #4637: [java] fix #4634 - JUnit4TestShouldUseTestAnnotation false positive with TestNG - Krystian Dabrowski (@krdabrowski)
• #4649: [apex] Add SObjectType and SObjectField to list of injectable SOQL variable types - Richard Corfield (@rcorfieldffdc)
• #4651: [doc] Add “Tencent Cloud Code Analysis” in Tools / Integrations - yale (@cyw3)
• #4664: [cli] CPD: Fix NPE when only --file-list is specified - Wener (@wener-tiobe)
• #4665: [java] Doc: Fix references AutoClosable -> AutoCloseable - Andrey Bozhko (@AndreyBozhko)

📈 Stats

• 5007 commits
• 658 closed tickets & PRs
• Days since last release: 122

30-May-2023 - 7.0.0-rc3

We’re excited to bring you the next major version of PMD!

Since this is a big release, we provide here only a concise version of the release notes. We prepared a separate page with the full Detailed Release Notes for PMD 7.0.0.

Table Of Contents

• Changes since 7.0.0-rc2
  • New CPD report format cpdhtml-v2.xslt
  • Fixed issues
  • API Changes
  • External Contributions
• 🚀 Major Features and Enhancements
  • New official logo
  • Revamped Java module
  • Revamped Command Line Interface
  • Full Antlr support
  • Updated PMD Designer
  • New CPD report format cpdhtml-v2.xslt
• 🎉 Language Related Changes
  • New: Swift support
  • New: Kotlin support (experimental)
  • New: CPD support for TypeScript
  • New: CPD support for Julia
  • New: CPD support for Coco
  • Changed: JavaScript support
  • Changed: Language versions
  • Changed: CPP can now ignore identifiers in sequences (CPD)
• 🌟 New and changed rules
  • New Rules
  • Changed Rules
  • Removed Rules
• 🚨 API
• 💥 Compatibility and migration notes
• 🐛 Fixed Issues
• ✨ External Contributions
• 📈 Stats

Changes since 7.0.0-rc2

This section lists the most important changes from the last release candidate. The remaining section describes the complete release notes for 7.0.0.

New CPD report format cpdhtml-v2.xslt

Thanks to @mohan-chinnappan-n a new CPD report format has been added which features a data table. It uses an XSLT stylesheet to convert CPD’s XML format into HTML.

See the example report.

Fixed issues

• miscellaneous
  • #4460: Fix assembly-plugin warnings
• core
  • #4425: [core] Replace TextFile::pathId
  • #4454: [core] “Unknown option: ‘-min’” but is referenced in documentation
• java-bestpractices
  • #4433: [java] [7.0-rc1] ReplaceHashtableWithMap on java.util.Properties
  • #4492: [java] GuardLogStatement gives false positive when argument is a Java method reference
  • #4503: [java] JUnitTestsShouldIncludeAssert: false negative with TestNG
• java-codestyle
  • #4268: [java] CommentDefaultAccessModifier: false positive with TestNG annotations
  • #4432: [java] [7.0-rc1] UnnecessaryImport - Unused static import is being used
  • #4455: [java] FieldNamingConventions: false positive with lombok’s @UtilityClass
  • #4557: [java] UnnecessaryImport FP with static imports of overloaded methods
• java-design
  • #4434: [java] [7.0-rc1] ExceptionAsFlowControl when simply propagating
  • #4456: [java] FinalFieldCouldBeStatic: false positive with lombok’s @UtilityClass
  • #4549: [java] Make LawOfDemeter results deterministic
• java-errorprone
  • #4063: [java] AvoidBranchingStatementAsLastInLoop: False-negative about try/finally block
  • #4457: [java] OverrideBothEqualsAndHashcode: false negative with anonymous classes
  • #4510: [java] ConstructorCallsOverridableMethod: false positive with lombok’s @Value
  • #4546: [java] OverrideBothEqualsAndHashCode ignores records
• java-performance
  • #4458: [java] RedundantFieldInitializer: false positive with lombok’s @Value

API Changes

• The following previously deprecated classes have been removed:
  • pmd-core
    • net.sourceforge.pmd.PMD
    • net.sourceforge.pmd.cli.PMDCommandLineInterface
    • net.sourceforge.pmd.cli.PMDParameters
    • net.sourceforge.pmd.cli.PmdParametersParseResult

• The asset filenames of PMD on GitHub Releases are now pmd-dist-<version>-bin.zip, pmd-dist-<version>-src.zip and pmd-dist-<version>-doc.zip. Keep that in mind, if you have an automated download script.

  The structure inside the ZIP files stay the same, e.g. we still provide inside the binary distribution ZIP file the base directory pmd-bin-<version>.

• The CLI option --stress (or -stress) has been removed without replacement.
• The CLI option --minimum-priority was changed with 7.0.0-rc1 to only take the following values: High, Medium High, Medium, Medium Low, Low. With 7.0.0-rc2 compatibility has been restored, so that the equivalent integer values (1 to 5) are supported as well.

• Replaced RuleViolation::getFilename with new RuleViolation#getFileId, that returns a FileId. This is an identifier for a TextFile and could represent a path name. This allows to have a separate display name, e.g. renderers use FileNameRenderer to either display the full path name or a relative path name (see Renderer#setFileNameRenderer and ConfigurableFileNameRenderer). Many places where we used a simple String for a path-like name before have been adapted to use the new FileId.

  See PR #4425 for details.

External Contributions

• #4426: [cpd] New XML to HTML XLST report format for PMD CPD - mohan-chinnappan-n (@mohan-chinnappan-n)
• #4431: [coco] CPD: Coco support for code duplication detection - Wener (@wener-tiobe)
• #4470: [cpp] CPD: Added strings as literal and ignore identifiers in sequences - Wener (@wener-tiobe)
• #4507: [java] Fix #4503: A false negative about JUnitTestsShouldIncludeAssert and testng - AnnaDev (@LynnBroe)
• #4533: [java] Fix #4063: False-negative about try/catch block in Loop - AnnaDev (@LynnBroe)
• #4536: [java] Fix #4268: CommentDefaultAccessModifier - false positive with TestNG’s @Test annotation - AnnaDev (@LynnBroe)
• #4537: [java] Fix #4455: A false positive about FieldNamingConventions and UtilityClass - AnnaDev (@LynnBroe)
• #4538: [java] Fix #4456: A false positive about FinalFieldCouldBeStatic and UtilityClass - AnnaDev (@LynnBroe)
• #4540: [java] Fix #4457: false negative about OverrideBothEqualsAndHashcode - AnnaDev (@LynnBroe)
• #4541: [java] Fix #4458: A false positive about RedundantFieldInitializer and @Value - AnnaDev (@LynnBroe)
• #4542: [java] Fix #4510: A false positive about ConstructorCallsOverridableMethod and @Value - AnnaDev (@LynnBroe)
• #4553: [java] Fix #4492: GuardLogStatement gives false positive when argument is a Java method reference - Anastasiia Koba (@anastasiia-koba)

🚀 Major Features and Enhancements

New official logo

The new official logo of PMD:

Revamped Java module

• Java grammar substantially refactored - more correct regarding the Java Language Specification (JLS)
• Built-in rules have been upgraded for the changed AST
• Rewritten type resolution framework and symbol table correctly implements the JLS
• AST exposes more semantic information (method calls, field accesses)

For more information, see the Detailed Release Notes for PMD 7.

Contributors: Clément Fournier (@oowekyala), Andreas Dangel (@adangel), Juan Martín Sotuyo Dodero (@jsotuyod)

Revamped Command Line Interface

• unified and consistent Command Line Interface for both Linux/Unix and Windows across our different utilities
• single script pmd (pmd.bat for Windows) to launch the different utilities:
  • pmd check to run PMD rules and analyze a project
  • pmd cpd to run CPD (copy paste detector)
  • pmd designer to run the PMD Rule Designer
• progress bar support for pmd check
• shell completion

For more information, see the Detailed Release Notes for PMD 7.

Contributors: Juan Martín Sotuyo Dodero (@jsotuyod)

Full Antlr support

• Antlr based grammars can now be used to build full-fledged PMD rules.
• Previously, Antlr grammar could only be used for CPD
• New supported languages: Swift and Kotlin

For more information, see the Detailed Release Notes for PMD 7.

Contributors: Lucas Soncini (@lsoncini), Matías Fraga (@matifraga), Tomás De Lucca (@tomidelucca)

Updated PMD Designer

This PMD release ships a new version of the pmd-designer. For the changes, see PMD Designer Changelog.

New CPD report format cpdhtml-v2.xslt

Thanks to @mohan-chinnappan-n a new CPD report format has been added which features a data table. It uses an XSLT stylesheet to convert CPD’s XML format into HTML.

See the example report.

🎉 Language Related Changes

Note that this is just a concise listing of the highlight. For more information on the languages, see the Detailed Release Notes for PMD 7.

New: Swift support

• use PMD to analyze Swift code with PMD rules
• initially 4 built-in rules

Contributors: Lucas Soncini (@lsoncini), Matías Fraga (@matifraga), Tomás De Lucca (@tomidelucca)

New: Kotlin support (experimental)

• use PMD to analyze Kotlin code with PMD rules
• Support for Kotlin 1.8 grammar
• initially 2 built-in rules

New: CPD support for TypeScript

Thanks to a contribution, CPD now supports the TypeScript language. It is shipped with the rest of the JavaScript support in the module pmd-javascript.

Contributors: Paul Guyot (@pguyot)

New: CPD support for Julia

Thanks to a contribution, CPD now supports the Julia language. It is shipped in the new module pmd-julia.

Contributors: Wener (@wener-tiobe)

New: CPD support for Coco

Thanks to a contribution, CPD now supports Coco, a modern programming language designed specifically for building event-driven software. It is shipped in the new module pmd-coco.

Contributors: Wener (@wener-tiobe)

Changed: JavaScript support

• latest version supports ES6 and also some new constructs (see Rhino])
• comments are retained

Changed: Language versions

• more predefined language versions for each supported language
• can be used to limit rule execution for specific versions only with minimumLanguageVersion and maximumLanguageVersion attributes.

Changed: CPP can now ignore identifiers in sequences (CPD)

• new command line option for CPD: --ignore-sequences.
• This option is used for CPP only: with the already existing option --ignore-literal-sequences, only literals were ignored. The new option additional ignores identifiers as well in sequences.
• See PR #4470 for details.

🌟 New and changed rules

New Rules

Apex

• UnusedMethod finds unused methods in your code.

Java

• UnnecessaryBoxing reports boxing and unboxing conversions that may be made implicit.

Kotlin

• FunctionNameTooShort
• OverrideBothEqualsAndHashcode

Swift

• ProhibitedInterfaceBuilder
• UnavailableFunction
• ForceCast
• ForceTry

Changed Rules

General changes

• All statistical rules (like ExcessiveClassLength, ExcessiveParameterList) have been simplified and unified. The properties topscore and sigma have been removed. The property minimum is still there, however the type is not a decimal number anymore but has been changed to an integer. This affects rules in the languages Apex, Java, PLSQL and Velocity Template Language (vm):
  • Apex: ExcessiveClassLength, ExcessiveParameterList, ExcessivePublicCount, NcssConstructorCount, NcssMethodCount, NcssTypeCount
  • Java: ExcessiveImports, ExcessiveParameterList, ExcessivePublicCount, SwitchDensity
  • PLSQL: ExcessiveMethodLength, ExcessiveObjectLength, ExcessivePackageBodyLength, ExcessivePackageSpecificationLength, ExcessiveParameterList, ExcessiveTypeLength, NcssMethodCount, NcssObjectCount, NPathComplexity
  • VM: ExcessiveTemplateLength
• The general property violationSuppressXPath which is available for all rules to suppress warnings now uses XPath version 3.1 by default. This version of the XPath language is mostly identical to XPath 2.0. In PMD 6, XPath 1.0 has been used. If you upgrade from PMD 6, you need to verify your violationSuppressXPath properties.

Apex General changes

• The properties cc_categories, cc_remediation_points_multiplier, cc_block_highlighting have been removed from all rules. These properties have been deprecated since PMD 6.13.0. See issue #1648 for more details.

Java General changes

• Violations reported on methods or classes previously reported the line range of the entire method or class. With PMD 7.0.0, the reported location is now just the identifier of the method or class. This affects various rules, e.g. CognitiveComplexity.

  The report location is controlled by the overrides of the method getReportLocation in different node types.

  See issue #4439 and issue #730 for more details.

Java Best Practices

• ArrayIsStoredDirectly: Violations are now reported on the assignment and not anymore on the formal parameter. The reported line numbers will probably move.
• AvoidReassigningLoopVariables: This rule might not report anymore all reassignments of the control variable in for-loops when the property forReassign is set to skip. See issue #4500 for more details.
• LooseCoupling: The rule has a new property to allow some types to be coupled to (allowedTypes).
• UnusedLocalVariable: This rule has some important false-negatives fixed and finds many more cases now. For details see issues #2130, #4516, and #4517.

Java Codestyle

• MethodNamingConventions: The property checkNativeMethods has been removed. The property was deprecated since PMD 6.3.0. Use the property nativePattern to control whether native methods should be considered or not.
• ShortVariable: This rule now also reports short enum constant names.
• UseDiamondOperator: The property java7Compatibility has been removed. The rule now handles Java 7 properly without a property.
• UnnecessaryFullyQualifiedName: The rule has two new properties, to selectively disable reporting on static field and method qualifiers. The rule also has been improved to be more precise.
• UselessParentheses: The rule has two new properties which control how strict the rule should be applied. With ignoreClarifying (default: true) parentheses that are strictly speaking not necessary are allowed, if they separate expressions of different precedence. The other property ignoreBalancing (default: true) is similar, in that it allows parentheses that help reading and understanding the expressions.

Java Design

• CyclomaticComplexity: The property reportLevel has been removed. The property was deprecated since PMD 6.0.0. The report level can now be configured separated for classes and methods using classReportLevel and methodReportLevel instead.
• ImmutableField: The property ignoredAnnotations has been removed. The property was deprecated since PMD 6.52.0.
• LawOfDemeter: The rule has a new property trustRadius. This defines the maximum degree of trusted data. The default of 1 is the most restrictive.
• NPathComplexity: The property minimum has been removed. It was deprecated since PMD 6.0.0. Use the property reportLevel instead.
• SingularField: The properties checkInnerClasses and disallowNotAssignment have been removed. The rule is now more precise and will check these cases properly.
• UseUtilityClass: The property ignoredAnnotations has been removed.

Java Documentation

• CommentContent: The properties caseSensitive and disallowedTerms are removed. The new property forbiddenRegex can be used now to define the disallowed terms with a single regular expression.
• CommentRequired:
  • Overridden methods are now detected even without the @Override annotation. This is relevant for the property methodWithOverrideCommentRequirement. See also pull request #3757.
  • Elements in annotation types are now detected as well. This might lead to an increased number of violations for missing public method comments.
• CommentSize: When determining the line-length of a comment, the leading comment prefix markers (e.g. * or //) are ignored and don’t add up to the line-length. See also pull request #4369.

Java Error Prone

• AvoidDuplicateLiterals: The property exceptionfile has been removed. The property was deprecated since PMD 6.10.0. Use the property exceptionList instead.
• DontImportSun: sun.misc.Signal is not special-cased anymore.
• EmptyCatchBlock: CloneNotSupportedException and InterruptedException are not special-cased anymore. Rename the exception parameter to ignored to ignore them.
• ImplicitSwitchFallThrough: Violations are now reported on the case statements rather than on the switch statements. This is more accurate but might result in more violations now.

Removed Rules

Many rules, that were previously deprecated have been finally removed. See Detailed Release Notes for PMD 7 for the complete list.

🚨 API

The API of PMD has been growing over the years and needed some cleanup. The goal is, to have a clear separation between a well-defined API and the implementation, which is internal. This should help us in future development.

Also, there are some improvement and changes in different areas. For the detailed description of the changes listed here, see Detailed Release Notes for PMD 7.

• Miscellaneous smaller changes and cleanups
• XPath 3.1 support for XPath-based rules
• Node stream API for AST traversal
• Metrics framework
• Testing framework
• Language Lifecycle and Language Properties

💥 Compatibility and migration notes

See Detailed Release Notes for PMD 7.

🐛 Fixed Issues

• miscellaneous
  • #881: [all] Breaking API changes for 7.0.0
  • #896: [all] Use slf4j
  • #1431: [ui] Remove old GUI applications (designerold, bgastviewer)
  • #1451: [core] RulesetFactoryCompatibility stores the whole ruleset file in memory as a string
  • #2496: Update PMD 7 Logo on landing page
  • #2497: PMD 7 Logo page
  • #2498: Update PMD 7 Logo in documentation
  • #3797: [all] Use JUnit5
  • #4462: Provide Software Bill of Materials (SBOM)
  • #4460: Fix assembly-plugin warnings
• ant
  • #4080: [ant] Split off Ant integration into a new submodule
• core
  • #880: [core] Make visitors generic
  • #1622: [core] NodeStream API
  • #1687: [core] Deprecate and Remove XPath 1.0 support
  • #1785: [core] Allow abstract node types to be valid rulechain visits
  • #1825: [core] Support NoAttribute for XPath
  • #2038: [core] Remove DCD
  • #2218: [core] isFindBoundary should not be an attribute
  • #2234: [core] Consolidate PMD CLI into a single command
  • #2239: [core] Merging Javacc build scripts
  • #2500: [core] Clarify API for ANTLR based languages
  • #2518: [core] Language properties
  • #2602: [core] Remove ParserOptions
  • #2614: [core] Upgrade Saxon, add XPath 3.1, remove Jaxen
  • #2696: [core] Remove DFA
  • #2821: [core] Rule processing error filenames are missing paths
  • #2873: [core] Utility classes in pmd 7
  • #2885: [core] Error recovery mode
  • #3203: [core] Replace RuleViolationFactory implementations with ViolationDecorator
  • #3692: [core] Analysis listeners
  • #3782: [core] Language lifecycle
  • #3815: [core] Update Saxon HE to 10.7
  • #3893: [core] Text documents
  • #3902: [core] Violation decorators
  • #3918: [core] Make LanguageRegistry non static
  • #3922: [core] Better error reporting for the ruleset parser
  • #4035: [core] ConcurrentModificationException in DefaultRuleViolationFactory
  • #4120: [core] Explicitly name all language versions
  • #4353: [core] Micro optimizations for Node API
  • #4365: [core] Improve benchmarking
  • #4420: [core] Remove PMD.EOL
  • #4425: [core] Replace TextFile::pathId
  • #4454: [core] “Unknown option: ‘-min’” but is referenced in documentation
• cli
  • #2234: [core] Consolidate PMD CLI into a single command
  • #3828: [core] Progress reporting
  • #4079: [cli] Split off CLI implementation into a pmd-cli submodule
  • #4482: [cli] pmd.bat can only be executed once
  • #4484: [cli] ast-dump with no properties produce an NPE
• doc
  • #2501: [doc] Verify ANTLR Documentation
  • #4438: [doc] Documentation links in VS Code are outdated
• testing
  • #2435: [test] Remove duplicated Dummy language module
  • #4234: [test] Tests that change the logging level do not work

Language specific fixes:

• apex
  • #1937: [apex] Apex should only have a single RootNode
  • #1648: [apex,vf] Remove CodeClimate dependency
  • #1750: [apex] Remove apex statistical rules
  • #2836: [apex] Remove Apex ProjectMirror
  • #4427: [apex] ApexBadCrypto test failing to detect inline code
• apex-design
  • #2667: [apex] Integrate nawforce/ApexLink to build robust Unused rule
  • #4509: [apex] ExcessivePublicCount doesn’t consider inner classes correctly
• java
  • #520: [java] Allow @SuppressWarnings with constants instead of literals
  • #864: [java] Similar/duplicated implementations for determining FQCN
  • #905: [java] Add new node for anonymous class declaration
  • #910: [java] AST inconsistency between primitive and reference type arrays
  • #997: [java] Java8 parsing corner case with annotated array types
  • #998: [java] AST inconsistencies around FormalParameter
  • #1019: [java] Breaking Java Grammar changes for PMD 7.0.0
  • #1124: [java] ImmutableList implementation in the qname codebase
  • #1128: [java] Improve ASTLocalVariableDeclaration
  • #1150: [java] ClassOrInterfaceType AST improvements
  • #1207: [java] Resolve explicit types using FQCNs, without hitting the classloader
  • #1367: [java] Parsing error on annotated inner class
  • #1661: [java] About operator nodes
  • #2366: [java] Remove qualified names
  • #2819: [java] GLB bugs in pmd 7
  • #3642: [java] Parse error on rare extra dimensions on method return type on annotation methods
  • #3763: [java] Ambiguous reference error in valid code
  • #3749: [java] Improve isOverridden in ASTMethodDeclaration
  • #3750: [java] Make symbol table support instanceof pattern bindings
  • #3752: [java] Expose annotations in symbol API
  • #4237: [java] Cleanup handling of Java comments
  • #4317: [java] Some AST nodes should not be TypeNodes
  • #4359: [java] Type resolution fails with NPE when the scope is not a type declaration
  • #4367: [java] Move testrule TypeResTest into internal
  • #4383: [java] IllegalStateException: Object is not an array type!
  • #4405: [java] Processing error with ArrayIndexOutOfBoundsException
• java-bestpractices
  • #342: [java] AccessorMethodGeneration: Name clash with another public field not properly handled
  • #755: [java] AccessorClassGeneration false positive for private constructors
  • #770: [java] UnusedPrivateMethod yields false positive for counter-variant arguments
  • #807: [java] AccessorMethodGeneration false positive with overloads
  • #833: [java] ForLoopCanBeForeach should consider iterating on this
  • #1189: [java] UnusedPrivateMethod false positive from inner class via external class
  • #1205: [java] Improve ConstantsInInterface message to mention alternatives
  • #1212: [java] Don’t raise JUnitTestContainsTooManyAsserts on JUnit 5’s assertAll
  • #1422: [java] JUnitTestsShouldIncludeAssert false positive with inherited @Rule field
  • #1455: [java] JUnitTestsShouldIncludeAssert: False positives for assert methods named “check” and “verify”
  • #1563: [java] ForLoopCanBeForeach false positive with method call using index variable
  • #1565: [java] JUnitAssertionsShouldIncludeMessage false positive with AssertJ
  • #1747: [java] PreserveStackTrace false-positive
  • #1969: [java] MissingOverride false-positive triggered by package-private method overwritten in another package by extending class
  • #1998: [java] AccessorClassGeneration false-negative: subclass calls private constructor
  • #2130: [java] UnusedLocalVariable: false-negative with array
  • #2147: [java] JUnitTestsShouldIncludeAssert - false positives with lambdas and static methods
  • #2464: [java] LooseCoupling must ignore class literals: ArrayList.class
  • #2542: [java] UseCollectionIsEmpty can not detect the case foo.bar().size()
  • #2650: [java] UseTryWithResources false positive when AutoCloseable helper used
  • #2796: [java] UnusedAssignment false positive with call chains
  • #2797: [java] MissingOverride long-standing issues
  • #2806: [java] SwitchStmtsShouldHaveDefault false-positive with Java 14 switch non-fallthrough branches
  • #2822: [java] LooseCoupling rule: Extend to cover user defined implementations and interfaces
  • #2843: [java] Fix UnusedAssignment FP with field accesses
  • #2882: [java] UseTryWithResources - false negative for explicit close
  • #2883: [java] JUnitAssertionsShouldIncludeMessage false positive with method call
  • #2890: [java] UnusedPrivateMethod false positive with generics
  • #2946: [java] SwitchStmtsShouldHaveDefault false positive on enum inside enums
  • #3672: [java] LooseCoupling - fix false positive with generics
  • #3675: [java] MissingOverride - fix false positive with mixing type vars
  • #3858: [java] UseCollectionIsEmpty should infer local variable type from method invocation
  • #4433: [java] [7.0-rc1] ReplaceHashtableWithMap on java.util.Properties
  • #4492: [java] GuardLogStatement gives false positive when argument is a Java method reference
  • #4503: [java] JUnitTestsShouldIncludeAssert: false negative with TestNG
  • #4516: [java] UnusedLocalVariable: false-negative with try-with-resources
  • #4517: [java] UnusedLocalVariable: false-negative with compound assignments
  • #4518: [java] UnusedLocalVariable: false-positive with multiple for-loop indices
• java-codestyle
  • #1208: [java] PrematureDeclaration rule false-positive on variable declared to measure time
  • #1429: [java] PrematureDeclaration as result of method call (false positive)
  • #1480: [java] IdenticalCatchBranches false positive with return expressions
  • #1673: [java] UselessParentheses false positive with conditional operator
  • #1790: [java] UnnecessaryFullyQualifiedName false positive with enum constant
  • #1918: [java] UselessParentheses false positive with boolean operators
  • #2134: [java] PreserveStackTrace not handling Throwable.addSuppressed(...)
  • #2299: [java] UnnecessaryFullyQualifiedName false positive with similar package name
  • #2391: [java] UseDiamondOperator FP when expected type and constructed type have a different parameterization
  • #2528: [java] MethodNamingConventions - JUnit 5 method naming not support ParameterizedTest
  • #2739: [java] UselessParentheses false positive for string concatenation
  • #2748: [java] UnnecessaryCast false positive with unchecked cast
  • #2973: [java] New rule: UnnecessaryBoxing
  • #3195: [java] Improve rule UnnecessaryReturn to detect more cases
  • #3218: [java] Generalize UnnecessaryCast to flag all unnecessary casts
  • #3221: [java] PrematureDeclaration false positive for unused variables
  • #3238: [java] Improve ExprContext, fix FNs of UnnecessaryCast
  • #3500: [java] UnnecessaryBoxing - check for Integer.valueOf(String) calls
  • #4268: [java] CommentDefaultAccessModifier: false positive with TestNG annotations
  • #4273: [java] CommentDefaultAccessModifier ignoredAnnotations should include “org.junit.jupiter.api.extension.RegisterExtension” by default
  • #4357: [java] Fix IllegalStateException in UseDiamondOperator rule
  • #4432: [java] [7.0-rc1] UnnecessaryImport - Unused static import is being used
  • #4455: [java] FieldNamingConventions: false positive with lombok’s @UtilityClass
  • #4487: [java] UnnecessaryConstructor: false-positive with @Inject and @Autowired
  • #4511: [java] LocalVariableCouldBeFinal shouldn’t report unused variables
  • #4512: [java] MethodArgumentCouldBeFinal shouldn’t report unused parameters
  • #4557: [java] UnnecessaryImport FP with static imports of overloaded methods
• java-design
  • #1014: [java] LawOfDemeter: False positive with lambda expression
  • #1605: [java] LawOfDemeter: False positive for standard UTF-8 charset name
  • #2160: [java] Issues with Law of Demeter
  • #2175: [java] LawOfDemeter: False positive for chained methods with generic method call
  • #2179: [java] LawOfDemeter: False positive with static property access - should treat class-level property as global object, not dot-accessed property
  • #2180: [java] LawOfDemeter: False positive with Thread and ThreadLocalRandom
  • #2182: [java] LawOfDemeter: False positive with package-private access
  • #2188: [java] LawOfDemeter: False positive with fields assigned to local vars
  • #2536: [java] ClassWithOnlyPrivateConstructorsShouldBeFinal can’t detect inner class
  • #3668: [java] ClassWithOnlyPrivateConstructorsShouldBeFinal - fix FP with inner private classes
  • #3754: [java] SingularField false positive with read in while condition
  • #3786: [java] SimplifyBooleanReturns should consider operator precedence
  • #3840: [java] LawOfDemeter disallows method call on locally created object
  • #4238: [java] Make LawOfDemeter not use the rulechain
  • #4254: [java] ImmutableField - false positive with Lombok @Setter
  • #4434: [java] [7.0-rc1] ExceptionAsFlowControl when simply propagating
  • #4456: [java] FinalFieldCouldBeStatic: false positive with lombok’s @UtilityClass
  • #4477: [java] SignatureDeclareThrowsException: false-positive with TestNG annotations
  • #4490: [java] ImmutableField - false negative with Lombok @Getter
  • #4549: [java] Make LawOfDemeter results deterministic
• java-documentation
  • #4369: [java] Improve CommentSize
  • #4416: [java] Fix reported line number in CommentContentRule
• java-errorprone
  • #659: [java] MissingBreakInSwitch - last default case does not contain a break
  • #1005: [java] CloneMethodMustImplementCloneable triggers for interfaces
  • #1669: [java] NullAssignment - FP with ternay and null as constructor argument
  • #1899: [java] Recognize @SuppressWanings(“fallthrough”) for MissingBreakInSwitch
  • #2320: [java] NullAssignment - FP with ternary and null as method argument
  • #2532: [java] AvoidDecimalLiteralsInBigDecimalConstructor can not detect the case new BigDecimal(Expression)
  • #2579: [java] MissingBreakInSwitch detects the lack of break in the last case
  • #2880: [java] CompareObjectsWithEquals - false negative with type res
  • #2893: [java] Remove special cases from rule EmptyCatchBlock
  • #2894: [java] Improve MissingBreakInSwitch
  • #3071: [java] BrokenNullCheck FP with PMD 6.30.0
  • #3087: [java] UnnecessaryBooleanAssertion overlaps with SimplifiableTestAssertion
  • #3100: [java] UseCorrectExceptionLogging FP in 6.31.0
  • #3173: [java] UseProperClassLoader false positive
  • #3351: [java] ConstructorCallsOverridableMethod ignores abstract methods
  • #3400: [java] AvoidUsingOctalValues FN with underscores
  • #3843: [java] UseEqualsToCompareStrings should consider return type
  • #4063: [java] AvoidBranchingStatementAsLastInLoop: False-negative about try/finally block
  • #4356: [java] Fix NPE in CloseResourceRule
  • #4449: [java] AvoidAccessibilityAlteration: Possible false positive in AvoidAccessibilityAlteration rule when using Lambda expression
  • #4457: [java] OverrideBothEqualsAndHashcode: false negative with anonymous classes
  • #4493: [java] MissingStaticMethodInNonInstantiatableClass: false-positive about @Inject
  • #4505: [java] ImplicitSwitchFallThrough NPE in PMD 7.0.0-rc1
  • #4510: [java] ConstructorCallsOverridableMethod: false positive with lombok’s @Value
  • #4513: [java] UselessOperationOnImmutable various false negatives with String
  • #4514: [java] AvoidLiteralsInIfCondition false positive and negative for String literals when ignoreExpressions=true
  • #4546: [java] OverrideBothEqualsAndHashCode ignores records
• java-multithreading
  • #2537: [java] DontCallThreadRun can’t detect the case that call run() in this.run()
  • #2538: [java] DontCallThreadRun can’t detect the case that call run() in foo.bar.run()
  • #2577: [java] UseNotifyAllInsteadOfNotify falsely detect a special case with argument: foo.notify(bar)
  • #4483: [java] NonThreadSafeSingleton false positive with double-checked locking
• java-performance
  • #1224: [java] InefficientEmptyStringCheck false negative in anonymous class
  • #2587: [java] AvoidArrayLoops could also check for list copy through iterated List.add()
  • #2712: [java] SimplifyStartsWith false-positive with AssertJ
  • #3486: [java] InsufficientStringBufferDeclaration: Fix NPE
  • #3848: [java] StringInstantiation: false negative when using method result
  • #4070: [java] A false positive about the rule RedundantFieldInitializer
  • #4458: [java] RedundantFieldInitializer: false positive with lombok’s @Value
• kotlin
  • #419: [kotlin] Add support for Kotlin
  • #4389: [kotlin] Update grammar to version 1.8
• swift
  • #1877: [swift] Feature/swift rules
  • #1882: [swift] UnavailableFunction Swift rule
• xml
  • #1800: [xml] Unimplement org.w3c.dom.Node from the XmlNodeWrapper

✨ External Contributions

• #1658: [core] Node support for Antlr-based languages - Matías Fraga (@matifraga)
• #1698: [core] [swift] Antlr Base Parser adapter and Swift Implementation - Lucas Soncini (@lsoncini)
• #1774: [core] Antlr visitor rules - Lucas Soncini (@lsoncini)
• #1877: [swift] Feature/swift rules - Matías Fraga (@matifraga)
• #1881: [doc] Add ANTLR documentation - Matías Fraga (@matifraga)
• #1882: [swift] UnavailableFunction Swift rule - Tomás de Lucca (@tomidelucca)
• #2830: [apex] Apexlink POC - Kevin Jones (@nawforce)
• #3866: [core] Add CLI Progress Bar - @JerritEic (@JerritEic)
• #4402: [javascript] CPD: add support for Typescript using antlr4 grammar - Paul Guyot (@pguyot)
• #4403: [julia] CPD: Add support for Julia code duplication - Wener (@wener-tiobe)
• #4412: [doc] Added new error msg to ConstantsInInterface - David Ljunggren (@dague1)
• #4426: [cpd] New XML to HTML XLST report format for PMD CPD - mohan-chinnappan-n (@mohan-chinnappan-n)
• #4428: [apex] ApexBadCrypto bug fix for #4427 - inline detection of hard coded values - Steven Stearns (@sfdcsteve)
• #4431: [coco] CPD: Coco support for code duplication detection - Wener (@wener-tiobe)
• #4444: [java] CommentDefaultAccessModifier - ignore org.junit.jupiter.api.extension.RegisterExtension by default - Nirvik Patel (@nirvikpatel)
• #4450: [java] Fix #4449 AvoidAccessibilityAlteration: Correctly handle Lambda expressions in PrivilegedAction scenarios - Seren (@mohui1999)
• #4452: [doc] Update PMD_APEX_ROOT_DIRECTORY documentation reference - nwcm (@nwcm)
• #4470: [cpp] CPD: Added strings as literal and ignore identifiers in sequences - Wener (@wener-tiobe)
• #4474: [java] ImmutableField: False positive with lombok (fixes #4254) - Pim van der Loos (@PimvanderLoos)
• #4488: [java] Fix #4477: A false-positive about SignatureDeclareThrowsException - AnnaDev (@LynnBroe)
• #4494: [java] Fix #4487: A false-positive about UnnecessaryConstructor and @Inject and @Autowired - AnnaDev (@LynnBroe)
• #4495: [java] Fix #4493: false-positive about MissingStaticMethodInNonInstantiatableClass and @Inject - AnnaDev (@LynnBroe)
• #4507: [java] Fix #4503: A false negative about JUnitTestsShouldIncludeAssert and testng - AnnaDev (@LynnBroe)
• #4520: [doc] Fix typo: missing closing quotation mark after CPD-END - João Dinis Ferreira (@joaodinissf)
• #4533: [java] Fix #4063: False-negative about try/catch block in Loop - AnnaDev (@LynnBroe)
• #4536: [java] Fix #4268: CommentDefaultAccessModifier - false positive with TestNG’s @Test annotation - AnnaDev (@LynnBroe)
• #4537: [java] Fix #4455: A false positive about FieldNamingConventions and UtilityClass - AnnaDev (@LynnBroe)
• #4538: [java] Fix #4456: A false positive about FinalFieldCouldBeStatic and UtilityClass - AnnaDev (@LynnBroe)
• #4540: [java] Fix #4457: false negative about OverrideBothEqualsAndHashcode - AnnaDev (@LynnBroe)
• #4541: [java] Fix #4458: A false positive about RedundantFieldInitializer and @Value - AnnaDev (@LynnBroe)
• #4542: [java] Fix #4510: A false positive about ConstructorCallsOverridableMethod and @Value - AnnaDev (@LynnBroe)
• #4553: [java] Fix #4492: GuardLogStatement gives false positive when argument is a Java method reference - Anastasiia Koba (@anastasiia-koba)

📈 Stats

• 4694 commits
• 617 closed tickets & PRs
• Days since last release: 30

29-April-2023 - 7.0.0-rc2

We’re excited to bring you the next major version of PMD!

Since this is a big release, we provide here only a concise version of the release notes. We prepared a separate page with the full Detailed Release Notes for PMD 7.0.0.

Table Of Contents

• Changes since 7.0.0-rc1
  • API Changes
  • Updated PMD Designer
  • Language Related Changes
  • Rule Changes
  • Fixed Issues
  • External contributions
• 🚀 Major Features and Enhancements
  • New official logo
  • Revamped Java module
  • Revamped Command Line Interface
  • Full Antlr support
  • Updated PMD Designer
• 🎉 Language Related Changes
  • New: Swift support
  • New: Kotlin support (experimental)
  • New: CPD support for TypeScript
  • New: CPD support for Julia
  • Changed: JavaScript support
  • Changed: Language versions
• 🌟 New and changed rules
  • New Rules
  • Changed Rules
  • Removed Rules
• 🚨 API
• 💥 Compatibility and migration notes
• 🐛 Fixed Issues
• ✨ External Contributions
• 📈 Stats

Changes since 7.0.0-rc1

This section lists the most important changes from the last release candidate. The remaining section describes the complete release notes for 7.0.0.

API Changes

• Moved the two classes AntlrTokenizer and JavaCCTokenizer from internal package into package net.sourceforge.pmd.cpd.impl. These two classes are part of the API and are base classes for CPD language implementations.
• AntlrBaseRule is gone in favor of AbstractVisitorRule.
• The classes KotlinInnerNode and SwiftInnerNode are package-private now.
• The parameter order of addSourceFile has been swapped in order to have the same meaning as in 6.55.0. That will make it easier if you upgrade from 6.55.0 to 7.0.0. However, that means, that you need to change these method calls if you have migrated to 7.0.0-rc1 already.

Updated PMD Designer

This PMD release ships a new version of the pmd-designer. For the changes, see PMD Designer Changelog.

Language Related Changes

• New: CPD support for TypeScript
• New: CPD support for Julia

Rule Changes

• ImmutableField: the property ignoredAnnotations has been removed. The property was deprecated since PMD 6.52.0.
• SwitchDensity: the type of the property minimum has been changed from decimal to integer for consistency with other statistical rules.

Fixed Issues

• cli
  • #4482: [cli] pmd.bat can only be executed once
  • #4484: [cli] ast-dump with no properties produce an NPE
• core
  • #2500: [core] Clarify API for ANTLR based languages
• doc
  • #2501: [doc] Verify ANTLR Documentation
  • #4438: [doc] Documentation links in VS Code are outdated
• java-codestyle
  • #4273: [java] CommentDefaultAccessModifier ignoredAnnotations should include “org.junit.jupiter.api.extension.RegisterExtension” by default
  • #4487: [java] UnnecessaryConstructor: false-positive with @Inject and @Autowired
• java-design
  • #4254: [java] ImmutableField - false positive with Lombok @Setter
  • #4477: [java] SignatureDeclareThrowsException: false-positive with TestNG annotations
  • #4490: [java] ImmutableField - false negative with Lombok @Getter
• java-errorprone
  • #4449: [java] AvoidAccessibilityAlteration: Possible false positive in AvoidAccessibilityAlteration rule when using Lambda expression
  • #4493: [java] MissingStaticMethodInNonInstantiatableClass: false-positive about @Inject
  • #4505: [java] ImplicitSwitchFallThrough NPE in PMD 7.0.0-rc1
• java-multithreading
  • #4483: [java] NonThreadSafeSingleton false positive with double-checked locking
• miscellaneous
  • #4462: Provide Software Bill of Materials (SBOM)

External contributions

• #4402: [javascript] CPD: add support for Typescript using antlr4 grammar - Paul Guyot (@pguyot)
• #4403: [julia] CPD: Add support for Julia code duplication - Wener (@wener-tiobe)
• #4444: [java] CommentDefaultAccessModifier - ignore org.junit.jupiter.api.extension.RegisterExtension by default - Nirvik Patel (@nirvikpatel)
• #4450: [java] Fix #4449 AvoidAccessibilityAlteration: Correctly handle Lambda expressions in PrivilegedAction scenarios - Seren (@mohui1999)
• #4452: [doc] Update PMD_APEX_ROOT_DIRECTORY documentation reference - nwcm (@nwcm)
• #4474: [java] ImmutableField: False positive with lombok (fixes #4254) - Pim van der Loos (@PimvanderLoos)
• #4488: [java] Fix #4477: A false-positive about SignatureDeclareThrowsException - AnnaDev (@LynnBroe)
• #4494: [java] Fix #4487: A false-positive about UnnecessaryConstructor and @Inject and @Autowired - AnnaDev (@LynnBroe)
• #4495: [java] Fix #4493: false-positive about MissingStaticMethodInNonInstantiatableClass and @Inject - AnnaDev (@LynnBroe)
• #4520: [doc] Fix typo: missing closing quotation mark after CPD-END - João Dinis Ferreira (@joaodinissf)

🚀 Major Features and Enhancements

New official logo

The new official logo of PMD:

Revamped Java module

• Java grammar substantially refactored - more correct regarding the Java Language Specification (JLS)
• Built-in rules have been upgraded for the changed AST
• Rewritten type resolution framework and symbol table correctly implements the JLS
• AST exposes more semantic information (method calls, field accesses)

For more information, see the Detailed Release Notes for PMD 7.

Contributors: Clément Fournier (@oowekyala), Andreas Dangel (@adangel), Juan Martín Sotuyo Dodero (@jsotuyod)

Revamped Command Line Interface

• unified and consistent Command Line Interface for both Linux/Unix and Windows across our different utilities
• single script pmd (pmd.bat for Windows) to launch the different utilities:
  • pmd check to run PMD rules and analyze a project
  • pmd cpd to run CPD (copy paste detector)
  • pmd designer to run the PMD Rule Designer
• progress bar support for pmd check
• shell completion

For more information, see the Detailed Release Notes for PMD 7.

Contributors: Juan Martín Sotuyo Dodero (@jsotuyod)

Full Antlr support

• Antlr based grammars can now be used to build full-fledged PMD rules.
• Previously, Antlr grammar could only be used for CPD
• New supported languages: Swift and Kotlin

For more information, see the Detailed Release Notes for PMD 7.

Contributors: Lucas Soncini (@lsoncini), Matías Fraga (@matifraga), Tomás De Lucca (@tomidelucca)

Updated PMD Designer

This PMD release ships a new version of the pmd-designer. For the changes, see PMD Designer Changelog.

🎉 Language Related Changes

Note that this is just a concise listing of the highlight. For more information on the languages, see the Detailed Release Notes for PMD 7.

New: Swift support

• use PMD to analyze Swift code with PMD rules
• initially 4 built-in rules

Contributors: Lucas Soncini (@lsoncini), Matías Fraga (@matifraga), Tomás De Lucca (@tomidelucca)

New: Kotlin support (experimental)

• use PMD to analyze Kotlin code with PMD rules
• Support for Kotlin 1.8 grammar
• initially 2 built-in rules

New: CPD support for TypeScript

Thanks to a contribution, CPD now supports the TypeScript language. It is shipped with the rest of the JavaScript support in the module pmd-javascript.

Contributors: Paul Guyot (@pguyot)

New: CPD support for Julia

Thanks to a contribution, CPD now supports the Julia language. It is shipped in the new module pmd-julia.

Contributors: Wener (@wener-tiobe)

Changed: JavaScript support

• latest version supports ES6 and also some new constructs (see Rhino])
• comments are retained

Changed: Language versions

• more predefined language versions for each supported language
• can be used to limit rule execution for specific versions only with minimumLanguageVersion and maximumLanguageVersion attributes.

🌟 New and changed rules

New Rules

Apex

• UnusedMethod finds unused methods in your code.

Java

• UnnecessaryBoxing reports boxing and unboxing conversions that may be made implicit.

Kotlin

• FunctionNameTooShort
• OverrideBothEqualsAndHashcode

Swift

• ProhibitedInterfaceBuilder
• UnavailableFunction
• ForceCast
• ForceTry

Changed Rules

General changes

• All statistical rules (like ExcessiveClassLength, ExcessiveParameterList) have been simplified and unified. The properties topscore and sigma have been removed. The property minimum is still there, however the type is not a decimal number anymore but has been changed to an integer. This affects rules in the languages Apex, Java, PLSQL and Velocity Template Language (vm):
  • Apex: ExcessiveClassLength, ExcessiveParameterList, ExcessivePublicCount, NcssConstructorCount, NcssMethodCount, NcssTypeCount
  • Java: ExcessiveImports, ExcessiveParameterList, ExcessivePublicCount, SwitchDensity
  • PLSQL: ExcessiveMethodLength, ExcessiveObjectLength, ExcessivePackageBodyLength, ExcessivePackageSpecificationLength, ExcessiveParameterList, ExcessiveTypeLength, NcssMethodCount, NcssObjectCount, NPathComplexity
  • VM: ExcessiveTemplateLength
• The general property violationSuppressXPath which is available for all rules to suppress warnings now uses XPath version 3.1 by default. This version of the XPath language is mostly identical to XPath 2.0. In PMD 6, XPath 1.0 has been used. If you upgrade from PMD 6, you need to verify your violationSuppressXPath properties.

Apex General changes

• The properties cc_categories, cc_remediation_points_multiplier, cc_block_highlighting have been removed from all rules. These properties have been deprecated since PMD 6.13.0. See issue #1648 for more details.

Java General changes

• Violations reported on methods or classes previously reported the line range of the entire method or class. With PMD 7.0.0, the reported location is now just the identifier of the method or class. This affects various rules, e.g. CognitiveComplexity.

  The report location is controlled by the overrides of the method getReportLocation in different node types.

  See issue #4439 and issue #730 for more details.

Java Best Practices

• ArrayIsStoredDirectly: Violations are now reported on the assignment and not anymore on the formal parameter. The reported line numbers will probably move.
• AvoidReassigningLoopVariables: This rule might not report anymore all reassignments of the control variable in for-loops when the property forReassign is set to skip. See issue #4500 for more details.
• LooseCoupling: The rule has a new property to allow some types to be coupled to (allowedTypes).
• UnusedLocalVariable: This rule has some important false-negatives fixed and finds many more cases now. For details see issues #2130, #4516, and #4517.

Java Codestyle

• MethodNamingConventions: The property checkNativeMethods has been removed. The property was deprecated since PMD 6.3.0. Use the property nativePattern to control whether native methods should be considered or not.
• ShortVariable: This rule now also reports short enum constant names.
• UseDiamondOperator: The property java7Compatibility has been removed. The rule now handles Java 7 properly without a property.
• UnnecessaryFullyQualifiedName: The rule has two new properties, to selectively disable reporting on static field and method qualifiers. The rule also has been improved to be more precise.
• UselessParentheses: The rule has two new properties which control how strict the rule should be applied. With ignoreClarifying (default: true) parentheses that are strictly speaking not necessary are allowed, if they separate expressions of different precedence. The other property ignoreBalancing (default: true) is similar, in that it allows parentheses that help reading and understanding the expressions.

Java Design

• CyclomaticComplexity: The property reportLevel has been removed. The property was deprecated since PMD 6.0.0. The report level can now be configured separated for classes and methods using classReportLevel and methodReportLevel instead.
• ImmutableField: The property ignoredAnnotations has been removed. The property was deprecated since PMD 6.52.0.
• LawOfDemeter: The rule has a new property trustRadius. This defines the maximum degree of trusted data. The default of 1 is the most restrictive.
• NPathComplexity: The property minimum has been removed. It was deprecated since PMD 6.0.0. Use the property reportLevel instead.
• SingularField: The properties checkInnerClasses and disallowNotAssignment have been removed. The rule is now more precise and will check these cases properly.
• UseUtilityClass: The property ignoredAnnotations has been removed.

Java Documentation

• CommentContent: The properties caseSensitive and disallowedTerms are removed. The new property forbiddenRegex can be used now to define the disallowed terms with a single regular expression.
• CommentRequired:
  • Overridden methods are now detected even without the @Override annotation. This is relevant for the property methodWithOverrideCommentRequirement. See also pull request #3757.
  • Elements in annotation types are now detected as well. This might lead to an increased number of violations for missing public method comments.
• CommentSize: When determining the line-length of a comment, the leading comment prefix markers (e.g. * or //) are ignored and don’t add up to the line-length. See also pull request #4369.

Java Error Prone

• AvoidDuplicateLiterals: The property exceptionfile has been removed. The property was deprecated since PMD 6.10.0. Use the property exceptionList instead.
• DontImportSun: sun.misc.Signal is not special-cased anymore.
• EmptyCatchBlock: CloneNotSupportedException and InterruptedException are not special-cased anymore. Rename the exception parameter to ignored to ignore them.
• ImplicitSwitchFallThrough: Violations are now reported on the case statements rather than on the switch statements. This is more accurate but might result in more violations now.

Removed Rules

Many rules, that were previously deprecated have been finally removed. See Detailed Release Notes for PMD 7 for the complete list.

🚨 API

The API of PMD has been growing over the years and needed some cleanup. The goal is, to have a clear separation between a well-defined API and the implementation, which is internal. This should help us in future development.

Also, there are some improvement and changes in different areas. For the detailed description of the changes listed here, see Detailed Release Notes for PMD 7.

• Miscellaneous smaller changes and cleanups
• XPath 3.1 support for XPath-based rules
• Node stream API for AST traversal
• Metrics framework
• Testing framework
• Language Lifecycle and Language Properties

💥 Compatibility and migration notes

See Detailed Release Notes for PMD 7.

🐛 Fixed Issues

• miscellaneous
  • #881: [all] Breaking API changes for 7.0.0
  • #896: [all] Use slf4j
  • #1431: [ui] Remove old GUI applications (designerold, bgastviewer)
  • #1451: [core] RulesetFactoryCompatibility stores the whole ruleset file in memory as a string
  • #2496: Update PMD 7 Logo on landing page
  • #2497: PMD 7 Logo page
  • #2498: Update PMD 7 Logo in documentation
  • #3797: [all] Use JUnit5
  • #4462: Provide Software Bill of Materials (SBOM)
• ant
  • #4080: [ant] Split off Ant integration into a new submodule
• core
  • #880: [core] Make visitors generic
  • #1622: [core] NodeStream API
  • #1687: [core] Deprecate and Remove XPath 1.0 support
  • #1785: [core] Allow abstract node types to be valid rulechain visits
  • #1825: [core] Support NoAttribute for XPath
  • #2038: [core] Remove DCD
  • #2218: [core] isFindBoundary should not be an attribute
  • #2234: [core] Consolidate PMD CLI into a single command
  • #2239: [core] Merging Javacc build scripts
  • #2500: [core] Clarify API for ANTLR based languages
  • #2518: [core] Language properties
  • #2602: [core] Remove ParserOptions
  • #2614: [core] Upgrade Saxon, add XPath 3.1, remove Jaxen
  • #2696: [core] Remove DFA
  • #2821: [core] Rule processing error filenames are missing paths
  • #2873: [core] Utility classes in pmd 7
  • #2885: [core] Error recovery mode
  • #3203: [core] Replace RuleViolationFactory implementations with ViolationDecorator
  • #3692: [core] Analysis listeners
  • #3782: [core] Language lifecycle
  • #3815: [core] Update Saxon HE to 10.7
  • #3893: [core] Text documents
  • #3902: [core] Violation decorators
  • #3918: [core] Make LanguageRegistry non static
  • #3922: [core] Better error reporting for the ruleset parser
  • #4035: [core] ConcurrentModificationException in DefaultRuleViolationFactory
  • #4120: [core] Explicitly name all language versions
  • #4353: [core] Micro optimizations for Node API
  • #4365: [core] Improve benchmarking
  • #4420: [core] Remove PMD.EOL
• cli
  • #2234: [core] Consolidate PMD CLI into a single command
  • #3828: [core] Progress reporting
  • #4079: [cli] Split off CLI implementation into a pmd-cli submodule
  • #4482: [cli] pmd.bat can only be executed once
  • #4484: [cli] ast-dump with no properties produce an NPE
• doc
  • #2501: [doc] Verify ANTLR Documentation
  • #4438: [doc] Documentation links in VS Code are outdated
• testing
  • #2435: [test] Remove duplicated Dummy language module
  • #4234: [test] Tests that change the logging level do not work

Language specific fixes:

• apex
  • #1937: [apex] Apex should only have a single RootNode
  • #1648: [apex,vf] Remove CodeClimate dependency
  • #1750: [apex] Remove apex statistical rules
  • #2836: [apex] Remove Apex ProjectMirror
  • #4427: [apex] ApexBadCrypto test failing to detect inline code
• apex-design
  • #2667: [apex] Integrate nawforce/ApexLink to build robust Unused rule
  • #4509: [apex] ExcessivePublicCount doesn’t consider inner classes correctly
• java
  • #520: [java] Allow @SuppressWarnings with constants instead of literals
  • #864: [java] Similar/duplicated implementations for determining FQCN
  • #905: [java] Add new node for anonymous class declaration
  • #910: [java] AST inconsistency between primitive and reference type arrays
  • #997: [java] Java8 parsing corner case with annotated array types
  • #998: [java] AST inconsistencies around FormalParameter
  • #1019: [java] Breaking Java Grammar changes for PMD 7.0.0
  • #1124: [java] ImmutableList implementation in the qname codebase
  • #1128: [java] Improve ASTLocalVariableDeclaration
  • #1150: [java] ClassOrInterfaceType AST improvements
  • #1207: [java] Resolve explicit types using FQCNs, without hitting the classloader
  • #1367: [java] Parsing error on annotated inner class
  • #1661: [java] About operator nodes
  • #2366: [java] Remove qualified names
  • #2819: [java] GLB bugs in pmd 7
  • #3642: [java] Parse error on rare extra dimensions on method return type on annotation methods
  • #3763: [java] Ambiguous reference error in valid code
  • #3749: [java] Improve isOverridden in ASTMethodDeclaration
  • #3750: [java] Make symbol table support instanceof pattern bindings
  • #3752: [java] Expose annotations in symbol API
  • #4237: [java] Cleanup handling of Java comments
  • #4317: [java] Some AST nodes should not be TypeNodes
  • #4359: [java] Type resolution fails with NPE when the scope is not a type declaration
  • #4367: [java] Move testrule TypeResTest into internal
• java-bestpractices
  • #342: [java] AccessorMethodGeneration: Name clash with another public field not properly handled
  • #755: [java] AccessorClassGeneration false positive for private constructors
  • #770: [java] UnusedPrivateMethod yields false positive for counter-variant arguments
  • #807: [java] AccessorMethodGeneration false positive with overloads
  • #833: [java] ForLoopCanBeForeach should consider iterating on this
  • #1189: [java] UnusedPrivateMethod false positive from inner class via external class
  • #1205: [java] Improve ConstantsInInterface message to mention alternatives
  • #1212: [java] Don’t raise JUnitTestContainsTooManyAsserts on JUnit 5’s assertAll
  • #1422: [java] JUnitTestsShouldIncludeAssert false positive with inherited @Rule field
  • #1455: [java] JUnitTestsShouldIncludeAssert: False positives for assert methods named “check” and “verify”
  • #1563: [java] ForLoopCanBeForeach false positive with method call using index variable
  • #1565: [java] JUnitAssertionsShouldIncludeMessage false positive with AssertJ
  • #1747: [java] PreserveStackTrace false-positive
  • #1969: [java] MissingOverride false-positive triggered by package-private method overwritten in another package by extending class
  • #1998: [java] AccessorClassGeneration false-negative: subclass calls private constructor
  • #2130: [java] UnusedLocalVariable: false-negative with array
  • #2147: [java] JUnitTestsShouldIncludeAssert - false positives with lambdas and static methods
  • #2464: [java] LooseCoupling must ignore class literals: ArrayList.class
  • #2542: [java] UseCollectionIsEmpty can not detect the case foo.bar().size()
  • #2650: [java] UseTryWithResources false positive when AutoCloseable helper used
  • #2796: [java] UnusedAssignment false positive with call chains
  • #2797: [java] MissingOverride long-standing issues
  • #2806: [java] SwitchStmtsShouldHaveDefault false-positive with Java 14 switch non-fallthrough branches
  • #2822: [java] LooseCoupling rule: Extend to cover user defined implementations and interfaces
  • #2843: [java] Fix UnusedAssignment FP with field accesses
  • #2882: [java] UseTryWithResources - false negative for explicit close
  • #2883: [java] JUnitAssertionsShouldIncludeMessage false positive with method call
  • #2890: [java] UnusedPrivateMethod false positive with generics
  • #2946: [java] SwitchStmtsShouldHaveDefault false positive on enum inside enums
  • #3672: [java] LooseCoupling - fix false positive with generics
  • #3675: [java] MissingOverride - fix false positive with mixing type vars
  • #3858: [java] UseCollectionIsEmpty should infer local variable type from method invocation
  • #4516: [java] UnusedLocalVariable: false-negative with try-with-resources
  • #4517: [java] UnusedLocalVariable: false-negative with compound assignments
  • #4518: [java] UnusedLocalVariable: false-positive with multiple for-loop indices
• java-codestyle
  • #1208: [java] PrematureDeclaration rule false-positive on variable declared to measure time
  • #1429: [java] PrematureDeclaration as result of method call (false positive)
  • #1480: [java] IdenticalCatchBranches false positive with return expressions
  • #1673: [java] UselessParentheses false positive with conditional operator
  • #1790: [java] UnnecessaryFullyQualifiedName false positive with enum constant
  • #1918: [java] UselessParentheses false positive with boolean operators
  • #2134: [java] PreserveStackTrace not handling Throwable.addSuppressed(...)
  • #2299: [java] UnnecessaryFullyQualifiedName false positive with similar package name
  • #2391: [java] UseDiamondOperator FP when expected type and constructed type have a different parameterization
  • #2528: [java] MethodNamingConventions - JUnit 5 method naming not support ParameterizedTest
  • #2739: [java] UselessParentheses false positive for string concatenation
  • #2748: [java] UnnecessaryCast false positive with unchecked cast
  • #2973: [java] New rule: UnnecessaryBoxing
  • #3195: [java] Improve rule UnnecessaryReturn to detect more cases
  • #3218: [java] Generalize UnnecessaryCast to flag all unnecessary casts
  • #3221: [java] PrematureDeclaration false positive for unused variables
  • #3238: [java] Improve ExprContext, fix FNs of UnnecessaryCast
  • #3500: [java] UnnecessaryBoxing - check for Integer.valueOf(String) calls
  • #4273: [java] CommentDefaultAccessModifier ignoredAnnotations should include “org.junit.jupiter.api.extension.RegisterExtension” by default
  • #4357: [java] Fix IllegalStateException in UseDiamondOperator rule
  • #4487: [java] UnnecessaryConstructor: false-positive with @Inject and @Autowired
  • #4511: [java] LocalVariableCouldBeFinal shouldn’t report unused variables
  • #4512: [java] MethodArgumentCouldBeFinal shouldn’t report unused parameters
• java-design
  • #1014: [java] LawOfDemeter: False positive with lambda expression
  • #1605: [java] LawOfDemeter: False positive for standard UTF-8 charset name
  • #2160: [java] Issues with Law of Demeter
  • #2175: [java] LawOfDemeter: False positive for chained methods with generic method call
  • #2179: [java] LawOfDemeter: False positive with static property access - should treat class-level property as global object, not dot-accessed property
  • #2180: [java] LawOfDemeter: False positive with Thread and ThreadLocalRandom
  • #2182: [java] LawOfDemeter: False positive with package-private access
  • #2188: [java] LawOfDemeter: False positive with fields assigned to local vars
  • #2536: [java] ClassWithOnlyPrivateConstructorsShouldBeFinal can’t detect inner class
  • #3668: [java] ClassWithOnlyPrivateConstructorsShouldBeFinal - fix FP with inner private classes
  • #3754: [java] SingularField false positive with read in while condition
  • #3786: [java] SimplifyBooleanReturns should consider operator precedence
  • #4238: [java] Make LawOfDemeter not use the rulechain
  • #4254: [java] ImmutableField - false positive with Lombok @Setter
  • #4477: [java] SignatureDeclareThrowsException: false-positive with TestNG annotations
  • #4490: [java] ImmutableField - false negative with Lombok @Getter
• java-documentation
  • #4369: [java] Improve CommentSize
  • #4416: [java] Fix reported line number in CommentContentRule
• java-errorprone
  • #659: [java] MissingBreakInSwitch - last default case does not contain a break
  • #1005: [java] CloneMethodMustImplementCloneable triggers for interfaces
  • #1669: [java] NullAssignment - FP with ternay and null as constructor argument
  • #1899: [java] Recognize @SuppressWanings(“fallthrough”) for MissingBreakInSwitch
  • #2320: [java] NullAssignment - FP with ternary and null as method argument
  • #2532: [java] AvoidDecimalLiteralsInBigDecimalConstructor can not detect the case new BigDecimal(Expression)
  • #2579: [java] MissingBreakInSwitch detects the lack of break in the last case
  • #2880: [java] CompareObjectsWithEquals - false negative with type res
  • #2893: [java] Remove special cases from rule EmptyCatchBlock
  • #2894: [java] Improve MissingBreakInSwitch
  • #3071: [java] BrokenNullCheck FP with PMD 6.30.0
  • #3087: [java] UnnecessaryBooleanAssertion overlaps with SimplifiableTestAssertion
  • #3100: [java] UseCorrectExceptionLogging FP in 6.31.0
  • #3173: [java] UseProperClassLoader false positive
  • #3351: [java] ConstructorCallsOverridableMethod ignores abstract methods
  • #3400: [java] AvoidUsingOctalValues FN with underscores
  • #3843: [java] UseEqualsToCompareStrings should consider return type
  • #4356: [java] Fix NPE in CloseResourceRule
  • #4449: [java] AvoidAccessibilityAlteration: Possible false positive in AvoidAccessibilityAlteration rule when using Lambda expression
  • #4493: [java] MissingStaticMethodInNonInstantiatableClass: false-positive about @Inject
  • #4505: [java] ImplicitSwitchFallThrough NPE in PMD 7.0.0-rc1
  • #4513: [java] UselessOperationOnImmutable various false negatives with String
  • #4514: [java] AvoidLiteralsInIfCondition false positive and negative for String literals when ignoreExpressions=true
• java-multithreading
  • #2537: [java] DontCallThreadRun can’t detect the case that call run() in this.run()
  • #2538: [java] DontCallThreadRun can’t detect the case that call run() in foo.bar.run()
  • #2577: [java] UseNotifyAllInsteadOfNotify falsely detect a special case with argument: foo.notify(bar)
  • #4483: [java] NonThreadSafeSingleton false positive with double-checked locking
• java-performance
  • #1224: [java] InefficientEmptyStringCheck false negative in anonymous class
  • #2587: [java] AvoidArrayLoops could also check for list copy through iterated List.add()
  • #2712: [java] SimplifyStartsWith false-positive with AssertJ
  • #3486: [java] InsufficientStringBufferDeclaration: Fix NPE
  • #3848: [java] StringInstantiation: false negative when using method result
• kotlin
  • #419: [kotlin] Add support for Kotlin
  • #4389: [kotlin] Update grammar to version 1.8
• swift
  • #1877: [swift] Feature/swift rules
  • #1882: [swift] UnavailableFunction Swift rule
• xml
  • #1800: [xml] Unimplement org.w3c.dom.Node from the XmlNodeWrapper

✨ External Contributions

• #1658: [core] Node support for Antlr-based languages - Matías Fraga (@matifraga)
• #1698: [core] [swift] Antlr Base Parser adapter and Swift Implementation - Lucas Soncini (@lsoncini)
• #1774: [core] Antlr visitor rules - Lucas Soncini (@lsoncini)
• #1877: [swift] Feature/swift rules - Matías Fraga (@matifraga)
• #1881: [doc] Add ANTLR documentation - Matías Fraga (@matifraga)
• #1882: [swift] UnavailableFunction Swift rule - Tomás de Lucca (@tomidelucca)
• #2830: [apex] Apexlink POC - Kevin Jones (@nawforce)
• #3866: [core] Add CLI Progress Bar - @JerritEic (@JerritEic)
• #4402: [javascript] CPD: add support for Typescript using antlr4 grammar - Paul Guyot (@pguyot)
• #4403: [julia] CPD: Add support for Julia code duplication - Wener (@wener-tiobe)
• #4412: [doc] Added new error msg to ConstantsInInterface - David Ljunggren (@dague1)
• #4428: [apex] ApexBadCrypto bug fix for #4427 - inline detection of hard coded values - Steven Stearns (@sfdcsteve)
• #4444: [java] CommentDefaultAccessModifier - ignore org.junit.jupiter.api.extension.RegisterExtension by default - Nirvik Patel (@nirvikpatel)
• #4450: [java] Fix #4449 AvoidAccessibilityAlteration: Correctly handle Lambda expressions in PrivilegedAction scenarios - Seren (@mohui1999)
• #4452: [doc] Update PMD_APEX_ROOT_DIRECTORY documentation reference - nwcm (@nwcm)
• #4474: [java] ImmutableField: False positive with lombok (fixes #4254) - Pim van der Loos (@PimvanderLoos)
• #4488: [java] Fix #4477: A false-positive about SignatureDeclareThrowsException - AnnaDev (@LynnBroe)
• #4494: [java] Fix #4487: A false-positive about UnnecessaryConstructor and @Inject and @Autowired - AnnaDev (@LynnBroe)
• #4495: [java] Fix #4493: false-positive about MissingStaticMethodInNonInstantiatableClass and @Inject - AnnaDev (@LynnBroe)
• #4520: [doc] Fix typo: missing closing quotation mark after CPD-END - João Dinis Ferreira (@joaodinissf)

📈 Stats

• 4557 commits
• 572 closed tickets & PRs
• Days since last release: 35

25-March-2023 - 7.0.0-rc1

We’re excited to bring you the next major version of PMD!

Since this is a big release, we provide here only a concise version of the release notes. We prepared a separate page with the full Detailed Release Notes for PMD 7.0.0.

Table Of Contents

• 🚀 Major Features and Enhancements
  • New official logo
  • Revamped Java module
  • Revamped Command Line Interface
  • Full Antlr support
• 🎉 Language Related Changes
  • New: Swift support
  • New: Kotlin support (experimental)
  • Changed: JavaScript support
  • Changed: Language versions
• 🌟 New and changed rules
  • New Rules
  • Changed Rules
  • Removed Rules
• 🚨 API
• 💥 Compatibility and migration notes
• 🐛 Fixed Issues
• ✨ External Contributions
• 📈 Stats

🚀 Major Features and Enhancements

New official logo

The new official logo of PMD:

Revamped Java module

• Java grammar substantially refactored - more correct regarding the Java Language Specification (JLS)
• Built-in rules have been upgraded for the changed AST
• Rewritten type resolution framework and symbol table correctly implements the JLS
• AST exposes more semantic information (method calls, field accesses)

For more information, see the Detailed Release Notes for PMD 7.

Contributors: Clément Fournier (@oowekyala), Andreas Dangel (@adangel), Juan Martín Sotuyo Dodero (@jsotuyod)

Revamped Command Line Interface

• unified and consistent Command Line Interface for both Linux/Unix and Windows across our different utilities
• single script pmd (pmd.bat for Windows) to launch the different utilities:
  • pmd check to run PMD rules and analyze a project
  • pmd cpd to run CPD (copy paste detector)
  • pmd designer to run the PMD Rule Designer
• progress bar support for pmd check
• shell completion

For more information, see the Detailed Release Notes for PMD 7.

Contributors: Juan Martín Sotuyo Dodero (@jsotuyod)

Full Antlr support

• Antlr based grammars can now be used to build full-fledged PMD rules.
• Previously, Antlr grammar could only be used for CPD
• New supported languages: Swift and Kotlin

For more information, see the Detailed Release Notes for PMD 7.

Contributors: Lucas Soncini (@lsoncini), Matías Fraga (@matifraga), Tomás De Lucca (@tomidelucca)

🎉 Language Related Changes

Note that this is just a concise listing of the highlight. For more information on the languages, see the Detailed Release Notes for PMD 7.

New: Swift support

• use PMD to analyze Swift code with PMD rules
• initially 4 built-in rules

Contributors: Lucas Soncini (@lsoncini), Matías Fraga (@matifraga), Tomás De Lucca (@tomidelucca)

New: Kotlin support (experimental)

• use PMD to analyze Kotlin code with PMD rules
• Support for Kotlin 1.8 grammar
• initially 2 built-in rules

Changed: JavaScript support

• latest version supports ES6 and also some new constructs (see Rhino])
• comments are retained

Changed: Language versions

• more predefined language versions for each supported language
• can be used to limit rule execution for specific versions only with minimumLanguageVersion and maximumLanguageVersion attributes.

🌟 New and changed rules

New Rules

Apex

• UnusedMethod finds unused methods in your code.

Java

• UnnecessaryBoxing reports boxing and unboxing conversions that may be made implicit.

Kotlin

• FunctionNameTooShort
• OverrideBothEqualsAndHashcode

Swift

• ProhibitedInterfaceBuilder
• UnavailableFunction
• ForceCast
• ForceTry

Changed Rules

Java

• UnnecessaryFullyQualifiedName: the rule has two new properties, to selectively disable reporting on static field and method qualifiers. The rule also has been improved to be more precise.
• UselessParentheses: the rule has two new properties which control how strict the rule should be applied. With ignoreClarifying (default: true) parentheses that are strictly speaking not necessary are allowed, if they separate expressions of different precedence. The other property ignoreBalancing (default: true) is similar, in that it allows parentheses that help reading and understanding the expressions.
• LooseCoupling: the rule has a new property to allow some types to be coupled to (allowedTypes).
• EmptyCatchBlock: CloneNotSupportedException and InterruptedException are not special-cased anymore. Rename the exception parameter to ignored to ignore them.
• DontImportSun: sun.misc.Signal is not special-cased anymore.
• UseDiamondOperator: the property java7Compatibility is removed. The rule now handles Java 7 properly without a property.
• SingularField: Properties checkInnerClasses and disallowNotAssignment are removed. The rule is now more precise and will check these cases properly.
• UseUtilityClass: The property ignoredAnnotations has been removed.
• LawOfDemeter: the rule has a new property trustRadius. This defines the maximum degree of trusted data. The default of 1 is the most restrictive.
• CommentContent: The properties caseSensitive and disallowedTerms are removed. The new property fobiddenRegex can be used now to define the disallowed terms with a single regular expression.

Removed Rules

Many rules, that were previously deprecated have been finally removed. See Detailed Release Notes for PMD 7 for the complete list.

🚨 API

The API of PMD has been growing over the years and needed some cleanup. The goal is, to have a clear separation between a well-defined API and the implementation, which is internal. This should help us in future development.

Also, there are some improvement and changes in different areas. For the detailed description of the changes listed here, see Detailed Release Notes for PMD 7.

• Miscellaneous smaller changes and cleanups
• XPath 3.1 support for XPath-based rules
• Node stream API for AST traversal
• Metrics framework
• Testing framework
• Language Lifecycle and Language Properties

💥 Compatibility and migration notes

See Detailed Release Notes for PMD 7.

🐛 Fixed Issues

• miscellaneous
  • #881: [all] Breaking API changes for 7.0.0
  • #896: [all] Use slf4j
  • #1431: [ui] Remove old GUI applications (designerold, bgastviewer)
  • #1451: [core] RulesetFactoryCompatibility stores the whole ruleset file in memory as a string
  • #2496: Update PMD 7 Logo on landing page
  • #2497: PMD 7 Logo page
  • #2498: Update PMD 7 Logo in documentation
  • #3797: [all] Use JUnit5
• ant
  • #4080: [ant] Split off Ant integration into a new submodule
• core
  • #880: [core] Make visitors generic
  • #1622: [core] NodeStream API
  • #1687: [core] Deprecate and Remove XPath 1.0 support
  • #1785: [core] Allow abstract node types to be valid rulechain visits
  • #1825: [core] Support NoAttribute for XPath
  • #2038: [core] Remove DCD
  • #2218: [core] isFindBoundary should not be an attribute
  • #2234: [core] Consolidate PMD CLI into a single command
  • #2239: [core] Merging Javacc build scripts
  • #2518: [core] Language properties
  • #2602: [core] Remove ParserOptions
  • #2614: [core] Upgrade Saxon, add XPath 3.1, remove Jaxen
  • #2696: [core] Remove DFA
  • #2821: [core] Rule processing error filenames are missing paths
  • #2873: [core] Utility classes in pmd 7
  • #2885: [core] Error recovery mode
  • #3203: [core] Replace RuleViolationFactory implementations with ViolationDecorator
  • #3692: [core] Analysis listeners
  • #3782: [core] Language lifecycle
  • #3815: [core] Update Saxon HE to 10.7
  • #3893: [core] Text documents
  • #3902: [core] Violation decorators
  • #3918: [core] Make LanguageRegistry non static
  • #3922: [core] Better error reporting for the ruleset parser
  • #4035: [core] ConcurrentModificationException in DefaultRuleViolationFactory
  • #4120: [core] Explicitly name all language versions
  • #4353: [core] Micro optimizations for Node API
  • #4365: [core] Improve benchmarking
  • #4420: [core] Remove PMD.EOL
• cli
  • #2234: [core] Consolidate PMD CLI into a single command
  • #3828: [core] Progress reporting
  • #4079: [cli] Split off CLI implementation into a pmd-cli submodule
• testing
  • #2435: [test] Remove duplicated Dummy language module
  • #4234: [test] Tests that change the logging level do not work

Language specific fixes:

• apex
  • #1937: [apex] Apex should only have a single RootNode
  • #1648: [apex,vf] Remove CodeClimate dependency
  • #1750: [apex] Remove apex statistical rules
  • #2836: [apex] Remove Apex ProjectMirror
  • #4427: [apex] ApexBadCrypto test failing to detect inline code
• apex-design
  • #2667: [apex] Integrate nawforce/ApexLink to build robust Unused rule
• java
  • #520: [java] Allow @SuppressWarnings with constants instead of literals
  • #864: [java] Similar/duplicated implementations for determining FQCN
  • #905: [java] Add new node for anonymous class declaration
  • #910: [java] AST inconsistency between primitive and reference type arrays
  • #997: [java] Java8 parsing corner case with annotated array types
  • #998: [java] AST inconsistencies around FormalParameter
  • #1019: [java] Breaking Java Grammar changes for PMD 7.0.0
  • #1124: [java] ImmutableList implementation in the qname codebase
  • #1128: [java] Improve ASTLocalVariableDeclaration
  • #1150: [java] ClassOrInterfaceType AST improvements
  • #1207: [java] Resolve explicit types using FQCNs, without hitting the classloader
  • #1367: [java] Parsing error on annotated inner class
  • #1661: [java] About operator nodes
  • #2366: [java] Remove qualified names
  • #2819: [java] GLB bugs in pmd 7
  • #3763: [java] Ambiguous reference error in valid code
  • #3749: [java] Improve isOverridden in ASTMethodDeclaration
  • #3750: [java] Make symbol table support instanceof pattern bindings
  • #3752: [java] Expose annotations in symbol API
  • #4237: [java] Cleanup handling of Java comments
  • #4317: [java] Some AST nodes should not be TypeNodes
  • #4359: [java] Type resolution fails with NPE when the scope is not a type declaration
  • #4367: [java] Move testrule TypeResTest into internal
• java-bestpractices
  • #342: [java] AccessorMethodGeneration: Name clash with another public field not properly handled
  • #755: [java] AccessorClassGeneration false positive for private constructors
  • #770: [java] UnusedPrivateMethod yields false positive for counter-variant arguments
  • #807: [java] AccessorMethodGeneration false positive with overloads
  • #833: [java] ForLoopCanBeForeach should consider iterating on this
  • #1189: [java] UnusedPrivateMethod false positive from inner class via external class
  • #1205: [java] Improve ConstantsInInterface message to mention alternatives
  • #1212: [java] Don’t raise JUnitTestContainsTooManyAsserts on JUnit 5’s assertAll
  • #1422: [java] JUnitTestsShouldIncludeAssert false positive with inherited @Rule field
  • #1565: [java] JUnitAssertionsShouldIncludeMessage false positive with AssertJ
  • #1747: [java] PreserveStackTrace false-positive
  • #1969: [java] MissingOverride false-positive triggered by package-private method overwritten in another package by extending class
  • #1998: [java] AccessorClassGeneration false-negative: subclass calls private constructor
  • #2130: [java] UnusedLocalVariable: false-negative with array
  • #2147: [java] JUnitTestsShouldIncludeAssert - false positives with lambdas and static methods
  • #2464: [java] LooseCoupling must ignore class literals: ArrayList.class
  • #2542: [java] UseCollectionIsEmpty can not detect the case foo.bar().size()
  • #2650: [java] UseTryWithResources false positive when AutoCloseable helper used
  • #2796: [java] UnusedAssignment false positive with call chains
  • #2797: [java] MissingOverride long-standing issues
  • #2806: [java] SwitchStmtsShouldHaveDefault false-positive with Java 14 switch non-fallthrough branches
  • #2822: [java] LooseCoupling rule: Extend to cover user defined implementations and interfaces
  • #2843: [java] Fix UnusedAssignment FP with field accesses
  • #2882: [java] UseTryWithResources - false negative for explicit close
  • #2883: [java] JUnitAssertionsShouldIncludeMessage false positive with method call
  • #2890: [java] UnusedPrivateMethod false positive with generics
  • #2946: [java] SwitchStmtsShouldHaveDefault false positive on enum inside enums
  • #3672: [java] LooseCoupling - fix false positive with generics
  • #3675: [java] MissingOverride - fix false positive with mixing type vars
• java-codestyle
  • #1208: [java] PrematureDeclaration rule false-positive on variable declared to measure time
  • #1429: [java] PrematureDeclaration as result of method call (false positive)
  • #1673: [java] UselessParentheses false positive with conditional operator
  • #1790: [java] UnnecessaryFullyQualifiedName false positive with enum constant
  • #1918: [java] UselessParentheses false positive with boolean operators
  • #2134: [java] PreserveStackTrace not handling Throwable.addSuppressed(...)
  • #2299: [java] UnnecessaryFullyQualifiedName false positive with similar package name
  • #2391: [java] UseDiamondOperator FP when expected type and constructed type have a different parameterization
  • #2528: [java] MethodNamingConventions - JUnit 5 method naming not support ParameterizedTest
  • #2739: [java] UselessParentheses false positive for string concatenation
  • #2748: [java] UnnecessaryCast false positive with unchecked cast
  • #2973: [java] New rule: UnnecessaryBoxing
  • #3195: [java] Improve rule UnnecessaryReturn to detect more cases
  • #3218: [java] Generalize UnnecessaryCast to flag all unnecessary casts
  • #3221: [java] PrematureDeclaration false positive for unused variables
  • #3238: [java] Improve ExprContext, fix FNs of UnnecessaryCast
  • #3500: [java] UnnecessaryBoxing - check for Integer.valueOf(String) calls
  • #4357: [java] Fix IllegalStateException in UseDiamondOperator rule
• java-design
  • #1014: [java] LawOfDemeter: False positive with lambda expression
  • #1605: [java] LawOfDemeter: False positive for standard UTF-8 charset name
  • #2175: [java] LawOfDemeter: False positive for chained methods with generic method call
  • #2179: [java] LawOfDemeter: False positive with static property access - should treat class-level property as global object, not dot-accessed property
  • #2180: [java] LawOfDemeter: False positive with Thread and ThreadLocalRandom
  • #2182: [java] LawOfDemeter: False positive with package-private access
  • #2188: [java] LawOfDemeter: False positive with fields assigned to local vars
  • #2536: [java] ClassWithOnlyPrivateConstructorsShouldBeFinal can’t detect inner class
  • #3668: [java] ClassWithOnlyPrivateConstructorsShouldBeFinal - fix FP with inner private classes
  • #3754: [java] SingularField false positive with read in while condition
  • #3786: [java] SimplifyBooleanReturns should consider operator precedence
  • #4238: [java] Make LawOfDemeter not use the rulechain
• java-documentation
  • #4369: [java] Improve CommentSize
  • #4416: [java] Fix reported line number in CommentContentRule
• java-errorprone
  • #659: [java] MissingBreakInSwitch - last default case does not contain a break
  • #1005: [java] CloneMethodMustImplementCloneable triggers for interfaces
  • #1669: [java] NullAssignment - FP with ternay and null as constructor argument
  • #1899: [java] Recognize @SuppressWanings(“fallthrough”) for MissingBreakInSwitch
  • #2320: [java] NullAssignment - FP with ternary and null as method argument
  • #2532: [java] AvoidDecimalLiteralsInBigDecimalConstructor can not detect the case new BigDecimal(Expression)
  • #2579: [java] MissingBreakInSwitch detects the lack of break in the last case
  • #2880: [java] CompareObjectsWithEquals - false negative with type res
  • #2893: [java] Remove special cases from rule EmptyCatchBlock
  • #2894: [java] Improve MissingBreakInSwitch
  • #3071: [java] BrokenNullCheck FP with PMD 6.30.0
  • #3087: [java] UnnecessaryBooleanAssertion overlaps with SimplifiableTestAssertion
  • #3100: [java] UseCorrectExceptionLogging FP in 6.31.0
  • #3173: [java] UseProperClassLoader false positive
  • #3351: [java] ConstructorCallsOverridableMethod ignores abstract methods
  • #3400: [java] AvoidUsingOctalValues FN with underscores
  • #4356: [java] Fix NPE in CloseResourceRule
• java-multithreading
  • #2537: [java] DontCallThreadRun can’t detect the case that call run() in this.run()
  • #2538: [java] DontCallThreadRun can’t detect the case that call run() in foo.bar.run()
  • #2577: [java] UseNotifyAllInsteadOfNotify falsely detect a special case with argument: foo.notify(bar)
• java-performance
  • #1224: [java] InefficientEmptyStringCheck false negative in anonymous class
  • #2587: [java] AvoidArrayLoops could also check for list copy through iterated List.add()
  • #2712: [java] SimplifyStartsWith false-positive with AssertJ
  • #3486: [java] InsufficientStringBufferDeclaration: Fix NPE
• kotlin
  • #419: [kotlin] Add support for Kotlin
  • #4389: [kotlin] Update grammar to version 1.8
• swift
  • #1877: [swift] Feature/swift rules
  • #1882: [swift] UnavailableFunction Swift rule
• xml
  • #1800: [xml] Unimplement org.w3c.dom.Node from the XmlNodeWrapper

✨ External Contributions

• #1658: [core] Node support for Antlr-based languages - Matías Fraga (@matifraga)
• #1698: [core] [swift] Antlr Base Parser adapter and Swift Implementation - Lucas Soncini (@lsoncini)
• #1774: [core] Antlr visitor rules - Lucas Soncini (@lsoncini)
• #1877: [swift] Feature/swift rules - Matías Fraga (@matifraga)
• #1881: [doc] Add ANTLR documentation - Matías Fraga (@matifraga)
• #1882: [swift] UnavailableFunction Swift rule - Tomás de Lucca (@tomidelucca)
• #2830: [apex] Apexlink POC - Kevin Jones (@nawforce)
• #3866: [core] Add CLI Progress Bar - @JerritEic (@JerritEic)
• #4412: [doc] Added new error msg to ConstantsInInterface - David Ljunggren (@dague1)
• #4428: [apex] ApexBadCrypto bug fix for #4427 - inline detection of hard coded values - Steven Stearns (@sfdcsteve)

📈 Stats

• 4416 commits
• 464 closed tickets & PRs
• Days since last release: 28

25-February-2023 - 6.55.0

The PMD team is pleased to announce PMD 6.55.0.

This is a minor release.

Table Of Contents

• New and noteworthy
  • PMD 7 Development
  • Java 20 Support
  • T-SQL support
• Fixed Issues
• API Changes
  • Go
  • Java
• External Contributions
• Stats

New and noteworthy

PMD 7 Development

This release is the last planned release of PMD 6. The first version 6.0.0 was released in December 2017. Over the course of more than 5 years we published almost every month a new minor version of PMD 6 with new features and improvements.

Already in November 2018 we started in parallel the development of the next major version 7.0.0, and we are now in the process of finalizing the scope of the major version. We want to release a couple of release candidates before publishing the final version 7.0.0.

We plan to release 7.0.0-rc1 soon. You can see the progress in PMD 7 Tracking Issue #3898.

Java 20 Support

This release of PMD brings support for Java 20. There are no new standard language features.

PMD supports JEP 433: Pattern Matching for switch (Fourth Preview) and JEP 432: Record Patterns (Second Preview) as preview language features.

In order to analyze a project with PMD that uses these language features, you’ll need to enable it via the environment variable PMD_JAVA_OPTS and select the new language version 20-preview:

export PMD_JAVA_OPTS=--enable-preview
./run.sh pmd --use-version java-20-preview ...

T-SQL support

Thanks to the contribution from Paul Guyot PMD now has CPD support for T-SQL (Transact-SQL).

Being based on a proper Antlr grammar, CPD can:

• ignore comments
• honor comment-based suppressions

Fixed Issues

• core
  • #4395: [core] Support environment variable CLASSPATH with pmd.bat under Windows
• java
  • #4333: [java] Support JDK 20
• java-errorprone
  • #4393: [java] MissingStaticMethodInNonInstantiatableClass false-positive for Lombok’s @UtilityClass for classes with non-private fields

API Changes

Go

• The LanguageModule of Go, that only supports CPD execution, has been deprecated. This language is not fully supported by PMD, so having a language module does not make sense. The functionality of CPD is not affected by this change. The following class has been deprecated and will be removed with PMD 7.0.0:
  • GoLanguageModule

Java

• Support for Java 18 preview language features have been removed. The version “18-preview” is no longer available.
• The experimental class net.sourceforge.pmd.lang.java.ast.ASTGuardedPattern has been removed.

External Contributions

• #4384: [swift] Add more swift 5.x support (#unavailable mainly) - Richard B. (@kenji21)
• #4390: Add support for T-SQL using Antlr4 lexer - Paul Guyot (@pguyot)
• #4392: [java] Fix #4393 MissingStaticMethodInNonInstantiatableClass: Fix false-positive for field-only class - Dawid Ciok (@dawiddc)

Stats

• 40 commits
• 11 closed tickets & PRs
• Days since last release: 28

28-January-2023 - 6.54.0

The PMD team is pleased to announce PMD 6.54.0.

This is a minor release.

Table Of Contents

• New and noteworthy
  • New report format html-report-v2.xslt
• Fixed Issues
• API Changes
  • PMD CLI
  • Deprecated APIs
    • For removal
    • Internal APIs
    • Experimental APIs
• External Contributions
• Stats

New and noteworthy

New report format html-report-v2.xslt

Thanks to @mohan-chinnappan-n a new PMD report format has been added which features a data table with charting functions. It uses an XSLT stylesheet to convert PMD’s XML format into HTML.

See the example report.

Fixed Issues

• apex-bestpractices
  • #2669: [apex] UnusedLocalVariable false positive in dynamic SOQL
• core
  • #4026: [cli] Filenames printed as absolute paths in the report despite parameter --short-names
  • #4279: [core] Can not set ruleset property value to empty
  • #4329: [core] Refactor usage of snakeyaml
  • #4340: [core] Allow to filter found matches in CPDReport
• java
  • #4364: [java] Parsing error with textblock containing quote followed by two backslashes
• testing
  • #4236: [test] kotest logs look broken

API Changes

PMD CLI

• PMD now supports a new --relativize-paths-with flag (or short -z), which replaces --short-names. It serves the same purpose: Shortening the pathnames in the reports. However, with the new flag it’s possible to explicitly define one or more pathnames that should be used as the base when creating relative paths. The old flag --short-names is deprecated.

Deprecated APIs

For removal

• ApexRootNode#getApexVersion has been deprecated for removal. The version returned is always Version.CURRENT, as the apex compiler integration doesn’t use additional information which Apex version actually is used. Therefore, this method can’t be used to determine the Apex version of the project that is being analyzed.
• CPDConfiguration#setEncoding and CPDConfiguration#getEncoding. Use the methods getSourceEncoding and setSourceEncoding instead. Both are available for CPDConfiguration which extends AbstractConfiguration.
• BaseCLITest and BaseCPDCLITest have been deprecated for removal without replacement. CLI tests should be done in pmd-core only (and in PMD7 in pmd-cli). Individual language modules shouldn’t need to test the CLI integration logic again. Instead, the individual language modules should test their functionality as unit tests.

• CPDConfiguration.LanguageConverter

• FileCollector#addZipFile has been deprecated. It is replaced by FileCollector#addZipFileWithContent which directly adds the content of the zip file for analysis.

• PMDConfiguration#setReportShortNames and PMDConfiguration#isReportShortNames have been deprecated for removal. Use PMDConfiguration#addRelativizeRoot instead.

Internal APIs

• CSVWriter
• Some fields in AbstractAntTestHelper

Experimental APIs

• CPDReport has a new method which limited mutation of a given report:
  • filterMatches creates a new CPD report with some matches removed with a given predicate based filter.

External Contributions

• #4110: [apex] Feature/unused variable bind false positive with dynamic SOQL - Thomas Prouvot (@tprouvot)
• #4125: [core] New report format html-report-v2.xslt to provide html with datatable and chart features - Mohan Chinnappan - (@mohan-chinnappan-n)
• #4280: [apex] Deprecate ApexRootNode.getApexVersion - Aaron Hurst (@aaronhurst-google)
• #4285: [java] CommentDefaultAccessModifier - add co.elastic.clients.util.VisibleForTesting as default suppressed annotation - Matthew Luckam (@mluckam)

Stats

• 107 commits
• 19 closed tickets & PRs
• Days since last release: 27

31-December-2022 - 6.53.0

The PMD team is pleased to announce PMD 6.53.0.

This is a minor release.

Table Of Contents

• New and noteworthy
  • Modified rules
  • Deprecated rules
• Fixed Issues
• API Changes
  • Deprecated APIs
    • For removal
• External Contributions
• Stats

New and noteworthy

Modified rules

• The Java rule UnusedPrivateField has a new property reportForAnnotations. This is a list of fully qualified names of the annotation types that should be reported anyway. If an unused field has any of these annotations, then it is reported. If it has any other annotation, then it is still considered to be used and is not reported.

Deprecated rules

• The Java rules ExcessiveClassLength and ExcessiveMethodLength have been deprecated. The rule NcssCount can be used instead. The deprecated rules will be removed with PMD 7.0.0.

• The Java rule EmptyStatementNotInLoop is deprecated. Use the rule UnnecessarySemicolon instead. Note: Actually it was announced to be deprecated since 6.46.0 but the rule was not marked as deprecated yet. This has been done now.

Fixed Issues

• core
  • #4248: [core] Can’t analyze sources in zip files
• apex-security
  • #4146: [apex] ApexCRUDViolation: Recognize User Mode in SOQL + DML
• java
  • #4266: [java] PMD fails to process a record with lambda in compact constructor
• java-bestpractices
  • #4166: [java] UnusedPrivateField doesn’t find annotated unused private fields anymore
  • #4250: [java] WhileLoopWithLiteralBoolean - false negative with complex expressions still occurs in PMD 6.52.0
• java-design
  • #2127: [java] Deprecate rules ExcessiveClassLength and ExcessiveMethodLength
• java-errorprone
  • #4164: [java][doc] AvoidAssertAsIdentifier and AvoidEnumAsIdentifier - clarify use case
• java-multithreading
  • #4210: [java] DoNotUseThreads report duplicate warnings

API Changes

Deprecated APIs

For removal

These classes / APIs have been deprecated and will be removed with PMD 7.0.0.

• ExcessiveLengthRule (Java)

External Contributions

• #4244: [apex] ApexCRUDViolation: user mode and system mode with test cases added - Tarush Singh (@Tarush-Singh35)
• #4274: [java] Fix finding lambda scope in record compact constructor - kdebski85 (@kdebski85)

Stats

• 43 commits
• 17 closed tickets & PRs
• Days since last release: 35

26-November-2022 - 6.52.0

The PMD team is pleased to announce PMD 6.52.0.

This is a minor release.

Table Of Contents

• New and noteworthy
  • New rules
  • Renamed rules
  • Modified rules
• Fixed Issues
• API Changes
  • PMD CLI
  • CPD CLI
  • Linux run.sh parameters
  • Deprecated API
• External Contributions
• Stats

New and noteworthy

New rules

• The new Java rule InvalidJavaBean identifies beans, that don’t follow the JavaBeans API specification, like beans with missing getters or setters.

<rule ref="category/java/design.xml/InvalidJavaBean"/>

Renamed rules

• The Java rule BeanMembersShouldSerialize has been renamed to NonSerializableClass. It has been revamped to only check for classes that are marked with Serializable and reports each field in it, that is not serializable.

  The property prefix has been deprecated, since in a serializable class all fields have to be serializable regardless of the name.

Modified rules

• The rule ClassNamingConventions has a new property testClassPattern, which is applied to test classes. By default, test classes should end with the suffix “Test”. Test classes are top-level classes, that either inherit from JUnit 3 TestCase or have at least one method annotated with the Test annotations from JUnit4/5 or TestNG.

• The property ignoredAnnotations of rule ImmutableField has been deprecated and doesn’t have any effect anymore. Since PMD 6.47.0, the rule only considers fields, that are initialized once and never changed. If the field is just declared but never explicitly initialized, it won’t be reported. That’s the typical case when a framework sets the field value by reflection. Therefore, the property is not needed anymore. If there is a special case where this rule misidentifies fields as immutable, then the rule should be suppressed for these fields explicitly.

Fixed Issues

• cli
  • #4215: NullPointerException when trying to open designer
• doc
  • #4207: [doc] List all languages in rule doc
• java
  • #3643: [java] More parser edge cases
  • #4152: [java] Parse error on array type annotations
• java-codestyle
  • #2867: [java] Separate pattern for test classes in ClassNamingConventions rule for Java
  • #4201: [java] CommentDefaultAccessModifier should consider lombok’s @Value
• java-design
  • #4175: [java] ImmutableField - deprecate property ignoredAnnotations
  • #4177: [java] New Rule InvalidJavaBean
  • #4188: [java] ClassWithOnlyPrivateConstructorsShouldBeFinal false positive with Lombok’s @NoArgsConstructor
  • #4189: [java] AbstractClassWithoutAnyMethod should consider lombok’s @AllArgsConstructor
  • #4200: [java] ClassWithOnlyPrivateConstructorsShouldBeFinal should consider lombok’s @Value
• java-errorprone
  • #1668: [java] BeanMembersShouldSerialize is extremely noisy
  • #4172: [java] InvalidLogMessageFormat false positive on externally formatted strings
  • #4174: [java] MissingStaticMethodInNonInstantiatableClass does not consider nested builder class
  • #4176: [java] Rename BeanMembersShouldSerialize to NonSerializableClass
  • #4185: [java] InvalidLogMessageFormat rule produces a NPE
  • #4224: [java] MissingStaticMethodInNonInstantiatableClass should consider Lombok’s @UtilityClass
  • #4225: [java] MissingStaticMethodInNonInstantiatableClass should consider Lombok’s @NoArgsConstructor
• java-performance
  • #4183: [java] AvoidArrayLoops regression: from false negative to false positive with final variables

API Changes

PMD CLI

• PMD now supports a new --use-version flag, which receives a language-version pair (such as java-8 or apex-54). This supersedes the usage of -language / -l and -version / -v, allowing for multiple versions to be set in a single run. PMD 7 will completely remove support for -language and -version in favor of this new flag.

• Support for -V is being deprecated in favor of --verbose in preparation for PMD 7. In PMD 7, -v will enable verbose mode and -V will show the PMD version for consistency with most Unix/Linux tools.

• Support for -min is being deprecated in favor of --minimum-priority for consistency with most Unix/Linux tools, where -min would be equivalent to -m -i -n.

CPD CLI

• CPD now supports using -d or --dir as an alias to --files, in favor of consistency with PMD. PMD 7 will remove support for --files in favor of these new flags.

Linux run.sh parameters

• Using run.sh cpdgui will now warn about it being deprecated. Use run.sh cpd-gui instead.

• The old designer (run.sh designerold) is completely deprecated and will be removed in PMD 7. Switch to the new JavaFX designer: run.sh designer.

• The old visual AST viewer (run.sh bgastviewer) is completely deprecated and will be removed in PMD 7. Switch to the new JavaFX designer: run.sh designer for a visual tool, or use run.sh ast-dump for a text-based alternative.

Deprecated API

• The following core APIs have been marked as deprecated for removal in PMD 7:
  • PMD and PMD.StatusCode - PMD 7 will ship with a revamped CLI split from pmd-core. To programmatically launch analysis you can use PmdAnalysis.
  • PMDConfiguration#getAllInputPaths - It is now superseded by PMDConfiguration#getInputPathList
  • PMDConfiguration#setInputPaths - It is now superseded by PMDConfiguration#setInputPathList
  • PMDConfiguration#addInputPath - It is now superseded by PMDConfiguration#addInputPath
  • PMDConfiguration#getInputFilePath - It is now superseded by PMDConfiguration#getInputFile
  • PMDConfiguration#getIgnoreFilePath - It is now superseded by PMDConfiguration#getIgnoreFile
  • PMDConfiguration#setInputFilePath - It is now superseded by PMDConfiguration#setInputFilePath
  • PMDConfiguration#setIgnoreFilePath - It is now superseded by PMDConfiguration#setIgnoreFilePath
  • PMDConfiguration#getInputUri - It is now superseded by PMDConfiguration#getUri
  • PMDConfiguration#setInputUri - It is now superseded by PMDConfiguration#setInputUri
  • PMDConfiguration#getReportFile - It is now superseded by PMDConfiguration#getReportFilePath
  • PMDConfiguration#setReportFile - It is now superseded by PMDConfiguration#setReportFile
  • PMDConfiguration#isStressTest and PMDConfiguration#setStressTest - Will be removed with no replacement.
  • PMDConfiguration#isBenchmark and PMDConfiguration#setBenchmark - Will be removed with no replacement, the CLI will still support it.
  • CPD and CPD.StatusCode - PMD 7 will ship with a revamped CLI split from pmd-core. An alterative to programatically launch CPD analysis will be added in due time.
• In order to reduce the dependency on Apex Jorje classes, the method DataType#fromBasicType has been deprecated. The equivalent method fromTypeName should be used instead.