-
Notifications
You must be signed in to change notification settings - Fork 77
Update Compiler-Plugin.md #1576
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| # Kotlin DataFrame Compiler Plugin | ||
| # Setup And Overview | ||
|
|
||
| <web-summary> | ||
| Explore the Kotlin DataFrame Compiler Plugin — | ||
|
|
@@ -16,7 +16,7 @@ a powerful tool providing on-the-fly type-safe column-accessors for dataframes. | |
| </link-summary> | ||
|
|
||
|
|
||
| > Now available in Gradle projects, is coming soon to Kotlin Notebook and Maven projects. | ||
| > Now available in Gradle (IDEA 2025.2+) and Maven (IDEA 2025.3+) projects, is coming soon to Kotlin Notebook. | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. and amper? :) maybe link to the YT issue so people can vote if they want it too |
||
|
|
||
| **Kotlin DataFrame Compiler Plugin** is a Kotlin compiler plugin that automatically generates | ||
| **[type-safe extension properties](extensionPropertiesApi.md)** for your dataframes, | ||
|
|
@@ -34,11 +34,13 @@ Check out this video that shows how expressions update the schema of a dataframe | |
|
|
||
| ## Setup | ||
|
|
||
| Install [IntelliJ IDEA EAP](https://www.jetbrains.com/idea/nextversion/). | ||
| Going forward, compiler plugin updates will be released with Kotlin plugin updates. | ||
| Next release: 2025.2 | ||
| We recommend using an up-to-date IntelliJ IDEA and Kotlin version for the best experience. Requires at least versions 2025.2 and 2.2.20, respectively. | ||
|
|
||
| Setup plugins in `build.gradle.kts`: | ||
| <tabs> | ||
|
|
||
| <tab title="Gradle"> | ||
|
|
||
| Setup plugins in build.gradle.kts: | ||
koperagen marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ```kotlin | ||
| kotlin("jvm") version "%compilerPluginKotlinVersion%" | ||
|
|
@@ -53,16 +55,62 @@ Setup library dependency: | |
| implementation("org.jetbrains.kotlinx:dataframe:%dataFrameVersion%") | ||
| ``` | ||
|
|
||
| Add this line to `gradle.properties`: | ||
| Add this line to `gradle.properties`: | ||
| ```properties | ||
| kotlin.incremental=false | ||
| ``` | ||
| `Sync` the project. | ||
|
|
||
| Sync the project. | ||
|
|
||
| Disabling incremental compilation will no longer be necessary | ||
| when https://youtrack.jetbrains.com/issue/KT-66735 is resolved. | ||
|
|
||
| </tab> | ||
|
|
||
| <tab title="Maven"> | ||
|
|
||
| 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: | ||
|
|
||
| ```xml | ||
| <plugin> | ||
| <artifactId>kotlin-maven-plugin</artifactId> | ||
| <groupId>org.jetbrains.kotlin</groupId> | ||
| <version>%compilerPluginKotlinVersion%</version> | ||
|
|
||
| <configuration> | ||
| <compilerPlugins> | ||
| <plugin>kotlin-dataframe</plugin> | ||
| </compilerPlugins> | ||
| </configuration> | ||
|
|
||
| <dependencies> | ||
| <dependency> | ||
| <groupId>org.jetbrains.kotlin</groupId> | ||
| <artifactId>kotlin-maven-dataframe</artifactId> | ||
| <version>%compilerPluginKotlinVersion%</version> | ||
| </dependency> | ||
| </dependencies> | ||
| </plugin> | ||
| ``` | ||
|
|
||
| Setup library dependency: | ||
|
|
||
| ```xml | ||
| <dependency> | ||
| <groupId>org.jetbrains.kotlinx</groupId> | ||
| <artifactId>dataframe</artifactId> | ||
| <version>%dataFrameVersion%</version> | ||
| </dependency> | ||
| ``` | ||
|
|
||
| Sync the project. | ||
|
|
||
| </tab> | ||
|
|
||
| </tabs> | ||
|
|
||
| ## Features overview | ||
|
|
||
| ### Static interpretation of DataFrame API | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.