nebula-plugins / nebula-kotlin-plugin

Provides the Kotlin plugin via the Gradle plugin portal, automatically depends on the standard library, and allows Kotlin library versions to be omitted
Apache License 2.0
57 stars 12 forks source link

Nebula Kotlin Plugin

Support Status Gradle Plugin Portal Maven Central Build Apache 2.0

This plugin is in maintenance mode but will continue to receive 1.2 and 1.3 Kotlin releases. JetBrains has deprecated the existing jvm plugin and replaced it with the multiplatform plugin. If you use 1.3.70 or later you'll receive the warning:

The 'org.jetbrains.kotlin.platform.*' plugins are deprecated and will no longer be available in Kotlin 1.4.
Please migrate the project to the 'org.jetbrains.kotlin.multiplatform' plugin. 
See: https://kotlinlang.org/docs/reference/building-mpp-with-gradle.html

The multiplatform plugin is a complete migration from the legacy plugin and provides many of the ergonomic features, such as JVM target configuration and Kotlin library version management that this plugin provided. If you have a project that will move to 1.4 once it's released you should migrate to multiplatform.

Features

Provides the Kotlin plugin via the Gradle plugin portal, and adds ergonomic improvements over the default plugin:

Quick Start

Refer to the Gradle Plugin Portal for instructions on how to apply the main plugin.

Basic Build

The plugin simplifies a basic Kotlin build script to:

plugins {
    id 'nebula.kotlin' version '1.3.70'
}

repositories {
    mavenCentral() 
}

Additional library

plugins {
    id 'nebula.kotlin' version '1.3.70'
}

repositories {
    mavenCentral() 
}

dependencies {
    implementation 'org.jetbrains.kotlin:kotlin-reflect'
}

Default configuration ( >= 1.3.70)

There are cases were we only want to use kotlin for specific configurations and applying the plugin added stdlib to implementation by default.

Starting on 1.3.70, it is possible to set the default configurations for stdlib via stdlibConfiguration. For example:

plugins {
    id 'nebula.kotlin' version '1.3.70'
}

repositories {
    mavenCentral()
}

dependencies {
    implementation 'org.jetbrains.kotlin:kotlin-reflect'
}

configurations {
   myConfig
}

nebulaKotlin {
     stdlibConfigurations = ["myConfig"]
}

If you use kotlin buildscripts:

nebulaKotlin {
  stdlibConfigurations.set(listOf("implementation", "testFixturesImplementation"))
}

Nodep plugin ( >= 1.3.70)

This plugin will apply our opinions for default version of additional dependencies but won't add stdlib by default

plugins {
    id 'nebula.kotlin-nodep' version '1.3.70'
}

The version for kotlin-reflect will be automatically set to match the Kotlin version (1.3.70).

Caveats