Skip to content

Commit ff0e3d9

Browse files
committed
Update Gradle plugin docs and fix hardcoded versions
1 parent cbc064b commit ff0e3d9

File tree

5 files changed

+30
-13
lines changed

5 files changed

+30
-13
lines changed

docs/StardustDocs/d.tree

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,8 @@
199199
<toc-element topic="jupyterRendering.md"/>
200200
</toc-element>
201201
</toc-element>
202-
<toc-element topic="gradleReference.md"/>
203-
<toc-element topic="DataSchema-Data-Classes-Generation.md"/>
202+
<toc-element topic="DataSchema-Data-Classes-Generation.md">
203+
<toc-element topic="gradleReference.md"/>
204+
</toc-element>
204205
<toc-element topic="_shadow_resources.md" hidden="true"/>
205206
</instance-profile>

docs/StardustDocs/topics/Compiler-Plugin.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,16 +14,16 @@ Next release: 2025.2
1414
Setup plugins in `build.gradle.kts`:
1515

1616
```kotlin
17-
kotlin("jvm") version "2.2.20-dev-3524"
17+
kotlin("jvm") version "%compilerPluginKotlinVersion%"
1818
```
1919

2020
```kotlin
21-
kotlin("plugin.dataframe") version "2.2.20-dev-3524"
21+
kotlin("plugin.dataframe") version "%compilerPluginKotlinVersion%"
2222
```
2323

2424
Setup library dependency:
2525
```kotlin
26-
implementation("org.jetbrains.kotlinx:dataframe:1.0.0-Beta2")
26+
implementation("org.jetbrains.kotlinx:dataframe:%dataFrameVersion%")
2727
```
2828

2929
Plugin is released as a dev version, available in this maven repository:

docs/StardustDocs/topics/gettingStarted/gettingStartedGradle.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,6 @@ In your Gradle build file (`build.gradle.kts`), add the Kotlin DataFrame library
3737
<tab title="Kotlin DSL">
3838

3939
```kotlin
40-
plugins {
41-
id("org.jetbrains.kotlinx.dataframe") version "%dataFrameVersion%"
42-
}
43-
4440
dependencies {
4541
implementation("org.jetbrains.kotlinx:dataframe:%dataFrameVersion%")
4642
}
@@ -51,10 +47,6 @@ dependencies {
5147
<tab title="Groovy DSL">
5248

5349
```groovy
54-
plugins {
55-
id "org.jetbrains.kotlinx.dataframe" version "%dataFrameVersion%"
56-
}
57-
5850
dependencies {
5951
implementation 'org.jetbrains.kotlinx:dataframe:%dataFrameVersion%'
6052
}

docs/StardustDocs/topics/gradleReference.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,28 @@
11
[//]: # (title: Gradle plugin reference)
22

3+
This page describes the Gradle plugin that generates `@DataSchema` from data samples.
4+
```Kotlin
5+
id("org.jetbrains.kotlinx.dataframe") version "%dataFrameVersion%"
6+
```
7+
8+
It's different from the DataFrame compiler plugin:
9+
```kotlin
10+
kotlin("plugin.dataframe") version "%compilerPluginKotlinVersion%"
11+
```
12+
13+
Gradle plugin by default adds a KSP annotation processor to your build:
14+
15+
```kotlin
16+
ksp("org.jetbrains.kotlinx.dataframe:symbol-processor-all:%dataFrameVersion%")
17+
```
18+
19+
You should disable it if you want to use the Gradle plugin together with the compiler plugin.
20+
21+
Add this to `gradle.properties`:
22+
```properties
23+
kotlin.dataframe.add.ksp=false
24+
```
25+
326
## Examples
427
In the best scenario, your schema could be defined as simple as this:
528
```kotlin

docs/StardustDocs/v.list

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,5 @@
22
<!DOCTYPE vars SYSTEM "https://resources.jetbrains.com/writerside/1.0/vars.dtd">
33
<vars>
44
<var name="dataFrameVersion" value="1.0.0-Beta2" type="string"/>
5+
<var name="compilerPluginKotlinVersion" value="2.2.20-dev-3524" type="string"/>
56
</vars>

0 commit comments

Comments
 (0)