org.danilopianini.javaqa.JavaQAExtension.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gradle-java-qa Show documentation

Automated Quality Assurance configuration for Java Projects built with Gradle

The newest version!

package org.danilopianini.javaqa

import org.gradle.api.Project
import org.gradle.api.provider.Property

/**
 * Extension for the Java QA plugin.
 */
open class JavaQAExtension(
    private val project: Project,
) {
    internal val checkstyle = Checkstyle()

    /**
     * DSL access to the checkstyle configuration.
     */
    fun checkstyle(action: Checkstyle.() -> Unit) { checkstyle.action() }

    /**
     * Option collection for checkstyle.
     */
    inner class Checkstyle {
        /**
         * Add suppressions to the pre-defined list.
         * It can be the path of a file with the suppressions in XML format or a string with the same content.
         */
        val additionalSuppressions: Property = project.objects.property(String::class.java)

        /**
         * Add rules to the pre-defined configuration.
         * It can be the path of a file with the rules in XML format or a string with the same content.
         */
        val additionalConfiguration: Property = project.objects.property(String::class.java)
    }
}