Skip to content

Commit 45ebb18

Browse files
committed
Add maven configuration for compiler plugin
1 parent ec5ae2b commit 45ebb18

File tree

1 file changed

+56
-6
lines changed

1 file changed

+56
-6
lines changed

docs/StardustDocs/topics/Compiler-Plugin.md

Lines changed: 56 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ a powerful tool providing on-the-fly type-safe column-accessors for dataframes.
1616
</link-summary>
1717

1818

19-
> Now available in Gradle projects, is coming soon to Kotlin Notebook and Maven projects.
19+
> Now available in Gradle (IDEA 2025.2+) and Maven (IDEA 2025.3+) projects, is coming soon to Kotlin Notebook.
2020
2121
**Kotlin DataFrame Compiler Plugin** is a Kotlin compiler plugin that automatically generates
2222
**[type-safe extension properties](extensionPropertiesApi.md)** for your dataframes,
@@ -34,9 +34,13 @@ Check out this video that shows how expressions update the schema of a dataframe
3434

3535
## Setup
3636

37-
We recommend using up-to-date IntelliJ IDEA and Kotlin for the best experience. Minimal supported versions: 2025.2 and 2.2.0.
37+
We recommend using up-to-date IntelliJ IDEA and Kotlin for the best experience. Requires 2025.2 and 2.2.20 or higher.
3838

39-
Setup plugins in `build.gradle.kts`:
39+
<tabs>
40+
41+
<tab title="Gradle">
42+
43+
Setup plugins in build.gradle.kts:
4044

4145
```kotlin
4246
kotlin("jvm") version "%compilerPluginKotlinVersion%"
@@ -51,16 +55,62 @@ Setup library dependency:
5155
implementation("org.jetbrains.kotlinx:dataframe:%dataFrameVersion%")
5256
```
5357

54-
Add this line to `gradle.properties`:
58+
Add this line to `gradle.properties`:
5559
```properties
5660
kotlin.incremental=false
5761
```
58-
59-
`Sync` the project.
62+
63+
Sync the project.
6064

6165
Disabling incremental compilation will no longer be necessary
6266
when https://youtrack.jetbrains.com/issue/KT-66735 is resolved.
6367

68+
</tab>
69+
70+
<tab title="Maven">
71+
72+
DataFrame compiler plugin can be used in Maven projects starting from IntelliJ IDEA 2025.3, available now as EAP builds
73+
74+
Setup plugins in pom.xml:
75+
76+
```xml
77+
<plugin>
78+
<artifactId>kotlin-maven-plugin</artifactId>
79+
<groupId>org.jetbrains.kotlin</groupId>
80+
<version>%compilerPluginKotlinVersion%</version>
81+
82+
<configuration>
83+
<compilerPlugins>
84+
<plugin>kotlin-dataframe</plugin>
85+
</compilerPlugins>
86+
</configuration>
87+
88+
<dependencies>
89+
<dependency>
90+
<groupId>org.jetbrains.kotlin</groupId>
91+
<artifactId>kotlin-maven-dataframe</artifactId>
92+
<version>%compilerPluginKotlinVersion%</version>
93+
</dependency>
94+
</dependencies>
95+
</plugin>
96+
```
97+
98+
Setup library dependency:
99+
100+
```xml
101+
<dependency>
102+
<groupId>org.jetbrains.kotlinx</groupId>
103+
<artifactId>dataframe-core</artifactId>
104+
<version>%dataFrameVersion%</version>
105+
</dependency>
106+
```
107+
108+
Sync the project.
109+
110+
</tab>
111+
112+
</tabs>
113+
64114
## Features overview
65115

66116
### Static interpretation of DataFrame API

0 commit comments

Comments
 (0)