gradle-template

Advanced gradle template using Kotlin DSL

Introduction

This is an advanced gradle kotlin project template using gradle's kotlin DSL

Features:

• Multimodule setup
• buildSrc plugin scripts to be imported like the old groovy apply from format
• Extra properties as an example, as global versions.gradle.kts on buildSrc, overriden on the rootProject and then overriden per module on buildscript {} block
• Preconfigured java and java-test plugin scripts
• Preconfigured kotlin-jvm and kotlin-test plugin scripts, with spotless and klint (java plugin scripts doesn't have any linter)
• Preconfigured junit 5 script plugin with test summary output
• Preconfigured basic idea plugin
• .gitignore template
• .gitattributes template
• sample init.gradle.kts properties
• Some logging information added to several tasks, like version and properties output on compileJava, compileKotlin
• More logging information added to test, like logging version of the libraries included
• Different flavour per module (i.e. java module uses hamcrest and mockito while kotlin uses assertj and mockk
• Modules dependencies: kotlin module depends on java module by implementation flavour
• Gradle Wrapper included in the sources
• Gradle wrapper task example on root build.gradle.kts

This template is offered as it is as a learning resource or as a starting point to override and customize to everyone's needs. Some of the design choices made are an intentional exageration to ilustrate with examples what can be done. Please review before using this on production and tailor it to your needs.

Please bear in mind that gradle recommends to apply plugins on root project buildscript but that recommendation has been ignored on this template. The reasoning behind this is to make every buildscript minimal. If your buildscripts require the same plugin, please add it to the root buildscript as per gradle recommendations. See https://docs.gradle.org/current/userguide/kotlin_dsl.html#sec:multi_project_builds_applying_plugins for additional information: For example, to load common.gradle.scripts.java plugin on root buildscript but don't apply it:

plugins {
    id("common.gradle.scripts.java") false
}

Then it will be available (loaded) for modules. This might improve your build times if your plugins are shared accross modules.