mxenabled/coppuccino

Java rule enforcement

Download

Step 1. Add the JitPack repository to your build file

Add it in your root settings.gradle at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url 'https://jitpack.io' }
		}
	}

Add it in your settings.gradle.kts at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url = uri("https://jitpack.io") }
		}
	}

Add to pom.xml

	<repositories>
		<repository>
		    <id>jitpack.io</id>
		    <url>https://jitpack.io</url>
		</repository>
	</repositories>

Add it in your build.sbt at the end of resolvers:

 
    resolvers += "jitpack" at "https://jitpack.io"

Add it in your project.clj at the end of repositories:

 
    :repositories [["jitpack" "https://jitpack.io"]]

Step 2. Add the dependency

	dependencies {
		implementation 'com.github.mxenabled:coppuccino:4.3.1'
	}

	dependencies {
		implementation("com.github.mxenabled:coppuccino:4.3.1")
	}

	<dependency>
	    <groupId>com.github.mxenabled</groupId>
	    <artifactId>coppuccino</artifactId>
	    <version>4.3.1</version>
	</dependency>


                            
    libraryDependencies += "com.github.mxenabled" % "coppuccino" % "4.3.1"


                            
    :dependencies [[com.github.mxenabled/coppuccino "4.3.1"]]

Readme

Coppuccino

Gradle plugin collection for Java/Kotlin/Groovy style, standard, and safety enforcement.

What does it do?

Pulls together and configures the best java, kotlin, groovy style plugins. Defaults are setup for MX developers, but can be overridden.

Plugins:

Detekt
Gradle Dependency Check (Removed as of 2.0.0)
Jacoco
Spotless
Gradle Quality Plugin

Installing

Coppuccino is hosted via JitPack. To import it into your project, configure the JitPack repository in your build.gradle.

plugins {
  id: "com.github.mxenabled.coppuccino" version "4.3.1"
}
allprojects {
    repositories {
        ...
        maven { url 'https://jitpack.io' }
    }
}

Configuration

Example configuration with default values:

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
      'com.mx.mdx.models.*',
      'com.mx.mdx.Resources.*',
      'com.mx.mdx.Resources'
    ]
  }
  dependencies {
    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
  }
}

Init MX style configurations

$ gradle initCopConfigs

Deploying Locally

To create a local build of the accessor to use in connector services use

$ ./gradlew install

This will create a local build in your local maven repository that you can then reference in other services.

On OXS using gradle the default location for the local maven repository is

~/.m2/repository/com/mx/