phoedos/pmd
1
1
Fork 1
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update release notes, fixes #1321, refs #1817

Browse Source
This commit is contained in:
Andreas Dangel
2019-05-17 16:14:15 +02:00
parent 609750332a
commit eae662ac94
3 changed files with 62 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
docs/pages/release_notes.md
View File

@ -14,8 +14,47 @@ This is a {{ site.pmd.release_type }} release.
### New and noteworthy
#### New Rules
* The new Apex rule {% rule "apex/codestyle/FieldNamingConventions" %} (`apex-codestyle`) checks the naming
conventions for field declarations. By default this rule uses the standard Apex naming convention (Camel case),
but it can be configured through properties.
* The new Apex rule {% rule "apex/codestyle/FormalParameterNamingConventions" %} (`apex-codestyle`) checks the
naming conventions for formal parameters of methods. By default this rule uses the standard Apex naming
convention (Camel case), but it can be configured through properties.
* The new Apex rule {% rule "apex/codestyle/LocalVariableNamingConventions" %} (`apex-codestyle`) checks the
naming conventions for local variable declarations. By default this rule uses the standard Apex naming
convention (Camel case), but it can be configured through properties.
* The new Apex rule {% rule "apex/codestyle/PropertyNamingConventions" %} (`apex-codestyle`) checks the naming
conventions for property declarations. By default this rule uses the standard Apex naming convention (Camel case),
but it can be configured through properties.
#### Modified Rules
* The Apex rule {% rule "apex/codestyle/ClassNamingConventions" %} (`apex-codestyle`) can now be configured
using various properties for the specific kind of type declarations (e.g. class, interface, enum).
As before, this rule uses by default the standard Apex naming convention (Pascal case).
* The Apex rule {% rule "apex/codestyle/MethodNamingConventions" %} (`apex-codestyle`) can now be configured
using various properties to differenciate e.g. static methods and test methods.
As before, this rule uses by default the standard Apex naming convention (Camel case).
#### Deprecated Rules
* The Apex rule {% rule "apex/codestyle/VariableNamingConventions" %} (`apex-codestyle`) has been deprecated and
will be removed with PMD 7.0.0. The rule is replaced by the more general rules
{% rule "apex/codestyle/FieldNamingConventions" %},
{% rule "apex/codestyle/FormalParameterNamingConventions" %},
{% rule "apex/codestyle/LocalVariableNamingConventions" %}, and
{% rule "apex/codestyle/PropertyNamingConventions" %}.
### Fixed Issues
* apex
* [#1321](https://github.com/pmd/pmd/issues/1321): \[apex] Should VariableNamingConventions require properties to start with a lowercase letter?
* dart
* [#1809](https://github.com/pmd/pmd/issues/1809): \[dart] \[cpd] Parse error with escape sequences
* java-bestpractices
@ -32,6 +71,7 @@ This is a {{ site.pmd.release_type }} release.
* [#1799](https://github.com/pmd/pmd/pull/1799): \[java] MethodReturnsInternalArray does not work in inner classes - Fixed #1738 - [Srinivasan Venkatachalam](https://github.com/Srini1993)
* [#1802](https://github.com/pmd/pmd/pull/1802): \[python] \[cpd] Add support for Python 2 backticks - [Maikel Steneker](https://github.com/maikelsteneker)
* [#1803](https://github.com/pmd/pmd/pull/1803): \[dart] \[cpd] Dart escape sequences - [Maikel Steneker](https://github.com/maikelsteneker)
* [#1817](https://github.com/pmd/pmd/pull/1817): \[apex] Add configurable naming convention rules - [Jeff Hube](https://github.com/jeffhube)
{% endtocmaker %}

10
pmd-apex/src/main/resources/category/apex/codestyle.xml
View File

@ -314,11 +314,11 @@ A variable naming conventions rule - customize this to your liking. Currently,
checks for final variables that should be fully capitalized and non-final variables
that should not include underscores.
This rule is deprecated. The rule is replaced
by the more general rules {% rule apex/codestyle/FieldNamingConventions %},
{% rule apex/codestyle/FormalParameterNamingConventions %},
{% rule apex/codestyle/LocalVariableNamingConventions %}, and
{% rule apex/codestyle/PropertyNamingConventions %}.
This rule is deprecated and will be removed with PMD 7.0.0. The rule is replaced
by the more general rules {% rule "apex/codestyle/FieldNamingConventions" %},
{% rule "apex/codestyle/FormalParameterNamingConventions" %},
{% rule "apex/codestyle/LocalVariableNamingConventions" %}, and
{% rule "apex/codestyle/PropertyNamingConventions" %}.
</description>
<priority>1</priority>
<example>

17
pmd-core/src/main/resources/rulesets/releases/6150.xml Normal file
View File

@ -0,0 +1,17 @@
<?xml version="1.0"?>
<ruleset name="6150"
xmlns="http://pmd.sourceforge.net/ruleset/2.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://pmd.sourceforge.net/ruleset/2.0.0 https://pmd.sourceforge.io/ruleset_2_0_0.xsd">
<description>
This ruleset contains links to rules that are new in PMD v6.15.0
</description>
<rule ref="category/apex/codestyle/FieldNamingConventions"/>
<rule ref="category/apex/codestyle/FormalParameterNamingConventions"/>
<rule ref="category/apex/codestyle/LocalVariableNamingConventions"/>
<rule ref="category/apex/codestyle/PropertyNamingConventions"/>
</ruleset>