How to pass compiler arguments to Kotlin Compiler with Gradle

Question

I'm compiling a Kotlin library jar with Gradle using the Kotlin gradle plugin:

apply plugin: 'kotlin'

I'm trying to find a way to pass a simple -include-runtime compiler arguments to the kotlin compiler. I can't seem to find any documentation on this at all. I tried mimicking the java plugin, but that didn't seem to work. Here is some documentation about working with the command line compiler, but the gradle documentation doesn't mention anything about passing compiler arguments.

I asked this a few years ago. My need to get this working went away. Looking at the gradle plugin documentation http://kotlinlang.org/docs/reference/using-gradle.html I see that there is a new `freeCompilerArgs` that I might use to pass the necessary arguments. If I couldn't get that working I'd look into building a fat jar or something similar. — spierce7, Nov 16 '17 at 02:38

Miha_x64 · Accepted Answer · 2019-02-01T20:08:34.863

55

You can specify compiler args inside kotlinOptions closure on tasks of KotlinCompile type. For all of them, for instance:

allprojects {
    ...

    tasks.withType(org.jetbrains.kotlin.gradle.tasks.KotlinCompile).all {
        kotlinOptions {
            jvmTarget = '1.6'
            freeCompilerArgs += '-include-runtime'
        }
    }
}

Kotlin docs: using Gradle

edited Feb 01 '19 at 20:08

answered Jun 19 '17 at 09:03

Miha_x64

5,973
1
41
63

Hi, is this added to the project level gradle file or the module level gradle file? – Jeel Shah Nov 15 '17 at 23:21
It would be for the module that you are applying the kotlin plugin too. – spierce7 Nov 16 '17 at 02:38
@deviant, you're right, API is changed. Now `kotlinOptions` are available on `KotlinCompile` tasks, so I've updated my answer. – Miha_x64 Feb 01 '19 at 20:09

Sergey Mashkov · Answer 2 · 2015-08-10T13:18:08.367

2

Try this:

compileKotlin {
    kotlinOptions.includeRuntime = true
}

UPD btw this exact option includeRuntime couldn't work because it is not Gradle way. There are many options to build jar with dependencies in Gradle: Gradle – Create a Jar file with dependencies, Gradle Shadow

edited Aug 10 '15 at 13:18

answered Aug 07 '15 at 12:50

Sergey Mashkov

4,630
1
27
24

You can see it in kotlin's plugin tests for example: https://github.com/JetBrains/kotlin/search?l=gradle&q=compileKotlin&utf8=%E2%9C%93 – Sergey Mashkov Aug 07 '15 at 14:27
@SergeyMashkov This appears not to work for the command `./gradlew clean assemble`. Is there a command that it does work for? On the above comment you left a link to show examples of this being used. I've gone through all the links, and there are no examples of anyone using the code you posted. – spierce7 Aug 07 '15 at 15:42

user3681304 · Answer 3 · 2020-04-29T13:28:38.717

0

If anyone is using the kotlin DSL you can try this too:

import org.jetbrains.kotlin.gradle.tasks.KotlinCompile

val compileKotlin: KotlinCompile by tasks
compileKotlin.kotlinOptions.includeRuntime = true

edited Apr 29 '20 at 13:28

answered Apr 29 '20 at 13:20

user3681304

629
6
23

How to pass compiler arguments to Kotlin Compiler with Gradle

3 Answers3

Linked