KBinding - Android MVVM framework write in kotlin.
TornadoFX - Lightweight JavaFX Framework for Kotlin
KotlinPreferencesObject - Kotlin Android Library, that makes preference usage in Kotlin simple and fun, using single object with fields binded to SharedPreferences.
Kotter Knife - View "injection" library for Android.
Koi - A lightweight kotlin library for Android, including many useful extensions, async functions and quick adapter.
KAndroid - Kotlin library for Android providing useful extensions to eliminate boilerplate code
KAConf - KickAss Configuration. An annotation-based configuration system for Java and Kotlin
Stateful - Stateful helps you delete all the boilerplate code for saving instance state and lets you forget about saving and restoring your fragment's/activity's state.
Fuel - The easiest HTTP networking library for Kotlin/Android.
funKTionale - Functional constructs and patterns for Kotlin
Kotson - Gson for Kotlin, Kotson enables you to parse and write JSON with Google's Gson using a conciser and easier syntax.
kotlin-compile-testing - A library for testing Kotlin and Java annotation processors, compiler plugins and code generation
koin - A pragmatic lightweight dependency injection framework for Kotlin developers. Written in pure Kotlin, using functional resolution only: no proxy, no code generation, no reflection.
Kotlin for Android Developers - This book is not meant to be a language reference, but a tool for Android developers to learn Kotlin and be able to continue with their own projects by themselves.
Kotlin in Action (MEAP) - Kotlin in Action takes experienced Java developers from the language basics all the way through building applications to run on the JVM and Android devices.
Programming Kotlin - Programming Kotlin is aimed at Java developers who want to make the transition to Kotlin. It covers the complete Kotlin language from basic sytax through to concurrency and testing.
Fundamental Kotlin - Fundamental Kotlin is a book focused on Kotlin programming language and its comparison to Java.
Effective Kotlin - Effective Kotlin summarizes the best practices and experiences of the Kotlin community, together with a deep explanation of some lesser-known Kotlin functionalities. All of the best practices are presented as simple rules with detailed explanations.
Kotlin Blueprints - a practical guide to help build industry grade web applications (Spring Boot, JavaScript, Node.js), Android, Desktop application using TornadoFX. It also includes building an application with Kotlin Native. It shows how to leverage features of Kotlin in the respective technologies. This book is for developers who already know Kotlin and want to build something using Kotlin for Web/Android/Desktop/Native
Tools
sonarlint-intellij - An IDE extension that helps you detect and fix quality issues as you write code.
IntelliJ IDEA 15 - The best Kotlin IDE, support Java, Groovy, Scala and Android development.
dokka - Dokka is a documentation engine for Kotlin, performing the same function as javadoc for Java.
kotlin-vim - Kotlin plugin for Vim. Featuring syntax highlighting and basic indentation
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.
Note: The JDK 6 for MacOS is not available on Oracle's site. You can download it here.
On Windows you might need to add long paths setting to the repo:
git config core.longpaths true
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
or the following command on Windows:
gradlew
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:
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.
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 2019.1
bunch switch 191
Working with the project in IntelliJ IDEA
Working with the Kotlin project requires at least IntelliJ IDEA 2019.1. You can download IntelliJ IDEA 2019.1 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.3.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')
}
}
