Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/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
https://github.com/nebula-plugins/nebula-kotlin-plugin
Last synced: 4 months ago
JSON representation
Provides the Kotlin plugin via the Gradle plugin portal, automatically depends on the standard library, and allows Kotlin library versions to be omitted
- Host: GitHub
- URL: https://github.com/nebula-plugins/nebula-kotlin-plugin
- Owner: nebula-plugins
- License: apache-2.0
- Archived: true
- Created: 2016-05-31T15:50:41.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2021-06-09T01:20:55.000Z (over 3 years ago)
- Last Synced: 2024-04-07T01:13:15.262Z (8 months ago)
- Language: Groovy
- Homepage:
- Size: 778 KB
- Stars: 57
- Watchers: 22
- Forks: 12
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- trackawesomelist - nebula-plugins/nebula-kotlin-plugin (⭐57) - Provides the Kotlin plugin via the Gradle plugin portal, automatically depends on the standard library, and allows Kotlin library versions to be omitted. (Recently Updated / [Oct 28, 2024](/content/2024/10/28/README.md))
README
# Nebula Kotlin Plugin
[](https://plugins.gradle.org/plugin/nebula.kotlin)
[](https://maven-badges.herokuapp.com/maven-central/com.netflix.nebula/nebula-kotlin-plugin)
[](http://www.apache.org/licenses/LICENSE-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:
- Automatically depends on the standard library
- Allows Kotlin library versions to be omitted, inferring them automatically from the plugin version
- For Kotlin 1.1 and later, sets the `-jvm-target` and uses the jre standard library based on the `sourceCompatibility`
- Use the https://github.com/nebula-plugins/gradle-java-cross-compile-plugin to set the `targetJdk` if desired
- Bundles the `kotlin-allopen` and `kotlin-noarg` plugins to allow them to be applied without adding them manually to the classpath
# Quick Start
Refer to the [Gradle Plugin Portal](https://plugins.gradle.org/plugin/nebula.kotlin) for instructions on how to apply the main plugin.
# Basic Build
The plugin simplifies a basic Kotlin build script to:
```groovy
plugins {
id 'nebula.kotlin' version '1.3.70'
}
repositories {
mavenCentral()
}
```
## Additional library
```groovy
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:
```groovy
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
```groovy
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
- IntelliJ doesn't set the `-jvm-target` compiler option based on the Java SDK setting for the project, and can cause the compiler inlining failure if it tries to inline classes compiled with Gradle. Configure the JVM target in IntelliJ preferences to avoid this