Kotlin for Plugin Developers

1. Why Kotlin?

Using Kotlin to write plugins for the IntelliJ Platform is very similar to writing plugins in Java. Existing plugin developers can get started by converting boilerplate Java classes to their Kotlin equivalents by using the J2K compiler bundled with the IntelliJ Platform (versions 143.+), and developers can easily mix and match Kotlin classes with their existing Java code.

In addition to null safety and type-safe builders, the Kotlin language offers a number of convenient features for plugin development, which make plugins easier to read and simpler to maintain. Much like Kotlin for Android, the IntelliJ Platform makes extensive use of callbacks, which are easy to express as lambdas in Kotlin.

Likewise, it is easy to customize the behavior of internal classes in IntelliJ IDEA, with extensions. For example, it is common practice to guard logging statements to avoid the cost of parameter construction, leading to the following ceremony when using the log:

if(logger.isDebugEnabled()) {
  logger.debug("...");
}

We can achieve the same result more succinctly in Kotlin, by declaring the following extension method:

inline fun Logger.debug(lazyMessage: () -> String) {
  if (isDebugEnabled) {
    debug(lazyMessage())
  }
}

Now we can directly write logger.debug { "..." } to receive all the benefits of lightweight logging, with none of the verbosity. With practice, you will be able to recognize many idioms in the IntelliJ Platform that can be simplified with Kotlin. To learn more about building IntelliJ Platform plugins with Kotlin, this tutorial will help you get started.

2. Adding Kotlin Support

Plugins targeting the IntelliJ Platform versions 143 and above are easy to migrate: just start writing Kotlin. The necessary Kotlin plugins and libraries are already bundled with the IDE, requiring no further configuration. For version 142 or below, you will need to install and configure dependencies to the Kotlin runtime (in addition to installing the Kotlin plugin itself, for code assistance and tooling support). For detailed instructions, please refer to the Kotlin documentation.

3. Kotlin Gradle Plugin

For plugins already using the Gradle Build System, or those that require precise control over the Kotlin build process, we recommend using the kotlin-gradle-plugin. This Gradle plugin greatly simplifies building Kotlin projects in a controlled and reproducible manner.

Your build.gradle file may look like so:

buildscript {
    repositories {
        mavenCentral()
    }
    dependencies {
        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
    }
}

apply plugin: 'org.jetbrains.intellij'
apply plugin: 'kotlin'

intellij {
    version 'LATEST-TRUNK-SNAPSHOT'
    pluginName 'Example'
}

group 'com.example'
version '0.0.1'

repositories {
    mavenCentral()
}

Please note that you should not include kotlin-runtime and kotlin-stdlib jars with your plugin because Kotlin guarantees backward- and forward- binary compatibility.

3.1. Use Kotlin to write Gradle script

Starting with 4.4, Gradle supports build.gradle.kts, an alternative to build.gradle written in Kotlin.

There’re many good resources for learning how to write build scripts for an IntelliJ plugin with Kotlin script, like intellij-rust, julia-intellij, covscript-intellij or zig-intellij.

build.gradle.kts basically looks like:

group = "com.your.company.name"
version = "0.1-SNAPSHOT"

buildscript {
    repositories { mavenCentral() }
    dependencies { classpath(kotlin("gradle-plugin", "1.2.30")) }
}

plugins {
	id("org.jetbrains.intellij") version "0.4.5"
	kotlin("jvm") version "1.2.30"
}

intellij {
    updateSinceUntilBuild = false
    instrumentCode = true
    version = "2017.3"
}

4. UI in Kotlin

The best way to create user interfaces with Kotlin is to use a type safe DSL for building forms instead of GUI designer. The DSL used in the IntelliJ platform is inside com.intellij.ui.layout package. Documentation.

5. Handling Kotlin code

If you need to write a plugin that processes Kotlin code, you need to add a dependency on the Kotlin plugin. Please refer to Plugin Dependencies for information on how to do that.

6. Examples

There are a number of open source Kotlin projects built on the IntelliJ Platform. For a readily available source of up to date examples and applications of the Kotlin language for building developer tools with the IntelliJ Platform, developers may look to these projects for inspiration:

Last modified: 15 April 2019