JarCastingmill-kotlin - Kotlin compiler support for mill
Documentation for mill-kotlin, a mill plugin to support the Kotlin language and compiler.
Quickstart
Mill version 0.6.0 or newer is required.
// Load the plugin from Maven Central via ivy/coursier
import $ivy.`de.tototec::de.tobiasroeser.mill.kotlin_mill0.9:0.1.1`
import mill._
import mill.scalalib._
import mill.define._
import de.tobiasroeser.mill.kotlin._
object main extends KotlinModule {
// Select the Kotlin version
def kotlinVersion = T{ "1.3.61" }
// Set additional Kotlin compiler options, e.g. the language level and annotation processor
// Run `mill main.kotlincHelp` to get a list of supported options
def kotlincOptions = Seq("-verbose")
}
Configuration
To target the JVM (kotlin-jvm), our module needs to extend de.tobiasroeser.mill.kotlin.KotlinModule which itself extends mill.scalalib.JavaModule.
For convenience, you may derive your unit test projects from de.tobiasroeser.mill.kotlin.KotlinModule.Tests trait.
The module trait de.tobiasroeser.mill.kotlin.KotlinModule has the following configuration options (over those from mill.scalalib.JavaModule).
-
def kotlinVersion: T[String] -
The Kotlin version to be used (for API and Language level settings).
-
def kotlinCompilerVersion: T[String] -
The version of the Kotlin compiler to be used. Default is derived from
kotlinVersion. -
def compile: T[CompilationResult] -
Compiles all the sources to JVM class files.
-
def kotlincOptions: T[Seq[String]] -
Additional Kotlin compiler options to be use by
compile. -
def ivyDeps: T[Agg[Dep]] -
The compile and runtime dependencies.
-
def kotlincHelp(args: String*): Command[Unit] -
Runs the Kotlin compiler with the
-helpargument to show you the built-in cmdline help. You might want to add additional arguments like-Xto see extra help. -
def kotlinCompilerIvyDeps: T[Agg[Dep]] -
The Ivy/Coursier dependencies resembling the Kotlin compiler. Default is derived from
kotlinCompilerVersion. -
def kotlinCompilerClasspath: T[Seq[PathRef]] -
The Java classpath resembling the Kotlin compiler. Default is derived from
kotlinCompilerIvyDeps. -
trait Tests extends TestModule with KotlinTestModule -
A test sub-module linked to its parent module best suited for unit-tests.
Version Compatibility Matrix
Mill is still in active development, and has no stable API yet. Hence, not all mill-kotlin versions work with every mill version.
The following table shows a matrix of compatible mill and mill-kotlin versions.
| mill-kotlin | mill |
|---|---|
0.1.1 |
0.6.0 - 0.9.3 |
0.1.0 |
0.6.0 - 0.8.0 |
0.0.3 |
0.6.0 - 0.6.1 |
0.0.2 |
0.5.7 |
0.0.1 |
0.5.7 |
Toe ensure some basic compatibility, there are some integration tests in place. Newer mill versions may work as well.
If you need support for other versions, please create an issue.
Download
You can download binary releases from Maven Central.
Please make sure to use the correct mill platform suffix matching your used mill version.
| mill version | mill platform | suffix | example |
|---|---|---|---|
0.9.3 - |
0.9 |
|
|
0.7.0 - 0.8.0 |
0.7 |
|
|
0.6.0 - 0.6.3 |
0.6 |
|
|
License
This project is published under the terms of the Apache License, version 2
Supporters
Thanks to iba Consulting Gesellschaft mbH & Co KG for the initial development support.
About
- Mill
-
Mill is a Scala-based open source build tool. In my opinion the best build tool for the JVM. It is fast, reliable and easy to understand.
- Me
-
I am Tobias Roeser a professional software developer who loves to create and use open source tools. I’m actively developing and maintaining mill as well as several mill plugins.
If you like my work, please star it on GitHub. You can also support me via GitHub Sponsors.
- Contributing
-
If you found a bug or have a feature request, please open a new issue on GitHub. I also accept pull requests on GitHub.
Changelog
master
See milstone main and the list of commits
-
Support for mill API 0.9.3
-
Introduced artifact suffix indication the mill platform (e.g.
mill0.9)
mill-kotlin 0.1.1 - 2020-12-01
See milstone 0.1.1 and the list of commits
mill-kotlin 0.1.0 - 2020-06-30
-
Cross publish for Mill APi 0.6 and 0.7, also Scala 2.12 and Scala 2.13.
See milstone 0.1.0 and the list of commits
mill-kotlin 0.0.2 - 2020-02-25
-
Fixed non-functional
kotlincHelptarget
See milstone 0.0.2 and the list of commits