change: Quality Plugin is now automatically applied (#205)

usefulness · Apr 10, 2021 · 14c0f6b · 14c0f6b
1 parent 7f23857
commit 14c0f6b
Show file tree

Hide file tree

Showing 20 changed files with 45 additions and 118 deletions.
diff --git a/Changelog.md b/Changelog.md
@@ -13,6 +13,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Divide plugins into multiple functional groups to avoid adding unnecessary dependencies
 - Update _Detekt_ to version _1.16.0_ see [release notes](https://github.com/detekt/detekt/releases/tag/v1.16.0)
 - Update _kotlinter-gradle_ to version _3.4.0_, see [release notes](https://github.com/jeremymailen/kotlinter-gradle/releases/tag/3.4.0)
+- Quality plugin can't be disabled anymore 
 
 ## [0.23.0] - 2021-02-06
 ## Changed

diff --git a/Readme.md b/Readme.md
@@ -144,18 +144,17 @@ apply plugin: 'com.starter.config'
  
 commonConfig {
     javaVersion JavaVersion.VERSION_1_8
-    javaFilesAllowed true
+    javaFilesAllowed = true
     androidPlugin {
         compileSdkVersion 29
         minSdkVersion 23
         targetSdkVersion 29
     }
     qualityPlugin {
-        enabled true
-        formatOnCompile false
+        formatOnCompile = false
     }
     versioningPlugin {
-        enabled true
+        enabled = true
     }
 }
 ```
@@ -165,7 +164,6 @@ commonConfig {
 - `androidPlugin`:
     - contains values passed to _Android Gradle Plugin_
 - `qualityPlugin`:
-    - `enabled` - enables/disables [Quality Plugin](#quality-plugin)
     - `formatOnCompile` - defines if ktlint should format source code on every compilation
 - `versioningPlugin`:
     - `enabled` - enables/disables [Versioning Plugin](#versioning-plugin)

diff --git a/android/src/main/kotlin/com/project/starter/modules/plugins/AndroidApplicationPlugin.kt b/android/src/main/kotlin/com/project/starter/modules/plugins/AndroidApplicationPlugin.kt
@@ -16,6 +16,7 @@ class AndroidApplicationPlugin : Plugin<Project> {
     override fun apply(target: Project) = with(target) {
         pluginManager.apply("com.android.application")
         pluginManager.apply("kotlin-android")
+        pluginManager.apply("com.starter.quality")
         pluginManager.apply(ConfigurationPlugin::class.java)
 
         extensions.create("projectConfig", AndroidApplicationConfigExtension::class.java)

diff --git a/android/src/main/kotlin/com/project/starter/modules/plugins/AndroidLibraryPlugin.kt b/android/src/main/kotlin/com/project/starter/modules/plugins/AndroidLibraryPlugin.kt
@@ -16,6 +16,7 @@ class AndroidLibraryPlugin : Plugin<Project> {
     override fun apply(target: Project): Unit = with(target) {
         pluginManager.apply("com.android.library")
         pluginManager.apply("kotlin-android")
+        pluginManager.apply("com.starter.quality")
         pluginManager.apply(ConfigurationPlugin::class.java)
 
         val rootConfig = this.rootConfig

diff --git a/android/src/test/kotlin/com/project/starter/modules/AndroidApplicataionPluginTest.kt b/android/src/test/kotlin/com/project/starter/modules/AndroidApplicataionPluginTest.kt
@@ -216,26 +216,4 @@ internal class AndroidApplicataionPluginTest : WithGradleProjectTest() {
         assertThat(qualityEnabled.task(":module1:projectCodeStyle")?.outcome).isNotNull()
         assertThat(qualityEnabled.task(":module2:projectCodeStyle")?.outcome).isNotNull()
     }
-
-    @Test
-    fun `does not configure quality plugin if disabled using configuration plugin`() {
-        @Language("groovy")
-        val qualityScript =
-            """
-            plugins {
-                id('com.starter.config')
-            }
-            
-            commonConfig {
-                qualityPlugin {
-                    enabled = false
-                }
-            }
-            """.trimIndent()
-        rootBuildScript.writeText(qualityScript)
-
-        val qualityDisabled = runTask("projectCodeStyle", shouldFail = true)
-
-        assertThat(qualityDisabled.output).contains("Task 'projectCodeStyle' not found ")
-    }
 }
diff --git a/android/src/test/kotlin/com/project/starter/modules/AndroidLibraryPluginTest.kt b/android/src/test/kotlin/com/project/starter/modules/AndroidLibraryPluginTest.kt
@@ -266,26 +266,4 @@ internal class AndroidLibraryPluginTest : WithGradleProjectTest() {
         assertThat(qualityEnabled.task(":module1:projectCodeStyle")?.outcome).isNotNull()
         assertThat(qualityEnabled.task(":module2:projectCodeStyle")?.outcome).isNotNull()
     }
-
-    @Test
-    fun `does not configured quality plugin if disabled using configuration plugin`() {
-        @Language("groovy")
-        val qualityScript =
-            """
-            plugins {
-                id('com.starter.config')
-            }
-            
-            commonConfig {
-                qualityPlugin {
-                    enabled = false
-                }
-            }
-            """.trimIndent()
-        rootBuildScript.writeText(qualityScript)
-
-        val qualityDisabled = runTask("projectCodeStyle", shouldFail = true)
-
-        assertThat(qualityDisabled.output).contains("Task 'projectCodeStyle' not found ")
-    }
 }
diff --git a/android/src/test/kotlin/com/project/starter/quality/AndroidQualityPluginTest.kt b/android/src/test/kotlin/com/project/starter/quality/AndroidQualityPluginTest.kt
@@ -192,7 +192,7 @@ internal class AndroidQualityPluginTest : WithGradleProjectTest() {
             }
             
             commonConfig {
-                javaFilesAllowed false
+                javaFilesAllowed = false
             }
             """.trimIndent()
         rootDirectory.resolve("build.gradle").writeText(buildscript)

diff --git a/build.gradle b/build.gradle
@@ -17,6 +17,7 @@ allprojects {
     tasks.withType(KotlinCompile).configureEach {
         kotlinOptions {
             apiVersion = '1.3'
+            useIR = true
         }
     }
 

diff --git a/config/src/main/kotlin/com/project/starter/config/PluginUtils.kt b/config/src/main/kotlin/com/project/starter/config/PluginUtils.kt
@@ -1,6 +1,7 @@
 package com.project.starter.config
 
 import org.gradle.api.Project
+import org.gradle.api.model.ObjectFactory
 import org.gradle.api.plugins.ExtensionContainer
 
 inline fun <reified T> ExtensionContainer.getByType() =
@@ -10,3 +11,7 @@ inline fun <reified T> Project.withExtension(crossinline action: Project.(T) ->
     afterEvaluate {
         it.action(it.extensions.getByType())
     }
+
+inline fun <reified T> ObjectFactory.property(value: T?) = property(T::class.java).apply {
+    value(value)
+}
diff --git a/config/src/main/kotlin/com/project/starter/config/extensions/RootConfigExtension.kt b/config/src/main/kotlin/com/project/starter/config/extensions/RootConfigExtension.kt
@@ -43,15 +43,10 @@ open class RootConfigExtension(
 
 open class QualityPluginConfig(
     var formatOnCompile: Boolean = false,
-    var enabled: Boolean = true
 ) {
     fun formatOnCompile(value: Boolean) {
         formatOnCompile = value
     }
-
-    fun enabled(value: Boolean) {
-        enabled = value
-    }
 }
 
 open class AndroidPluginConfig(

diff --git a/config/src/test/kotlin/com/project/starter/plugins/CommonSettingsPluginTest.kt b/config/src/test/kotlin/com/project/starter/plugins/CommonSettingsPluginTest.kt
@@ -56,7 +56,6 @@ internal class CommonSettingsPluginTest : WithGradleProjectTest() {
                     targetSdkVersion = 30
                 }
                 qualityPlugin {
-                    enabled = true
                     formatOnCompile = true
                 }
                 versioningPlugin {
@@ -89,7 +88,6 @@ internal class CommonSettingsPluginTest : WithGradleProjectTest() {
                     targetSdkVersion 30
                 }
                 qualityPlugin {
-                    enabled true
                     formatOnCompile true
                 }
                 versioningPlugin {

diff --git a/jvm/src/main/kotlin/com/project/starter/modules/plugins/ConfigurationPlugin.kt b/jvm/src/main/kotlin/com/project/starter/modules/plugins/ConfigurationPlugin.kt
@@ -10,24 +10,17 @@ import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
 class ConfigurationPlugin : Plugin<Project> {
 
     override fun apply(target: Project): Unit = with(target) {
-        afterEvaluate {
-            if (rootConfig.quality.enabled) {
-                pluginManager.apply("com.starter.quality")
-            }
-        }
         afterEvaluate {
             if (rootConfig.versioning.enabled) {
                 if (!rootProject.pluginManager.hasPlugin("com.starter.versioning")) {
                     logger.info("Apply com.starter.versioning to $rootProject")
                     rootProject.pluginManager.apply(VersioningPlugin::class.java)
                 }
             }
+            tasks.withType(KotlinCompile::class.java).configureEach {
+                it.kotlinOptions.jvmTarget = rootConfig.javaVersion.toString()
+            }
         }
         configureRepositories()
-
-        val javaVersion = rootConfig.javaVersion
-        tasks.withType(KotlinCompile::class.java).configureEach {
-            it.kotlinOptions.jvmTarget = javaVersion.toString()
-        }
     }
 }
diff --git a/jvm/src/main/kotlin/com/project/starter/modules/plugins/KotlinLibraryPlugin.kt b/jvm/src/main/kotlin/com/project/starter/modules/plugins/KotlinLibraryPlugin.kt
@@ -15,6 +15,7 @@ class KotlinLibraryPlugin : Plugin<Project> {
 
     override fun apply(target: Project) = with(target) {
         pluginManager.apply("kotlin")
+        pluginManager.apply("com.starter.quality")
         pluginManager.apply(ConfigurationPlugin::class.java)
 
         extensions.create("projectConfig", KotlinLibraryConfigExtension::class.java)

diff --git a/jvm/src/test/kotlin/com/project/starter/modules/KotlinLibraryPluginTest.kt b/jvm/src/test/kotlin/com/project/starter/modules/KotlinLibraryPluginTest.kt
@@ -145,28 +145,6 @@ internal class KotlinLibraryPluginTest : WithGradleProjectTest() {
         assertThat(qualityEnabled.task(":module2:projectCodeStyle")?.outcome).isNotNull()
     }
 
-    @Test
-    fun `does not configure quality plugin if disabled using configuration plugin`() {
-        @Language("groovy")
-        val qualityScript =
-            """
-            plugins {
-                id('com.starter.config')
-            }
-            
-            commonConfig {
-                qualityPlugin {
-                    enabled = false
-                }
-            }
-            """.trimIndent()
-        rootBuildScript.writeText(qualityScript)
-
-        val qualityDisabled = runTask("projectCodeStyle", shouldFail = true)
-
-        assertThat(qualityDisabled.output).contains("Task 'projectCodeStyle' not found ")
-    }
-
     @Test
     fun `configures versioning plugin by default`() {
         val git = setupGit(origin)

diff --git a/quality/src/main/kotlin/com/project/starter/quality/internal/Checkstyle.kt b/quality/src/main/kotlin/com/project/starter/quality/internal/Checkstyle.kt
@@ -4,8 +4,7 @@ package com.project.starter.quality.internal
 
 import com.android.build.gradle.BaseExtension
 import com.android.build.gradle.api.AndroidSourceSet
-import com.android.build.gradle.internal.tasks.factory.dependsOn
-import com.project.starter.config.extensions.RootConfigExtension
+import com.project.starter.config.plugins.rootConfig
 import com.project.starter.config.withExtension
 import com.project.starter.quality.extensions.JavaSourcesAware
 import com.project.starter.quality.tasks.GenerateCheckstyleBaselineTask.Companion.addGenerateCheckstyleBaselineTask
@@ -15,7 +14,7 @@ import org.gradle.api.file.FileTree
 import org.gradle.api.plugins.quality.Checkstyle
 import org.gradle.api.plugins.quality.CheckstyleExtension
 
-private val pluginsWithConfgiuration = listOf(
+private val pluginsWithConfiguration = listOf(
     Config(
         plugin = "kotlin",
         starterPlugin = "com.starter.library.kotlin",
@@ -39,8 +38,8 @@ private data class Config(
     val configuration: Project.() -> Unit
 )
 
-internal fun Project.configureCheckstyle(rootConfig: RootConfigExtension) {
-    pluginsWithConfgiuration.forEach { (plugin, starterPlugin, configuration) ->
+internal fun Project.configureCheckstyle() {
+    pluginsWithConfiguration.forEach { (plugin, starterPlugin, configuration) ->
         pluginManager.withPlugin(plugin) {
             if (pluginManager.hasPlugin(starterPlugin)) {
                 withExtension<JavaSourcesAware> {

diff --git a/quality/src/main/kotlin/com/project/starter/quality/internal/Detekt.kt b/quality/src/main/kotlin/com/project/starter/quality/internal/Detekt.kt
@@ -1,13 +1,13 @@
 package com.project.starter.quality.internal
 
-import com.project.starter.config.extensions.RootConfigExtension
+import com.project.starter.config.plugins.rootConfig
 import com.project.starter.quality.tasks.ProjectCodeStyleTask
 import io.gitlab.arturbosch.detekt.Detekt
 import io.gitlab.arturbosch.detekt.DetektPlugin
 import io.gitlab.arturbosch.detekt.extensions.DetektExtension
 import org.gradle.api.Project
 
-internal fun Project.configureDetekt(config: RootConfigExtension) {
+internal fun Project.configureDetekt() {
     pluginManager.apply(DetektPlugin::class.java)
 
     extensions.configure(DetektExtension::class.java) { detekt ->
@@ -26,6 +26,6 @@ internal fun Project.configureDetekt(config: RootConfigExtension) {
         it.dependsOn("$path:detekt")
     }
     tasks.withType(Detekt::class.java) {
-        it.jvmTarget = config.javaVersion.toString()
+        it.jvmTarget = rootConfig.javaVersion.toString()
     }
 }
diff --git a/quality/src/main/kotlin/com/project/starter/quality/plugins/QualityPlugin.kt b/quality/src/main/kotlin/com/project/starter/quality/plugins/QualityPlugin.kt
@@ -24,16 +24,10 @@ class QualityPlugin : Plugin<Project> {
         repositories.mavenCentral()
         addProjectCodeStyleTask()
         configureKtlint()
-        configureDetekt(rootConfig)
-        configureCheckstyle(rootConfig)
+        configureDetekt()
+        configureCheckstyle()
         configureIssueCheckerTask()
-
-        val config = rootConfig.quality
-        afterEvaluate {
-            if (config.formatOnCompile) {
-                applyFormatOnRecompile()
-            }
-        }
+        configureFormatOnRecompile()
     }
 
     private fun Project.configureIssueCheckerTask() {
@@ -59,20 +53,26 @@ class QualityPlugin : Plugin<Project> {
         }
     }
 
-    private fun Project.applyFormatOnRecompile() {
+    private fun Project.configureFormatOnRecompile() {
         pluginManager.withPlugin("kotlin") {
             tasks.named("compileKotlin") {
-                it.dependsOn("$path:formatKotlin")
+                if (rootConfig.quality.formatOnCompile) {
+                    it.dependsOn("$path:formatKotlin")
+                }
             }
         }
         pluginManager.withPlugin("com.android.library") {
             tasks.named("preBuild") {
-                it.dependsOn("$path:formatKotlin")
+                if (rootConfig.quality.formatOnCompile) {
+                    it.dependsOn("$path:formatKotlin")
+                }
             }
         }
         pluginManager.withPlugin("com.android.application") {
             tasks.named("preBuild") {
-                it.dependsOn("$path:formatKotlin")
+                if (rootConfig.quality.formatOnCompile) {
+                    it.dependsOn("$path:formatKotlin")
+                }
             }
         }
     }

diff --git a/quality/src/test/kotlin/com/project/starter/quality/QualityPluginTest.kt b/quality/src/test/kotlin/com/project/starter/quality/QualityPluginTest.kt
@@ -73,7 +73,7 @@ internal class QualityPluginTest : WithGradleProjectTest() {
                 
                 commonConfig {
                     qualityPlugin {
-                        formatOnCompile = true
+                        formatOnCompile true
                     }
                 }
                 """.trimIndent()
@@ -138,7 +138,7 @@ internal class QualityPluginTest : WithGradleProjectTest() {
             }
             
             commonConfig {
-                javaFilesAllowed false
+                javaFilesAllowed = false
             }
             
             repositories.jcenter()

diff --git a/sample/android/build.gradle b/sample/android/build.gradle
@@ -29,8 +29,8 @@ buildscript {
 apply plugin: 'com.starter.config'
 
 commonConfig {
-    javaFilesAllowed false
+    javaFilesAllowed = false
     versioningPlugin {
-        enabled false
+        enabled = false
     }
-}
+}
diff --git a/sample/kotlin/build.gradle b/sample/kotlin/build.gradle
@@ -21,8 +21,8 @@ buildscript {
 apply plugin: 'com.starter.config'
 
 commonConfig {
-    javaFilesAllowed false
+    javaFilesAllowed = false
     versioningPlugin {
-        enabled false
+        enabled = false
     }
-}
+}