Repository files navigation

Welcome toKotlin!
Kotlin is a concise multiplatform language developed byJetBrains andcontributors.

Some handy links:

• Kotlin Site
• Getting Started Guide
• Try Kotlin
• Kotlin Standard Library
• Issue Tracker
• Kotlin YouTube Channel
• Forum
• Kotlin Blog
• Subscribe to Kotlin YouTube channel
• Follow Kotlin on Twitter
• Public Slack channel
• TeamCity CI build
• Kotlin Foundation

Support for multiplatform programming is one of Kotlin’s key benefits. It reduces time spent writing and maintaining the same code fordifferent platforms while retaining the flexibility and benefits of native programming.

• Kotlin Multiplatform andCompose Multiplatform for sharing business logic and UI between Android, iOS, desktop, and web.
• Get started with Kotlin Multiplatform
• Kotlin Multiplatform Benefits
• Share code on all platforms
• Share code on similar platforms

• Kotlin IntelliJ IDEA Plugin (source code)
• Kotlin Eclipse Plugin
• Kotlin Sublime Text Package

This repository is usingGradle toolchains featureto select and auto-provision required JDKs fromAdoptOpenJdk project.

Alternatively, it is still possible to only provide required JDKs via environment variables(seegradle.properties for supported variable names). To ensure Gradle uses only JDKsfrom environmental variables - disable Gradle toolchain auto-detection by passing-Porg.gradle.java.installations.auto-detect=false option(or put it into$GRADLE_USER_HOME/gradle.properties).

On Windows you might need to add long paths setting to the repo:

git config core.longpaths true

The project is built with Gradle. Run Gradle to build the project and to run the testsusing the following command on Unix/macOS:

./gradlew <tasks-and-options>

or the following command on Windows:

gradlew <tasks-and-options>

On the first project configuration gradle will download and setup the dependencies on:

• intellij-core is a part of command line compiler and contains only necessary APIs.
• idea-full is a full blown IntelliJ IDEA Community Edition to be used in the plugin module.

These dependencies are quite large, so depending on the quality of your internet connectionyou might face timeouts getting them. In this case, you can increase timeout by specifying the followingcommand line parameters on the first run:

./gradlew -Dhttp.socketTimeout=60000 -Dhttp.connectionTimeout=60000

• clean - clean build results
• dist - assembles the compiler distribution intodist/kotlinc/ folder
• install - build and install all public artifacts into local maven repository
• coreLibsTest - build and run stdlib, reflect and kotlin-test tests
• gradlePluginTest - build and run gradle plugin tests
• compilerTest - build and run all compiler tests

To reproduce TeamCity build use-Pteamcity=true flag. Local builds don't run proguard and have jar compression disabled by default.

OPTIONAL: Some artifacts, mainly Maven plugin ones, are built separately with Maven.Refer tolibraries/ReadMe.md for details.

To build Kotlin/Native, seekotlin-native/README.md.

It is recommended to use the latest released version of Intellij IDEA (Community or Ultimate Edition). You can download IntelliJ IDEAhere.

After cloning the project, import the project in IntelliJ by choosing the project directory in the Open project dialog.

For handy work with compiler tests it's recommended to useKotlin Compiler Test Helper.

We have adependencies verification feature enabled in therepository for all Gradle builds. Gradle will check hashes (md5 and sha256) of used dependencies and will fail builds withDependency verification failed errors when local artifacts are absent or have different hashes listed in theverification-metadata.xml file.

It's expected thatverification-metadata.xml should only be updated with the commits that modify the build. There are some tips howto perform such updates:

• Deletecomponents section ofverification-metadata.xml to avoid stockpiling of old unused dependencies. You may use the following command:

#macOSsed -i'' -e'/<components>/,/<\/components>/d' gradle/verification-metadata.xml#Linux & Git for Windowssed -i -e'/<components>/,/<\/components>/d' gradle/verification-metadata.xml

• Re-generate dependencies with Gradle's--write-verification-metadata command (verify update relates to your changes)

./gradlew --write-verification-metadata sha256,md5 -Pkotlin.native.enabled=true resolveDependencies

resolveDependencies task resolves dependencies for all platforms including dependencies downloaded by plugins.

You can also use./scripts/update-verification-metadata.sh script which includes both of these steps

Keep in mind:

• If you’re adding a dependency with OS mentioned in an artifact name (darwin,mac,osx,linux,windows), remember to add them toimplicitDependencies configuration or updateresolveDependencies task if needed.resolveDependencies should resolve all dependenciesincluding dependencies for different platforms.
• If you have alocal.properties file in your Kotlin project folder, make sure that it doesn't containkotlin.native.enabled=false.Otherwise, native-only dependencies may not be added to the verification metadata. This is becauselocal.properties has higherprecedence than the-Pkotlin.native.enabled=true specified in the Gradle command.

We publish-dev versions frequently.

For-dev versions you can use thelist of available versions and include this maven repository:

maven("https://redirector.kotlinlang.org/maven/bootstrap")

Kotlin is distributed under the terms of the Apache License (Version 2.0). Seelicense folder for details.

Please be sure to review Kotlin'scontributing guidelines to learn how to help the project.

The Kotlin Foundation is a non-profit organization whose mission is to promote and advance the Kotlin ecosystem. You can learn more about the structure and goals of the Kotlin Foundation on itsofficial website.