Gradle Groovy Plugin

From NovaOrdis Knowledge Base
Jump to: navigation, search




The Groovy plugin introduces a new "groovy" source set, and its corresponding compilation tasks "compileGroovy", "compileTestGroovy", similar to compileJava and compileTestJava. Similarly to the Java plugin, which builds upon a Java Base plugin, the Groovy builds upon a Groovy Base plugin. The Groovy plugin automatically applies the Java plugin as well, which means that the project contains a source set for Java sources, and anything else the Java plugin provides. This does not mean that Java sources are required to be present in the project.

plugins {
    id 'groovy'

repositories {

dependencies {
    implementation 'org.codehaus.groovy:groovy-all:3.0.7'

The project follows the conventions introduced by the Java plugin:

└─ src
    ├─ main
    │   ├─ java
    │   ├─ groovy
    │   └─ resources
    └─ test
        ├─ java
        ├─ groovy
        └─ resources

Java and Groovy classes can coexist in the same project, and Java classes can even depend on Groovy classes through joint compilation, which allows you to freely mix Java and Groovy source code with bidirectional dependencies on each other. This can be achieved by placing Java code together with the Groovy source code in 'src/main/groovy'. Alternatively, the Groovy compiler can be configured to enable joint compilation. This is enabled as follows: = []
sourceSets.main.groovy.srcDirs = ['src/main/java', 'src/main/groovy']


The location of the source file directories can be changes reconfiguring source set in the same way it is done for the Java plugin:
Java_Plugin | Source Set Customization