From ce1b2be371bdb7283d1601f7ddec35a580206359 Mon Sep 17 00:00:00 2001 From: Nikita Klimenko Date: Fri, 24 Jul 2026 14:22:12 +0300 Subject: [PATCH 1/2] Remove redundant configuration from SetupAndroid.md dataframe doesn't really impose any additional requirements. It looks like leftovers from time when we had extra configuration --- .../StardustDocs/topics/setup/SetupAndroid.md | 34 ------------------- 1 file changed, 34 deletions(-) diff --git a/docs/StardustDocs/topics/setup/SetupAndroid.md b/docs/StardustDocs/topics/setup/SetupAndroid.md index 588b69f42a..8453dcf569 100644 --- a/docs/StardustDocs/topics/setup/SetupAndroid.md +++ b/docs/StardustDocs/topics/setup/SetupAndroid.md @@ -31,23 +31,6 @@ dependencies { // You can add any additional IO modules you like, except for 'dataframe-arrow'. // Apache Arrow is not supported well on Android. } - -android { - defaultConfig { - minSdk = 21 - } - // Requires Java 8 or higher - compileOptions { - sourceCompatibility = JavaVersion.VERSION_1_8 - targetCompatibility = JavaVersion.VERSION_1_8 - } - kotlinOptions { - jvmTarget = "1.8" - } -} -tasks.withType { - kotlinOptions.jvmTarget = "1.8" -} ``` @@ -65,23 +48,6 @@ dependencies { // You can add any additional IO modules you like, except for 'dataframe-arrow'. // Apache Arrow is not supported well on Android. } - -android { - defaultConfig { - minSdk 21 - } - // Requires Java 8 or higher - compileOptions { - sourceCompatibility JavaVersion.VERSION_1_8 - targetCompatibility JavaVersion.VERSION_1_8 - } - kotlinOptions { - jvmTarget = "1.8" - } -} -tasks.withType(org.jetbrains.kotlin.gradle.tasks.KotlinCompile).configureEach { - kotlinOptions.jvmTarget = "1.8" -} ``` From 2778e79593475b93d35edebe36cbc8dcd8a0b348 Mon Sep 17 00:00:00 2001 From: Nikita Klimenko Date: Fri, 24 Jul 2026 14:27:36 +0300 Subject: [PATCH 2/2] Update setup instructions --- docs/StardustDocs/topics/Compiler-Plugin.md | 4 +- .../StardustDocs/topics/setup/SetupAndroid.md | 86 +++++++++---------- docs/StardustDocs/topics/setup/SetupGradle.md | 82 ++++++++---------- docs/StardustDocs/topics/setup/SetupMaven.md | 73 ++++++++-------- 4 files changed, 120 insertions(+), 125 deletions(-) diff --git a/docs/StardustDocs/topics/Compiler-Plugin.md b/docs/StardustDocs/topics/Compiler-Plugin.md index 2e002ba4be..b28da63a26 100644 --- a/docs/StardustDocs/topics/Compiler-Plugin.md +++ b/docs/StardustDocs/topics/Compiler-Plugin.md @@ -73,7 +73,7 @@ Sync the project. This is not needed anymore from Kotlin 2.4.0+. The DataFrame compiler plugin can be used in Maven projects starting from IntelliJ IDEA 2025.3, available now as EAP builds -Setup plugin in pom.xml: +Update the `` in the `` section of your `pom.xml`:: ```xml @@ -82,11 +82,13 @@ Setup plugin in pom.xml: %compilerPluginKotlinVersion% + kotlin-dataframe + org.jetbrains.kotlin diff --git a/docs/StardustDocs/topics/setup/SetupAndroid.md b/docs/StardustDocs/topics/setup/SetupAndroid.md index 8453dcf569..78049ba3c0 100644 --- a/docs/StardustDocs/topics/setup/SetupAndroid.md +++ b/docs/StardustDocs/topics/setup/SetupAndroid.md @@ -14,22 +14,24 @@ How to use Kotlin DataFrame in your Android project with Gradle setup and compil > See an [Android project example](https://github.com/Kotlin/dataframe/tree/master/examples/projects/android-example). -Kotlin DataFrame doesn't provide a dedicated Android artifact yet, -but you can add the Kotlin DataFrame JVM dependency to your Android project with minimal configuration: + +### 1. Add the plugin + +[Kotlin DataFrame Compiler Plugin](Compiler-Plugin.md) enables automatic generation +of [extension properties](extensionPropertiesApi.md) and updates [data schemas](schemas.md) +on-the-fly in Android projects, making development with Kotlin DataFrame +faster, more convenient, and fully type- and name-safe. + +> Requires Kotlin 2.2.20-Beta1 or higher. + +To enable the plugin in your Gradle project, add it to the `plugins` section: ```kotlin -dependencies { - // Core Kotlin DataFrame API, CSV and JSON IO. - // See custom Gradle setup: - // https://kotlin.github.io/dataframe/setupcustomgradle.html - implementation("org.jetbrains.kotlinx:dataframe-core:%dataFrameVersion%") - implementation("org.jetbrains.kotlinx:dataframe-json:%dataFrameVersion%") - implementation("org.jetbrains.kotlinx:dataframe-csv:%dataFrameVersion%") - // You can add any additional IO modules you like, except for 'dataframe-arrow'. - // Apache Arrow is not supported well on Android. +plugins { + kotlin("plugin.dataframe") version "%compilerPluginKotlinVersion%" } ``` @@ -38,44 +40,38 @@ dependencies { ```groovy -dependencies { - // Core Kotlin DataFrame API, CSV and JSON IO. - // See custom Gradle setup: - // https://kotlin.github.io/dataframe/setupcustomgradle.html - implementation 'org.jetbrains.kotlinx:dataframe-core:%dataFrameVersion%' - implementation 'org.jetbrains.kotlinx:dataframe-json:%dataFrameVersion%' - implementation 'org.jetbrains.kotlinx:dataframe-csv:%dataFrameVersion%' - // You can add any additional IO modules you like, except for 'dataframe-arrow'. - // Apache Arrow is not supported well on Android. +plugins { + id 'org.jetbrains.kotlin.plugin.dataframe' version '%compilerPluginKotlinVersion%' } ``` -This setup adds the [Kotlin DataFrame core](Modules.md#dataframe-core) -as well as a subset of the [IO modules](Modules.md#io-modules) -(excluding [experimental ones](Modules.md#experimental-modules)). -For flexible configuration, see [Custom configuration](SetupCustomGradle.md). - -## Kotlin DataFrame Compiler Plugin +In versions older than Kotlin 2.4.0 add following line to your `gradle.properties`: -[Kotlin DataFrame Compiler Plugin](Compiler-Plugin.md) enables automatic generation -of [extension properties](extensionPropertiesApi.md) and updates [data schemas](schemas.md) -on-the-fly in Android projects, making development with Kotlin DataFrame -faster, more convenient, and fully type- and name-safe. +```properties +kotlin.incremental=false +``` -> Requires Kotlin 2.2.20-Beta1 or higher. -> { style = "note" } +### 2. Add the library -To enable the plugin in your Gradle project, add it to the `plugins` section: +Kotlin DataFrame doesn't provide a dedicated Android artifact yet, +but you can add the Kotlin DataFrame JVM dependency to your Android project with minimal configuration: ```kotlin -plugins { - kotlin("plugin.dataframe") version "%compilerPluginKotlinVersion%" +dependencies { + // Core Kotlin DataFrame API, CSV and JSON IO. + // See custom Gradle setup: + // https://kotlin.github.io/dataframe/setupcustomgradle.html + implementation("org.jetbrains.kotlinx:dataframe-core:%dataFrameVersion%") + implementation("org.jetbrains.kotlinx:dataframe-json:%dataFrameVersion%") + implementation("org.jetbrains.kotlinx:dataframe-csv:%dataFrameVersion%") + // You can add any additional IO modules you like, except for 'dataframe-arrow'. + // Apache Arrow is not well supported on Android. } ``` @@ -84,23 +80,21 @@ plugins { ```groovy -plugins { - id 'org.jetbrains.kotlin.plugin.dataframe' version '%compilerPluginKotlinVersion%' +dependencies { + // Core Kotlin DataFrame API, CSV and JSON IO. + // See custom Gradle setup: + // https://kotlin.github.io/dataframe/setupcustomgradle.html + implementation 'org.jetbrains.kotlinx:dataframe-core:%dataFrameVersion%' + implementation 'org.jetbrains.kotlinx:dataframe-json:%dataFrameVersion%' + implementation 'org.jetbrains.kotlinx:dataframe-csv:%dataFrameVersion%' + // You can add any additional IO modules you like, except for 'dataframe-arrow'. + // Apache Arrow is not supported well on Android. } ``` -If you're using a version older than Kotlin 2.4.0, -incremental compilation must be disabled due to [this issue](https://youtrack.jetbrains.com/issue/KT-66735), - -Add the following line to your `gradle.properties` file: - -```properties -kotlin.incremental=false -``` - ## Next Steps * Once Kotlin DataFrame is set up in your Android project, continue with the [](quickstart.md) diff --git a/docs/StardustDocs/topics/setup/SetupGradle.md b/docs/StardustDocs/topics/setup/SetupGradle.md index 9808c11052..a30e962e4b 100644 --- a/docs/StardustDocs/topics/setup/SetupGradle.md +++ b/docs/StardustDocs/topics/setup/SetupGradle.md @@ -38,8 +38,45 @@ that you want to use in your project. The minimum supported version is JDK 8. You have successfully created a project with Gradle. -## Add Kotlin DataFrame Gradle dependency +## Setup Kotlin DataFrame +### 1. Add the plugin +[Kotlin DataFrame Compiler Plugin](Compiler-Plugin.md) enables automatic generation of +[extension properties](extensionPropertiesApi.md) and updates [data schemas](schemas.md) +on-the-fly in Gradle projects, making development with Kotlin DataFrame faster, +more convenient, and fully type- and name-safe. + +> Requires Kotlin 2.2.20-Beta1 or higher + +To enable the plugin in your Gradle project, add it to the `plugins` section: + + + + +```kotlin +plugins { + kotlin("plugin.dataframe") version "%compilerPluginKotlinVersion%" +} +``` + + + +```groovy +plugins { + id 'org.jetbrains.kotlin.plugin.dataframe' version '%compilerPluginKotlinVersion%' +} +``` + + + + +In versions older than Kotlin 2.4.0 add following line to your `gradle.properties`: + +```properties +kotlin.incremental=false +``` + +### 2. Add the library dependency In your Gradle build file (`build.gradle` or `build.gradle.kts`), add the Kotlin DataFrame library as a dependency: @@ -87,49 +124,6 @@ fun main() { } ``` -## Kotlin DataFrame Compiler Plugin - -[Kotlin DataFrame Compiler Plugin](Compiler-Plugin.md) enables automatic generation of -[extension properties](extensionPropertiesApi.md) and updates [data schemas](schemas.md) -on-the-fly in Gradle projects, making development with Kotlin DataFrame faster, -more convenient, and fully type- and name-safe. - -> Requires Kotlin 2.2.20-Beta1 or higher. -> { style = "note" } - -To enable the plugin in your Gradle project, add it to the `plugins` section: - - - - -```kotlin -plugins { - kotlin("plugin.dataframe") version "%compilerPluginKotlinVersion%" -} -``` - - - - - -```groovy -plugins { - id 'org.jetbrains.kotlin.plugin.dataframe' version '%compilerPluginKotlinVersion%' -} -``` - - - - -If you're using a version older than Kotlin 2.4.0, -incremental compilation must be disabled due to [this issue](https://youtrack.jetbrains.com/issue/KT-66735), - -Add the following line to your `gradle.properties` file: - -```properties -kotlin.incremental=false -``` - ## Project Example See [the Gradle example project with the Kotlin DataFrame Compiler Plugin enabled on GitHub](https://github.com/Kotlin/dataframe/tree/master/examples/projects/kotlin-dataframe-plugin-gradle-example). diff --git a/docs/StardustDocs/topics/setup/SetupMaven.md b/docs/StardustDocs/topics/setup/SetupMaven.md index 30f970ffff..024c3acf99 100644 --- a/docs/StardustDocs/topics/setup/SetupMaven.md +++ b/docs/StardustDocs/topics/setup/SetupMaven.md @@ -36,7 +36,45 @@ that you want to use in your project. The minimum supported version is JDK 8. You have successfully created a project with Maven. -## Add Kotlin DataFrame Maven dependency +## Setup Kotlin DataFrame + +### 1. Add the plugin + +[Kotlin DataFrame Compiler Plugin](Compiler-Plugin.md) enables automatic generation of +[extension properties](extensionPropertiesApi.md) and updates [data schemas](schemas.md) +on-the-fly in Maven projects, making development with Kotlin DataFrame faster, +more convenient, and fully type- and name-safe. + +> Requires Kotlin 2.2.20-Beta1 or higher and IntelliJ IDEA 2025.3 or higher. +> { style = "note" } + +To enable the plugin in your Maven project, update the `` in the `` section of your `pom.xml`: + +```xml + + kotlin-maven-plugin + org.jetbrains.kotlin + %compilerPluginKotlinVersion% + + + + + kotlin-dataframe + + + + + + + org.jetbrains.kotlin + kotlin-maven-dataframe + %compilerPluginKotlinVersion% + + + +``` + +### 2. Add the library dependency In your Maven build file (`pom.xml`), add the Kotlin DataFrame library as a dependency: @@ -73,39 +111,6 @@ fun main() { } ``` -## Kotlin DataFrame Compiler Plugin - -[Kotlin DataFrame Compiler Plugin](Compiler-Plugin.md) enables automatic generation of -[extension properties](extensionPropertiesApi.md) and updates [data schemas](schemas.md) -on-the-fly in Maven projects, making development with Kotlin DataFrame faster, -more convenient, and fully type- and name-safe. - -> Requires Kotlin 2.2.20-Beta1 or higher and IntelliJ IDEA 2025.3 or higher. -> { style = "note" } - -To enable the plugin in your Maven project, add it to the `plugins` section: - -```xml - - kotlin-maven-plugin - org.jetbrains.kotlin - %compilerPluginKotlinVersion% - - - - kotlin-dataframe - - - - - - org.jetbrains.kotlin - kotlin-maven-dataframe - %compilerPluginKotlinVersion% - - - -``` ## Project Example