Release

CHANGELOG.md

@@ -1,6 +1,21 @@
 Change Log
 ==========
 
+[Version 1.0](https://github.com/novoda/gradle-static-analysis-plugin/releases/tag/v1.0)
+--------------------------
+
+- Add support for task configuration avoidance [PR#184](https://github.com/novoda/gradle-static-analysis-plugin/pull/184) [PR#186](https://github.com/novoda/gradle-static-analysis-plugin/pull/186) [PR#189](https://github.com/novoda/gradle-static-analysis-plugin/pull/189)
+  - This is a big performance improvement and a recommended upgrade for all users.
+  - Unless `evaluateViolations` or `check` task is run explicitly, no task will be configured eagerly. 
+  - More info on Gradle: https://docs.gradle.org/current/userguide/task_configuration_avoidance.html
+- Removed support for older versions of Ktlint and Detekt
+  - Minimum supported Ktlint Plugin: `6.2.1`
+  - Minimum supported Detekt Plugin: `1.0.0.RC9.2`
+- Fix: In some cases Groovy closures would use wrong scope [PR#185](https://github.com/novoda/gradle-static-analysis-plugin/pull/185)
+- Fix: check task not found on empty project [PR#187](https://github.com/novoda/gradle-static-analysis-plugin/pull/187)
+- Detekt is automatically configured to disable failFast since failure is handled by Static Analysis Plugin [PR#186](https://github.com/novoda/gradle-static-analysis-plugin/pull/186)
+- Update sample with new versions and make use of task configuration avoidance [PR#188](https://github.com/novoda/gradle-static-analysis-plugin/pull/188)
+
 [Version 0.8.1](https://github.com/novoda/gradle-static-analysis-plugin/releases/tag/v0.8.1)
 --------------------------
 

README.md

@@ -1,8 +1,10 @@
 # Gradle static analysis plugin
-[![](https://ci.novoda.com/buildStatus/icon?job=gradle-static-analysis-plugin)](https://ci.novoda.com/job/gradle-static-analysis-plugin/lastSuccessfulBuild) [![](https://img.shields.io/badge/License-Apache%202.0-lightgrey.svg)](LICENSE.txt) [![Bintray](https://api.bintray.com/packages/novoda/maven/gradle-static-analysis-plugin/images/download.svg)](https://bintray.com/novoda/maven/gradle-static-analysis-plugin/_latestVersion)
+[![](https://ci.novoda.com/buildStatus/icon?job=gradle-static-analysis-plugin)](https://ci.novoda.com/job/gradle-static-analysis-plugin/lastSuccessfulBuild) [![](https://img.shields.io/badge/License-Apache%202.0-lightgrey.svg)](LICENSE.txt) [![Bintray](https://api.bintray.com/packages/novoda/maven/gradle-static-analysis-plugin/images/download.svg)](https://bintray.com/novoda-oss/maven/gradle-static-analysis-plugin/_latestVersion)
 
 A Gradle plugin to easily apply the same setup of static analysis tools across different Android, Java or Kotlin projects.
 
+Supports [Task Configuration Avoidance](https://docs.gradle.org/current/userguide/task_configuration_avoidance.html) so that you have zero overhead in build speeds when you use this plugin!
+
 ## Description
 Gradle supports many popular static analysis (Checkstyle, PMD, FindBugs, etc) via a set of built-in plugins.
 Using these plugins in an Android module will require an additional setup to compensate for the differences between
@@ -17,16 +19,25 @@ The `gradle-static-analysis-plugin` aims to provide:
 ### Supported tools
 The plugin supports various static analysis tools for Java, Kotlin and Android projects:
 
- * [`Checkstyle`](https://checkstyle.sourceforge.net)
- * [`PMD`](https://pmd.github.io)
- * [`FindBugs`](http://findbugs.sourceforge.net/)
- * [`Detekt`](https://github.com/arturbosch/detekt)
- * [`Android Lint`](https://developer.android.com/studio/write/lint.html)
- * [`KtLint`](https://github.com/shyiko/ktlint)
+ * [`Checkstyle`](docs/tools/checkstyle.md)
+ * [`PMD`](docs/tools/pmd.md)
+ * [`FindBugs`](docs/tools/findbugs.md)
+ * [`Detekt`](docs/tools/detekt.md)
+ * [`Android Lint`](docs/tools/android_lint.md)
+ * [`KtLint`](docs/tools/ktlint.md)
 
 Please note that the tools availability depends on the project the plugin is applied to. For more details please refer to the
 [supported tools](docs/supported-tools.md) page.
 
+### Tools in-consideration
+
+ * `Spotbugs` [#142](https://github.com/novoda/gradle-static-analysis-plugin/issues/142)
+ * `CPD (Duplicate Code Detection) ` [#150](https://github.com/novoda/gradle-static-analysis-plugin/iss (Duplicate Code Detection) ues/150)
+ * `error-prone` [#151](https://github.com/novoda/gradle-static-analysis-plugin/issues/151)
+ * `Jetbrains IDEA Inspections` [#152](https://github.com/novoda/gradle-static-analysis-plugin/issues/152)
+
+For all tools in consideration, please refer to [issues](https://github.com/novoda/gradle-static-analysis-plugin/issues?q=is%3Aissue+is%3Aopen+label%3A%22new+tool%22). 
+
 ### Out-of-the-box support for Android projects
 Android projects use a Gradle model that is not compatible with the Java one, supported by the built-in static analysis tools plugins.
 Applying `gradle-static-analysis-plugin` to your Android project will make sure all the necessary tasks are created and correctly configured
@@ -81,19 +92,19 @@ This will enable all the tools with their default settings. For more advanced co
 There are two sample Android projects available, one consisting of a regular app - available [here](https://github.com/novoda/gradle-static-analysis-plugin/tree/master/sample) - and the other comprising a multi-module setup available [here](https://github.com/novoda/gradle-static-analysis-plugin/tree/master/sample-multi-module). Both sample projects showcase a setup featuring Checkstyle, FindBugs, PMD, Lint and Detekt.
 
 ## Snapshots
-[![CI status](https://ci.novoda.com/buildStatus/icon?job=gradle-static-analysis-plugin-snapshot)](https://ci.novoda.com/job/gradle-static-analysis-plugin-snapshot/lastBuild/console) [![Download from Bintray](https://api.bintray.com/packages/novoda/snapshots/gradle-static-analysis-plugin/images/download.svg)](https://bintray.com/novoda/snapshots/gradle-static-analysis-plugin/_latestVersion)
+[![CI status](https://ci.novoda.com/buildStatus/icon?job=gradle-static-analysis-plugin-snapshot)](https://ci.novoda.com/job/gradle-static-analysis-plugin-snapshot/lastBuild/console) [![Download from Bintray](https://api.bintray.com/packages/novoda-oss/snapshots/gradle-static-analysis-plugin/images/download.svg)](https://bintray.com/novoda-oss/snapshots/gradle-static-analysis-plugin/_latestVersion)
 
-Snapshot builds from [`develop`](https://github.com/novoda/gradle-static-analysis-plugin/compare/master...develop) are automatically deployed to a [repository](https://bintray.com/novoda/snapshots/gradle-static-analysis-plugin/_latestVersion) that is not synced with JCenter.
+Snapshot builds from [`develop`](https://github.com/novoda/gradle-static-analysis-plugin/compare/master...develop) are automatically deployed to a [repository](https://bintray.com/novoda-oss/snapshots/gradle-static-analysis-plugin/_latestVersion) that is not synced with JCenter.
 To consume a snapshot build add an additional maven repo as follows:
 ```
 repositories {
     maven {
-        url 'https://novoda.bintray.com/snapshots'
+        url 'https://dl.bintray.com/novoda-oss/snapshots/'
     }
 }
 ```
 
-You can find the latest snapshot version following this [link](https://bintray.com/novoda/snapshots/gradle-static-analysis-plugin/_latestVersion).
+You can find the latest snapshot version following this [link](https://bintray.com/novoda-oss/snapshots/gradle-static-analysis-plugin/_latestVersion).
 
 ## Roadmap
 The plugin is under active development and to be considered in **beta stage**. It is routinely used by many Novoda projects and

RELEASE.md

@@ -8,4 +8,4 @@
 1. Execute the [build job](https://ci.novoda.com/job/gradle-static-analysis-plugin/) manually with `BINTRAY_DRY_RUN=false`.
 1. After the release is successful do a manual [github release](https://github.com/novoda/gradle-static-analysis-plugin/releases) with the newly created tag. 
 
-This releases the plugin to [bintray](https://bintray.com/novoda/maven/gradle-static-analysis-plugin) and the [Gradle Plugins Repository](https://plugins.gradle.org/plugin/com.novoda.static-analysis).
+This releases the plugin to [bintray](https://bintray.com/novoda-oss/maven/gradle-static-analysis-plugin) and the [Gradle Plugins Repository](https://plugins.gradle.org/plugin/com.novoda.static-analysis).

docs/tools/detekt.md

@@ -3,6 +3,9 @@
 does not support Java. It can be used in both pure Kotlin, and Android Kotlin projects. It then only makes sense to have Detekt enabled if you
 have Kotlin code in your project. The plugin only runs Detekt on projects that contain the Kotlin or the Kotlin-Android plugin.
 
+> Supported Detekt Gradle Plugin version: **1.0.0.RC9.2 and above** 
+> Recommended Detekt Gradle Plugin version: **1.0.0-RC14 and above** 
+
 ## Table of contents
  * [IMPORTANT: setup Detekt](#important-setup-detekt)
  * [Configure Detekt](#configure-detekt)
@@ -25,7 +28,7 @@ In most common cases, adding Detekt to a project boils down to three simple step
  1. Add this statement to your root `build.gradle` project (change the version according to your needs):
     ```gradle
     plugins {
-        id 'io.gitlab.arturbosch.detekt' version '1.0.0.RC6-2'
+        id 'io.gitlab.arturbosch.detekt' version '1.0.0-RC14'
         // ...
     }
     ```
@@ -39,17 +42,15 @@ In most common cases, adding Detekt to a project boils down to three simple step
 
 ## Configure Detekt
 Enabling and configuring Detekt for a project is done through the `detekt` closure. The closure behaves exactly like the
-[standard Detekt plugin](https://github.com/arturbosch/detekt#using-the-detekt-gradle-plugin) does in Gradle, which is to say, quite differently
+[standard Detekt plugin](https://github.com/arturbosch/detekt#with-gradle) does in Gradle, which is to say, quite differently
 from how the other tools' configurations closures work. For example:
 
 ```gradle
 detekt {
-    profile('main') {
-        input = // A string pointing to a project's sources. E.g., "$projectDir/src/main/java"
-        config = // A file containing the Detekt configuration, e.g., teamPropsFile('static-analysis/detekt-config.yml')
-        filters = // A comma-separated list of regex exclusions, e.g., '.*test.*,.*/resources/.*,.*/tmp/.*'
-        output = // A string pointing to the output directory for the reports, e.g., "$projectDir/build/reports/detekt"
-    }
+    toolVersion = "[version]" // custom toolVersion defined. By default, it is the Gradle plugin version
+    input = files("src/main/kotlin") // Optional: files representing project's Kotlin sources
+    filters = ".*/resources/.*,.*/build/.*" // A comma-separated list of regex exclusions
+    baseline = file("my-detekt-baseline.xml") // Optional: Just if you want to create a baseline file.
 }
 ```
 
@@ -59,7 +60,7 @@ You need to provide **at a minimum** the `config` and `output` values. It's impo
 in the Detekt configuration file as it will interfere with the functioning of the Static Analysis plugin's threshold counting. For the same reason, make
 sure that `failFast` is set to `false` in the Detekt configuration.
 
-For more informations about Detekt rules, refer to the [official website](https://github.com/arturbosch/detekt/tree/master/detekt-generator/documentation).
+For more information about Detekt rules, refer to the [official website](https://arturbosch.github.io/detekt/#quick-start-with-gradle).
 
 ## Exclude files from Detekt analysis
 
@@ -71,4 +72,4 @@ The `filters` property expects a string consisting in a comma-separated list of
 
 ## Detekt in mixed-language projects
 If your project mixes Java and Kotlin code, you don't need to have an exclusion in place for all `*.java` files. Detekt itself only looks for
-`*.kt` files, so no further configuration is required.
+`*.kt` files, so no further configuration is required.

docs/tools/ktlint.md

@@ -2,6 +2,8 @@
 [Ktlint](https://github.com/shyiko/ktlint) is a linter for Kotlin with a built-in formatter. It does not support Java. Adding 
 this tool only makes sense when you have Kotlin sources in your project. 
 
+> Supported Ktlint Gradle Plugin version: **6.2.1 and above** 
+
 ## Table of contents
  * [IMPORTANT: setup Ktlint](#important-setup-ktlint)
  * [Configure Ktlint](#configure-ktlint)
@@ -24,7 +26,7 @@ In most common cases, adding Ktlint to a project boils down to these simple step
  1. Add this statement to your root `build.gradle` project (change the version according to your needs):
     ```gradle
     plugins {
-        id 'org.jlleitschuh.gradle.ktlint' version '5.1.0'
+        id 'org.jlleitschuh.gradle.ktlint' version '7.3.0'
         // ...
     }
     ```

gradle/publish.gradle

@@ -2,7 +2,7 @@ ext {
     websiteUrl = 'https://github.com/novoda/gradle-static-analysis-plugin'
 }
 
-version = '0.8.1'
+version = '1.0'
 groovydoc.docTitle = 'Static Analysis Plugin'
 
 apply plugin: 'com.novoda.build-properties'
@@ -14,13 +14,13 @@ buildProperties {
 
     secrets {
         using rootProject.file('secrets.properties')
-        description = '''
-    This file should contain:
-- git.username: the username used to push to the repo
-- git.password: the password used to push to the repo
-- gradle.publish.key: the key to publish the plugin to the Gradle Plugins Repository
-- gradle.publish.secret: the secret to publish the plugin to the Gradle Plugins Repository
-		'''
+        description = '''This file should contain:
+                        - git.username: the username used to push to the repo
+                        - git.password: the password used to push to the repo
+                        - gradle.publish.key: the key to publish the plugin to the Gradle Plugins Repository
+                        - gradle.publish.secret: the secret to publish the plugin to the Gradle Plugins Repository'''
+                .stripIndent()
+
     }
 
     cli {
@@ -30,14 +30,16 @@ buildProperties {
     bintray {
         def bintrayCredentials = {
             return isDryRun() ?
-                    ['bintrayRepo': 'n/a', 'bintrayUser': 'n/a', 'bintrayKey': 'n/a'] :
+                    ['bintrayOrg': 'n/a', 'bintrayRepo': 'n/a', 'bintrayUser': 'n/a', 'bintrayKey': 'n/a'] :
                     new File("${System.getenv('BINTRAY_PROPERTIES')}")
         }
         using(bintrayCredentials()).or(cli)
         description = '''This should contain the following properties:
-                         - bintrayRepo: name of the repo of the organisation to deploy the artifacts to
-                         - bintrayUser: name of the account used to deploy the artifacts
-                         - bintrayKey: API key of the account used to deploy the artifacts'''.stripIndent()
+                        - bintrayOrg: name of the Bintray organisation to deploy the artifacts to
+                        - bintrayRepo: name of the repo of the organisation to deploy the artifacts to
+                        - bintrayUser: name of the account used to deploy the artifacts
+                        - bintrayKey: API key of the account used to deploy the artifacts'''
+                .stripIndent()
     }
 
 }
@@ -46,13 +48,13 @@ apply plugin: 'com.gradle.plugin-publish'
 apply plugin: 'com.novoda.bintray-release'
 
 publish {
-    userOrg = 'novoda'
     groupId = 'com.novoda'
     artifactId = 'gradle-static-analysis-plugin'
     desc = 'Easy setup of static analysis tools for Android and Java projects.'
     publishVersion = buildVersion
 
     repoName = project.buildProperties.bintray['bintrayRepo'].string
+    userOrg = project.buildProperties.bintray['bintrayOrg'].string
     bintrayUser = project.buildProperties.bintray['bintrayUser'].string
     bintrayKey = project.buildProperties.bintray['bintrayKey'].string
     website = project.websiteUrl
@@ -200,7 +202,7 @@ boolean isSnapshot() {
 }
 
 String getBuildVersion() {
-    return isSnapshot() ? "SNAPSHOT-${System.getenv('BUILD_NUMBER') ?: 'LOCAL'}" : project.version
+    return isSnapshot() ? "DEVELOP-${System.getenv('BUILD_NUMBER') ?: 'LOCAL'}" : project.version
 }
 
 String getTag() {

plugin/src/main/groovy/com/novoda/staticanalysis/StaticAnalysisPlugin.groovy

@@ -1,6 +1,6 @@
 package com.novoda.staticanalysis
 
-import com.novoda.staticanalysis.internal.CodeQualityConfigurator
+import com.novoda.staticanalysis.internal.Configurator
 import com.novoda.staticanalysis.internal.checkstyle.CheckstyleConfigurator
 import com.novoda.staticanalysis.internal.detekt.DetektConfigurator
 import com.novoda.staticanalysis.internal.findbugs.FindbugsConfigurator
@@ -12,15 +12,17 @@ import org.gradle.api.Plugin
 import org.gradle.api.Project
 import org.gradle.api.Task
 
+import static com.novoda.staticanalysis.internal.TasksCompat.configureEach
+
 class StaticAnalysisPlugin implements Plugin<Project> {
 
     @Override
     void apply(Project project) {
         def pluginExtension = project.extensions.create('staticAnalysis', StaticAnalysisExtension, project)
         def evaluateViolations = createEvaluateViolationsTask(project, pluginExtension)
         createConfigurators(project, pluginExtension, evaluateViolations).each { configurator -> configurator.execute() }
-        project.afterEvaluate {
-            project.tasks['check'].dependsOn evaluateViolations
+        configureEach(project.tasks.matching { it.name == 'check' }) { task ->
+            task.dependsOn evaluateViolations
         }
     }
 
@@ -32,9 +34,9 @@ class StaticAnalysisPlugin implements Plugin<Project> {
         }
     }
 
-    private static List<CodeQualityConfigurator> createConfigurators(Project project,
-                                                                     StaticAnalysisExtension pluginExtension,
-                                                                     Task evaluateViolations) {
+    private static List<Configurator> createConfigurators(Project project,
+                                                          StaticAnalysisExtension pluginExtension,
+                                                          Task evaluateViolations) {
         NamedDomainObjectContainer<Violations> violationsContainer = pluginExtension.allViolations
         [
                 CheckstyleConfigurator.create(project, violationsContainer, evaluateViolations),