Merge pull request #48 from mxenabled/mpc/disallow-config-overwrite

feat: support config overrides and the disabling of checkstyle

README.md

@@ -45,6 +45,7 @@ _In build.gradle_
 ```
 coppuccino {
   rootDir = "" # Relative path to project root
+  overwriteConfigs = true # Set to false to allow a project to manage its own copy of configs (e.g. spotbugs/exclude.xml) 
   coverage {
     minimumCoverage = 0.0   # Required percentage of test code coverage.
     excludes [ # Package paths to exclude from coverage calculation
@@ -57,6 +58,9 @@ coppuccino {
     lockingEnabled = true
     excludePreReleaseVersions = true # Set to false to allow for #.#.3.pre release versions to be included in --write-locks
   }
+  java {
+    enabled = true # Set to false to disable checkstyle (e.g. for projects that have no java files)
+  }
   kotlin {
     enabled = false # Set to true to enable kotlin linting with Detekt
   }

build.gradle

@@ -1,6 +1,5 @@
 plugins {
-  id "com.github.mxenabled.hush" version "2.3.5"
-  id "com.github.mxenabled.vogue" version "1.0.2"
+  id "com.github.mxenabled.vogue" version "1.0.3"
   id "groovy"
   id "java-gradle-plugin"
   id "java-library"

src/main/groovy/com/mx/coppuccino/CoppuccinoPlugin.groovy

@@ -41,11 +41,12 @@ class CoppuccinoPlugin implements Plugin<Project> {
     def coppuccino = project.extensions.create('coppuccino', CoppuccinoPluginExtension)
     def coverage = project.extensions.coppuccino.extensions.create('coverage', CoppuccinoCoverageExtension)
     def dependencies = project.extensions.coppuccino.extensions.create('dependencies', CoppuccinoDependenciesExtension)
+    def javaEx = project.extensions.coppuccino.extensions.create('java', CoppuccinoJavaExtension)
     def kotlinEx = project.extensions.coppuccino.extensions.create('kotlin', CoppuccinoKotlinExtension)
 
     project.plugins.withType(JavaPlugin) {
       project.afterEvaluate {
-        def initCopConfig = new CopyCopConfig(coppuccino.rootDir, project)
+        def initCopConfig = new CopyCopConfig(coppuccino.rootDir, project, coppuccino.overwriteConfigs)
         initCopConfig.run()
       }
 
@@ -65,7 +66,7 @@ class CoppuccinoPlugin implements Plugin<Project> {
           // **************************************
           quality {
             checkstyleVersion = '8.29'
-            checkstyle = true
+            checkstyle = javaEx.enabled
             codenarc = false
             pmd = true
             spotbugs = false

src/main/groovy/com/mx/coppuccino/CoppuccinoPluginExtension.groovy

@@ -17,6 +17,7 @@ package com.mx.coppuccino
 
 class CoppuccinoPluginExtension {
   String rootDir = ""
+  boolean overwriteConfigs = true
 }
 
 class CoppuccinoCoverageExtension {
@@ -36,6 +37,11 @@ class CoppuccinoDependenciesExtension {
   boolean excludePreReleaseVersions = true
 }
 
+class CoppuccinoJavaExtension {
+  // Enable java support by default
+  boolean enabled = true
+}
+
 class CoppuccinoKotlinExtension {
   // Disable kotlin support by default
   boolean enabled = false

src/main/groovy/com/mx/coppuccino/CopyCopConfig.groovy

@@ -25,10 +25,12 @@ class CopyCopConfig {
 
   String projectRoot
   Project project
+  Boolean overwriteConfigs
 
-  CopyCopConfig(String projectRoot, Project project) {
+  CopyCopConfig(String projectRoot, Project project, Boolean overwriteConfigs) {
     this.projectRoot = projectRoot
     this.project = project
+    this.overwriteConfigs = overwriteConfigs
   }
 
   void run() {
@@ -48,6 +50,11 @@ class CopyCopConfig {
   private void copyConfigFile(String resourcePath, String dest) {
     File target = new File(Paths.get(projectRoot, dest).toString())
     ensureDirectory(target.getParentFile())
+
+    if (!overwriteConfigs && target.exists()) {
+      return
+    }
+
     InputStream stream = getClass().getResourceAsStream(resourcePath)
     target.text = ''
     target << stream.text