Skip to content
This repository was archived by the owner on Sep 4, 2023. It is now read-only.

README.md

Latest commit

 

History

History
59 lines (45 loc) · 1.82 KB

README.md

File metadata and controls

59 lines (45 loc) · 1.82 KB

Genesis Kotlin Gradle Plugin

Basic configuration of Kotlin based Gradle projects.

Activation

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

Configuration

genesisKotlin {

    // enable code documentation 
    withDokka()

    // register additional artifacts
    withJavadocJar() 
    withSourcesJar()
    
    // enable code quality checks
    withDetekt(
        detektVersion = "0.15.0" // optional
    )
    withKtlint(
        ktlintVersion = "0.40.0" // optional
    )
    
    // enable additional kotlin compiler plugins 
    withSpringSupport() // org.jetbrains.kotlin.plugin.spring
    withJpaSupport() // org.jetbrains.kotlin.plugin.jpa
}

Detekt

Detekt can be configured by creating a Detekt config file config/detekt/detekt.yml like the example file or by running the detektGenerateConfig task. For additional information see the Detekt documentation.

KtLint

KtLinkt can be configured using the .editorconfig file like the example file. For additional information see the KtLint Plugin.

Example

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

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

Plugins