Using custom source sets

Tableau allows you to add custom source sets to your project. This can be useful if you want to separate your code into different modules or if you want to have a separate source set for your tests. By default, Tableau configures the following source sets:

• main
• test

As these come from the Java plugin, you can use them as you would in a normal Gradle project.

However, if you want to add your own modules to your project, you might want to consider adding custom source sets. This guide will describe how you can add custom source sets to your project, and how to configure them.

Adding custom source sets

To add custom source sets to your project, you can use the sourceSets block of the Tableau DSL. This block allows you to add custom source sets to your project and configure them.

The following example shows how you can add a custom source set to your project:

Groovy

build.gradle

tableau {
    sourceSets {
        mySourceSet {
            java {
                srcDir 'src/mySourceSet/java'
            }
            resources {
                srcDir 'src/mySourceSet/resources'
            }
        }
    }
}

Kotlin

build.gradle.kts

tableau {
    sourceSets {
        create("mySourceSet") {
            java.srcDir("src/mySourceSet/java")
            resources.srcDir("src/mySourceSet/resources")
        }
    }
}

In this example, we add a custom source set called mySourceSet to our project. This source set has a Java source directory and a resources-directory.

Marking the source set as included in the primary jar

By default, Tableau will not include the classes and resources of custom source sets in the primary jar. If you want to include the classes and resources of a custom source set in the primary jar, you can use the isPartOfPrimaryJar property of the source set:

Groovy

build.gradle

tableau {
    sourceSets {
        mySourceSet {
            isPartOfPrimaryJar = true
        }
    }
}

Kotlin

build.gradle.kts

tableau {
    sourceSets {
        create("mySourceSet") {
            isPartOfPrimaryJar = true
        }
    }
}

In this example, we mark the mySourceSet source set as part of the primary jar.

Publishing the source set as a custom jar

If you want to publish the classes and resources of a custom source set as a separate jar, you can use the isPublished property of the source set:

Groovy

build.gradle

tableau {
    sourceSets {
        mySourceSet {
            isPublished = true
        }
    }
}

Kotlin

build.gradle.kts

tableau {
    sourceSets {
        create("mySourceSet") {
            isPublished = true
        }
    }
}

In this example, we mark the mySourceSet source set as published. This will cause the jar, javadoc and sources jar of the source set to be published configured repositories.

Add dependencies to the source set

If you want to add dependencies to a custom source set, you can use the dependencies block of the source set:

Groovy

build.gradle

tableau {
    sourceSets {
        mySourceSet {
            dependencies {
                implementation 'com.google.guava:guava:30.1-jre'
            }
        }
    }
}

Kotlin

build.gradle.kts

tableau {
    sourceSets {
        create("mySourceSet") {
            dependencies {
                implementation("com.google.guava:guava:30.1-jre")
            }
        }
    }
}

warning

Please note that this system does not support extending the implementation and api configurations of each source set, yet. We are working on improving the API for this.

If you want to achieve this, you can do so, as these configurations are just mirrors of the configurations of the project. So if you want to extend your configuration, use the normal Gradle way of doing so.

In this example, we add a dependency to the mySourceSet source set. This system supports using version catalogs and other dependency management features of Gradle:

Groovy

build.gradle

tableau {
    sourceSets {
        mySourceSet {
            dependencies {
                implementation platform('com.google.guava:guava-bom:30.1-jre')
                implementation libs.bundles.guava
            }
        }
    }
}

Kotlin

build.gradle.kts

tableau {
    sourceSets {
        create("mySourceSet") {
            dependencies {
                implementation(platform("com.google.guava:guava-bom:30.1-jre"))
                implementation(libs.bundles.guava)
            }
        }
    }
}