update docs

Author: xvik

build.gradle

@@ -24,7 +24,7 @@ ext {
     animalsnifferVersion = '1.5.4'
     cpdVersion = '3.3'
     spotbugsPluginVersion = '4.7.9'
-    docVersion = '4.6.0'
+    docVersion = '4.7.0'
 }
 
 repositories { mavenLocal(); mavenCentral(); gradlePluginPortal() }

src/doc/docs/about/compatibility.md

@@ -4,7 +4,7 @@ Plugin compiled for java 8, compatible with java 11
 
 Gradle | Version
 --------|-------
-5.6     | 4.6.0
+5.6     | 4.7.0
 5.1     | [4.2.2](http://xvik.github.io/gradle-quality-plugin/4.2.2)
 4.1     | [3.4.0](http://xvik.github.io/gradle-quality-plugin/3.4.0)
 older   | [2.4.0](http://xvik.github.io/gradle-quality-plugin/2.4.0)

src/doc/docs/about/history.md

@@ -1,3 +1,24 @@
+### [4.7.0](http://xvik.github.io/gradle-quality-plugin/4.7.0) (2021-11-10)
+* Fix gradle 7 deprecation warnings (#30)
+* Update spotbugs plugin 4.7.1 -> 4.7.9
+  (maven group changed: gradle.plugin.com.github.spotbugs.snom -> com.github.spotbugs.snom)
+* Add spotbugsShowStackTraces option with default to false.
+  Option introduced to change the default for spotbug's showStackTraces option
+  to avoid additional stacktrace in logs in non-strict mode (when plugin not fails on errors)
+* Update spotbugs 4.2.3 -> 4.4.2
+* Update spotbugs exclusions:
+    - Exclude [EI_EXPOSE_REP](https://spotbugs.readthedocs.io/en/latest/bugDescriptions.html#ei-may-expose-internal-representation-by-returning-reference-to-mutable-object-ei-expose-rep)
+      due to confusing false positives
+    - Exclude [EI_EXPOSE_REP2](https://spotbugs.readthedocs.io/en/latest/bugDescriptions.html#ei2-may-expose-internal-representation-by-incorporating-reference-to-mutable-object-ei-expose-rep2)
+      due to confusing false positives
+* Update codenarc 2.1.0 -> 2.2.0
+* Update pmd 6.34 -> 6.40 (java 17 support)
+* Deprecate quality.pmdIncremental property because incremental analysis is enabled by default
+  since gradle 6.4 (property only useful for enabling it in gradle 5.6 - 6.3)
+* Update checkstyle 8.42 -> 9.1
+* Update checkstyle config:
+    - Add [NoWhitespaceBeforeCaseDefaultColon](https://checkstyle.sourceforge.io/config_whitespace.html#NoWhitespaceBeforeCaseDefaultColon)
+    
 ### [4.6.0](http://xvik.github.io/gradle-quality-plugin/4.6.0) (2021-05-01)
 * Fix gradle 7 compatibility (for checkstyle plugin)
 * Fix console output on windows (remove special unicode separator characters, appearing incorrectly)

src/doc/docs/guide/config.md

@@ -34,6 +34,8 @@ quality {
      * Enable PMD incremental analysis (cache results between builds to speed up processing).
      * This is a shortcut for pmd plugin's {@code pmd.incrementalAnalysis } configuration option.
      * Option is disabled by default due to possible side effects with build gradle cache or incremental builds.
+     * @deprecated from gradle 6.4 incremental analysis is enabled by default in pmd plugin! This option will not
+     * disable it (property is useful only for enabling it in gradle 5.6 - 6.3).
      */
     pmdIncremental = false
     
@@ -46,6 +48,13 @@ quality {
      */
     cpdUnifySources = true
 
+    /**
+     * Shortcut for spotbugs.showStackTraces. Original spotbugs property is enabled by default, causing
+     * not pretty exception logs in non strict mode (when not fails on errors). This option was introduced to change
+     * the default to false and not show that nasty stacktrace, but still provide an easy way to revert default back.
+     */
+    spotbugsShowStackTraces = false
+
     /**
      * The analysis effort level. The value specified should be one of min, default, or max.
      * Higher levels increase precision and find more bugs at the expense of running time and

src/doc/docs/tool/codenarc.md

@@ -42,4 +42,10 @@ To [suppress violation](http://codenarc.sourceforge.net/codenarc-configuring-rul
 
 ```java
 @SuppressWarnings("ClassJavadoc")
-```
+```
+
+Since [codenarc 2.2](https://github.com/CodeNarc/CodeNarc/pull/610) `CodeNarc.` prefix could be used to differentiate with pure java suppressions:
+
+```java
+@SuppressWarnings("CodeNarc.ClassJavadoc")
+```

src/doc/docs/tool/pmd.md

@@ -35,6 +35,7 @@ Tool config options with defaults:
 quality {
     pmdVersion = '{{ gradle.pmd }}'
     pmd = true // false to disable automatic plugin activation  
+    // @deprecated enabled by default since gradle 6.4 (property only useful for enabling it in gradle 5.6 - 6.3)
     pmdIncremental = false // true to enable pmd incremental analysis
 }
 ```

src/doc/docs/tool/spotbugs.md

@@ -58,6 +58,7 @@ Tool config options with defaults:
 quality {
     spotbugsVersion = '{{ gradle.spotbugs }}'
     spotbugs = true // false to disable automatic plugin activation
+    spotbugsShowStackTraces = false // changes default for spotbugs.showStackTraces
     spotbugsEffort = 'max'  // min, less, more or max
     spotbugsLevel = 'medium' // low, medium, high
     spotbugsMaxRank = 20 // 1-4 scariest, 5-9 scary, 10-14 troubling, 15-20 of concern  

src/main/groovy/ru/vyarus/gradle/plugin/quality/QualityExtension.groovy

@@ -105,7 +105,7 @@ class QualityExtension {
     /**
      * Shortcut for {@code spotbugs.showStackTraces}. Original spotbugs property is enabled by default, causing
      * not pretty exception logs in non strict mode (when not fails on errors). This option was introduced to change
-     * the default to false not not show that nasty stacktrace, but still provide an easy way to revert default back.
+     * the default to false and not show that nasty stacktrace, but still provide an easy way to revert default back.
      */
     boolean spotbugsShowStackTraces = false