pmd/docs/pages/release_notes.md

91 lines
4.1 KiB
Markdown
Raw Normal View History

---
title: PMD Release Notes
permalink: pmd_release_notes.html
keywords: changelog, release notes
---
2018-09-02 14:30:21 +02:00
## {{ site.pmd.date }} - {{ site.pmd.version }}
The PMD team is pleased to announce PMD {{ site.pmd.version }}.
2016-07-27 22:03:51 +02:00
This is a {{ site.pmd.release_type }} release.
2016-07-07 20:48:01 +02:00
2018-09-30 10:47:07 +02:00
{% tocmaker is_release_notes_processor %}
2017-04-29 20:22:28 +02:00
2021-08-28 17:31:18 +02:00
### New and noteworthy
2016-12-13 13:38:59 -03:00
### Fixed Issues
2018-09-05 01:16:04 -03:00
* core
* [#3424](https://github.com/pmd/pmd/issues/3424): \[core] Migrate CLI to using GNU-style long options
* [#3425](https://github.com/pmd/pmd/issues/3425): \[core] Add a `--version` CLI option
2021-11-23 20:24:44 +01:00
* [#3635](https://github.com/pmd/pmd/issues/3635): \[ci] Update sample projects for regression tester
* java-bestpractices
* [#3613](https://github.com/pmd/pmd/issues/3613): \[java] ArrayIsStoredDirectly doesn't consider nested classes
* [#3614](https://github.com/pmd/pmd/issues/3614): \[java] JUnitTestsShouldIncludeAssert doesn't consider nested classes
2021-11-13 10:25:12 +01:00
* [#3618](https://github.com/pmd/pmd/issues/3618): \[java] UnusedFormalParameter doesn't consider anonymous classes
* [#3630](https://github.com/pmd/pmd/issues/3630): \[java] MethodReturnsInternalArray doesn't consider anonymous classes
* java-errorprone
* [#3624](https://github.com/pmd/pmd/issues/3624): \[java] TestClassWithoutTestCases reports wrong classes in a file
* java-performance
* [#3491](https://github.com/pmd/pmd/issues/3491): \[java] UselessStringValueOf: False positive when `valueOf(char [], int, int)` is used
2021-08-28 17:31:18 +02:00
### API Changes
2021-08-07 14:49:01 +02:00
#### Command Line Interface
The command line options for PMD and CPD now use GNU-syle long options format. E.g. instead of `-rulesets` the
preferred usage is now `--rulesets`. Alternatively one can still use the short option `-R`.
Some options also have been renamed to a more consistent casing pattern at the same time
(`--fail-on-violation` instead of `-failOnViolation`).
The old single-dash options are still supported but are deprecated and will be removed with PMD 7.
2021-11-26 08:42:04 +01:00
This change makes the command line interface more consistent within PMD and also less surprising
compared to other cli tools.
The changes in detail for PMD:
|old option |new option|
|-------------------------------|----------|
| `-rulesets` | `--rulesets` (or `-R`) |
| `-uri` | `--uri` |
| `-dir` | `--dir` (or `-d`) |
| `-filelist` | `--file-list` |
| `-ignorelist` | `--ignore-list` |
| `-format` | `--format` (or `-f`) |
| `-debug` | `--debug` |
| `-verbose` | `--verbose` |
| `-help` | `--help` |
| `-encoding` | `--encoding` |
| `-threads` | `--threads` |
| `-benchmark` | `--benchmark` |
| `-stress` | `--stress` |
| `-shortnames` | `--short-names` |
| `-showsuppressed` | `--show-suppressed` |
| `-suppressmarker` | `--suppress-marker` |
| `-minimumpriority` | `--minimum-priority` |
| `-property` | `--property` |
| `-reportfile` | `--report-file` |
| `-force-language` | `--force-language` |
| `-auxclasspath` | `--aux-classpath` |
| `-failOnViolation` | `--fail-on-violation` |
| `--failOnViolation` | `--fail-on-violation` |
| `-norulesetcompatibility` | `--no-ruleset-compatibility` |
| `-cache` | `--cache` |
| `-no-cache` | `--no-cache` |
The changes in detail for CPD:
|old option |new option|
|-----------------------|----------|
| `--failOnViolation` | `--fail-on-violation` |
| `-failOnViolation` | `--fail-on-violation` |
| `--filelist` | `--file-list` |
2017-12-20 23:24:37 -03:00
### External Contributions
2021-05-29 07:13:48 +02:00
* [#3600](https://github.com/pmd/pmd/pull/3600): \[core] Implement GNU-style long options and '--version' - [Yang](https://github.com/duanyang25)
* [#3612](https://github.com/pmd/pmd/pull/3612): \[java] Created fix for UselessStringValueOf false positive - [John Armgardt](https://github.com/johnra2)
2018-08-18 16:44:45 +02:00
{% endtocmaker %}
2021-05-29 07:13:48 +02:00