README.md

Genesis Java Gradle Plugin

Basic configuration for Java based Gradle projects.

Activation

plugins {
    id("de.lancom.genesis.java") version "<version>"
}

Configuration

genesisJava {

    // register additional artifacts
    withJavadocJar() 
    withSourcesJar()
    
    // enable code quality checks
    withCheckstyle(
        checkstyleVersion = "8.39"
    )
    withPmd(
        pmdVersion = "6.21.0"
    )
    withSpotBugs(
        spotbugsVersion = "4.2.0"
    )
}

Checkstyle

Detekt can be configured using the config/checkstyle/checkstyle.xml config file like the example file file. For additional information see the Checkstyle documentation.

Pmd

KtLinkt can be configured using the config/pmd/pmd.xml rule file like the example file. For additional information see the Pmd documentation.

Spotbugs

Spotbugs can be configured using the config/spotbugs/include.xml include file like the example fileand config/spotbugs/exclude.xml. For additional information see the Spotbugs documentation.

Example

An example project can be found in the examples/project.

Execute ./gradlew -p example <tasks> to run tasks of the example project.

Plugins

• SpotBugs Plugin
• Checkstyle Plugin
• Pmd Plugin