How to configure Kotlin in your project

Natalia Ukhorskaya

Kotlin can be freely mixed with Java. That means that you can easily add Kotlin code to an existing Java project. All you need to do is create a new Kotlin file (*.kt) and tell the environment to use Kotlin. If you’re using IntelliJ IDEA, it can do this for you automatically.

The Kotlin plugin checks that all your modules containing Kotlin files are configured correctly. If they’re not, you will see the following notification in the upper left corner of the editor:

To configure them, click one of the links in the notification, based on what you need.

Targeting JVM Byte Code

If you want to compile Kotlin to JVM byte code, click on as Kotlin (Java) module. You’ll be prompted with the following dialog:

Here  you can choose which modules need to be configured and a destination path to copy the library to.

You can either choose to copy the JAR library and store it under your project folder (optionally checking it in to VCS) or select Use library from plugin which will merely use the JAR bundled with the plugin in IntelliJ IDEA. However, the latter option means that your project will only work on machines where this plugin is installed.

Targeting JavaScript

If you want to compile Kotlin to JavaScript, click as Kotlin (JavaScript) module link in the notification.

Similar to above, you can then specify where you want the runtime files stored.

There are two paths: the first points  to the Kotlin Runtime files, which are a JavaScript implementation of Kotlin library. The second path is a points to the headers of the Kotlin library.

Using Maven or Gradle

If you use Maven or Gradle we have also great news: the Kotlin plugin now can configure your project using pom.xml or *.gradle files.

Once again, you need click the link in the notification, choose the modules to configure and the version of the Kotlin plugin (latest stable version or snapshot).

Configuration files for selected modules will be changed as described here.

If by chance you miss a notification, you can always access it via the Event Log in IntelliJ IDEA.
Also please note that the notification will appear only if you have Kotlin files under source root in your project.

For Gradle Users: Your Kotlin files should be under a source root named ‘kotlin’

Subscribe to Kotlin Blog updates

Subscribe form

By submitting this form, I agree to the JetBrains Privacy Policy Notification icon

By submitting this form, I agree that JetBrains s.r.o. ("JetBrains") may use my name, email address, and location data to send me newsletters, including commercial communications, and to process my personal data for this purpose. I agree that JetBrains may process said data using third-party services for this purpose in accordance with the JetBrains Privacy Policy. I understand that I can revoke this consent at any time in my profile. In addition, an unsubscribe link is included in each email.

Submit

Thanks, we've got you!