The Kotlin Programming Language
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.idea JPS Build, update artifacts: fix js stdlib, remove stdlib-jdk7 and 8 Feb 19, 2019
android-studio Prepare building plugins modules against 1.8 JDK Apr 4, 2016
annotations Remove KotlinSignature annotations from project code Oct 13, 2015
ant Build: implement useBootstrapStdlib flag Jan 21, 2019
build-common JS: (review fix) Header -> InlineData Feb 14, 2019
buildSrc Build: Fix internal api usage in DistModelBuilder Feb 19, 2019
compiler IR: declaration builders, initial iteration, use in some JVM lowerings Feb 21, 2019
core JVM IR: generate synthetic $annotations methods for properties Feb 19, 2019
custom-dependencies Build: Convert protobuf to includable build with maven publication Jan 17, 2019
docs Extract contributing guide for better GitHub integration Dec 21, 2018
eval4j Build: implement useBootstrapStdlib flag Jan 21, 2019
generators 191: Update Android plugin changes to AS33 (KT-29847) Feb 13, 2019
gradle Build: Update gradle version to 5.1 Feb 19, 2019
idea-runner CIDR: New way of building CLion and AppCode plugins Feb 14, 2019
idea Return app name of the main folder Feb 21, 2019
include Build: Fix Kotlin/Native composite build Feb 20, 2019
j2k Enable debug log for PerModulePackageService only in J2K Feb 18, 2019
jps-plugin Use https everywhere - documentation and samples Feb 19, 2019
js Publish npm artifacts over encrypted connection Feb 20, 2019
konan CIDR: Patch LLDB pretty printers for K/N < 1.1.1 Feb 19, 2019
libraries Change short form of flag name to full one for cinterop tool (#2117) Feb 20, 2019
license Add a credit for Guava implementation of unsigned division and remainder Aug 30, 2018
plugins Get platform for scripts from script definition Feb 20, 2019
prepare FIR: add symbol provider for IDE #KT-24097 Fixed Feb 19, 2019
resources Inline some properties from kotlinManifest.properties that were used … May 5, 2017
spec-docs Fix typos in spec-docs Dec 21, 2018
test-instrumenter Build: implement useBootstrapStdlib flag Jan 21, 2019
third-party KT-29586: Add android.annotation annotations Jan 31, 2019
ultimate Build: Drop obsolete dependency handlers Feb 18, 2019
.bunch CIDR: New way of building CLion and AppCode plugins Feb 14, 2019
.gitattributes Exclude generated test classes from language statistics Jan 3, 2018
.gitignore Build: fix PILL for JPS build. Jan 28, 2019
CODE_OF_CONDUCT.md Code of Conduct for Kotlin project Feb 19, 2019
ChangeLog.md Fix changelog for 1.3.21 Feb 6, 2019
ReadMe.md Use https everywhere - documentation and samples Feb 19, 2019
build.gradle.kts Build: Use javadocJar helper to specify artifact explicitly Feb 18, 2019
gradle.properties CIDR: New way of building CLion and AppCode plugins Feb 14, 2019
gradle.properties.as32 Build: got rid of useBootstrapStdlib flag (replaced with jpsBuild flag) Jan 28, 2019
gradle.properties.as33 Build: got rid of useBootstrapStdlib flag (replaced with jpsBuild flag) Jan 28, 2019
gradle.properties.as34 Build: got rid of useBootstrapStdlib flag (replaced with jpsBuild flag) Jan 28, 2019
gradlew Use Gradle 4.3 Nov 1, 2017
gradlew.bat add Gradle wrapper to project Nov 15, 2016
settings.gradle Drop obsolete artifact kotlin-runtime Feb 18, 2019
upload_plugins.gradle typo Jun 12, 2017

ReadMe.md

official project TeamCity (simple build status) Maven Central GitHub license

Kotlin Programming Language

Welcome to Kotlin! Some handy links:

Editing Kotlin

Build environment requirements

In order to build Kotlin distribution you need to have:

  • JDK 1.6, 1.7, 1.8 and 9

  • Setup environment variables as following:

      JAVA_HOME="path to JDK 1.8"
      JDK_16="path to JDK 1.6"
      JDK_17="path to JDK 1.7"
      JDK_18="path to JDK 1.8"
      JDK_9="path to JDK 9"
    

For local development, if you're not working on bytecode generation or the standard library, it's OK to have only JDK 1.8 and JDK 9 installed, and to point JDK_16 and JDK_17 environment variables to your JDK 1.8 installation.

You also can use Gradle properties to setup JDK_* variables.

Note: The JDK 6 for MacOS is not available on Oracle's site. You can download it here.

Building

The project is built with Gradle. Run Gradle to build the project and to run the tests using 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 connection you might face timeouts getting them. In this case you can increase timeout by specifying the following command line parameters on the first run:

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

Important gradle tasks

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

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

Building for different versions of IntelliJ IDEA and Android Studio

Kotlin plugin is intended to work with several recent versions of IntelliJ IDEA and Android Studio. Each platform is allowed to have a different set of features and might provide a slightly different API. Instead of using several parallel Git branches, project stores everything in a single branch, but files may have counterparts with version extensions (*.as32, *.172, *.181). The primary file is expected to be replaced with its counterpart when targeting non-default platform.

More detailed description of this scheme can be found at https://github.com/JetBrains/bunches/blob/master/ReadMe.md.

Usually, there's no need to care about multiple platforms as all features are enabled everywhere by default. Additional counterparts should be created if there's an expected difference in behavior or an incompatible API usage is required and there's no reasonable workaround to save source compatibility. Kotlin plugin contains a pre-commit check that shows a warning if a file has been updated without its counterparts.

Development for some particular platform is possible after 'switching' that can be done with Bunch Tool from the command line.

cd kotlin-project-dir

# switching to IntelliJ Idea 2018.2
bunch switch . 182

Working with the project in IntelliJ IDEA

Working with the Kotlin project requires at least IntelliJ IDEA 2017.3. You can download IntelliJ IDEA 2017.3 here.

After cloning the project, to import the project in Intellij choose the project directory in the Open project dialog. Then, after project opened, Select File -> New... -> Module from Existing Sources in the menu, and select build.gradle.kts file in the project's root folder.

In the import dialog, select use default gradle wrapper.

To be able to run tests from IntelliJ easily, check Delegate IDE build/run actions to Gradle and choose Gradle Test Runner in the Gradle runner settings after importing the project.

At this time, you can use the latest released 1.2.x version of the Kotlin plugin for working with the code. To make sure you have the latest version installed, use Tools | Kotlin | Configure Kotlin Plugin Updates and press "Check for updates now".

Compiling and running

From this root project there are Run/Debug Configurations for running IDEA or the Compiler Tests for example; so if you want to try out the latest and greatest IDEA plugin

  • VCS -> Git -> Pull
  • Run the "IDEA" run configuration in the project
  • a child IntelliJ IDEA with the Kotlin plugin will then startup

Including into composite build

To include kotlin compiler into composite build you need to define dependencySubstitution for kotlin-compiler module in settings.gradle

includeBuild('/path/to/kotlin') {
    dependencySubstitution {
        substitute module('org.jetbrains.kotlin:kotlin-compiler') with project(':include:kotlin-compiler')
    }
}

Contributing

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