Skip to content

KoDEx 0.4.2 #1017

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 4 commits into from
Jan 19, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 4 additions & 8 deletions core/build.gradle.kts
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
import com.google.devtools.ksp.gradle.KspTask
import com.google.devtools.ksp.gradle.KspTaskJvm
import io.github.devcrocod.korro.KorroTask
import nl.jolanrensen.kodex.defaultProcessors.ARG_DOC_PROCESSOR_LOG_NOT_FOUND
import nl.jolanrensen.kodex.gradle.creatingProcessDocTask
import nl.jolanrensen.kodex.gradle.creatingRunKodexTask
import org.gradle.jvm.tasks.Jar
import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
import xyz.ronella.gradle.plugin.simple.git.task.GitTask
Expand Down Expand Up @@ -207,20 +206,17 @@ val generatedSources by kotlin.sourceSets.creating {
}

// Task to generate the processed documentation
val processKDocsMain by creatingProcessDocTask(processKDocsMainSources) {
val processKDocsMain by creatingRunKodexTask(processKDocsMainSources) {
group = "KDocs"
target = file(generatedSourcesFolderName)
arguments += ARG_DOC_PROCESSOR_LOG_NOT_FOUND to false

// false, so `runKtlintFormatOverGeneratedSourcesSourceSet` can format the output
outputReadOnly = false

exportAsHtml {
dir = file("../docs/StardustDocs/snippets/kdocs")
}
task {
group = "KDocs"
finalizedBy("runKtlintFormatOverGeneratedSourcesSourceSet")
}
finalizedBy("runKtlintFormatOverGeneratedSourcesSourceSet")
}

tasks.named("ktlintGeneratedSourcesSourceSetCheck") {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -71,10 +71,10 @@ public class Update<T, C>(
* {@get [UpdateOperationArg]}**` { `**[`columns`][SelectingColumns]**` }`**
*
* {@include [Indent]}
* `[ `__`.`__[**`where`**][Update.where]**` { `**[`rowValueCondition`][SelectingRows.RowValueCondition.WithExample]**` } `**`]`
* `\[ `__`.`__[**`where`**][Update.where]**` { `**[`rowValueCondition`][SelectingRows.RowValueCondition.WithExample]**` } `**`]`
*
* {@include [Indent]}
* `[ `__`.`__[**`at`**][Update.at]**`(`**[`rowIndices`][CommonUpdateAtFunctionDoc.RowIndicesParam]**`)`**` ]`
* `\[ `__`.`__[**`at`**][Update.at]**`(`**[`rowIndices`][CommonUpdateAtFunctionDoc.RowIndicesParam]**`)`**` ]`
*
* {@include [Indent]}
* __`.`__[**`with`**][Update.with]**` { `**[`rowExpression`][ExpressionsGivenRow.RowValueExpression.WithExample]**` }`**
Expand Down
Original file line number Diff line number Diff line change
@@ -1,18 +1,15 @@
@file:ExcludeFromSources

package org.jetbrains.kotlinx.dataframe.documentation

import org.jetbrains.kotlinx.dataframe.ColumnFilter
import org.jetbrains.kotlinx.dataframe.ColumnSelector
import org.jetbrains.kotlinx.dataframe.ColumnsSelector
import org.jetbrains.kotlinx.dataframe.DataRow
import org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDsl
import org.jetbrains.kotlinx.dataframe.api.ColumnsSelectionDslLink
import org.jetbrains.kotlinx.dataframe.columns.ColumnKind
import org.jetbrains.kotlinx.dataframe.columns.ColumnSet
import org.jetbrains.kotlinx.dataframe.columns.ColumnsResolver
import org.jetbrains.kotlinx.dataframe.documentation.DslGrammarTemplateColumnsSelectionDsl.DslGrammarTemplate.ColumnGroupRef
import org.jetbrains.kotlinx.dataframe.documentation.DslGrammarTemplateColumnsSelectionDsl.DslGrammarTemplate.ColumnSetRef
import org.jetbrains.kotlinx.dataframe.documentation.DslGrammarTemplateColumnsSelectionDsl.UsageTemplateExample.ColumnGroupName
import org.jetbrains.kotlinx.dataframe.documentation.DslGrammarTemplateColumnsSelectionDsl.UsageTemplateExample.ColumnSetName

/*
* This template is to be used in displaying the Usage / DSL grammar
Expand All @@ -26,45 +23,39 @@ public interface DslGrammarTemplateColumnsSelectionDsl {
/**
* {@include [LineBreak]}
* {@include [DslGrammarLink]}
* {@set [DslGrammarTemplate.DefinitionsPart]
* {@get [DslGrammarTemplate.DefinitionsPart]
* {@include [LineBreak]}
* ### Definitions:
* {@get [DslGrammarTemplate.DefinitionsArg]}
* }{@get [DslGrammarTemplate.DefinitionsPart]}
* }
* {@comment -------------------------------------------------------------------------------------------- }
* {@set [DslGrammarTemplate.PlainDslPart]
* {@get [DslGrammarTemplate.PlainDslPart]
* {@include [LineBreak]}
* ### What can be called directly in the {@include [ColumnsSelectionDslLink]}:
*
* {@include [LineBreak]}
* {@get [DslGrammarTemplate.PlainDslFunctionsArg]}
* }{@get [DslGrammarTemplate.PlainDslPart]}
* }
* {@comment -------------------------------------------------------------------------------------------- }
* {@set [DslGrammarTemplate.ColumnSetPart]
* {@get [DslGrammarTemplate.ColumnSetPart]
* {@include [LineBreak]}
* ### What can be called on a [ColumnSet][org.jetbrains.kotlinx.dataframe.columns.ColumnSet]:
*
* {@include [LineBreak]}
* {@include [ColumnSetRef]}
*
* {@get [DslGrammarTemplate.ColumnSetFunctionsArg]}
* }{@get [DslGrammarTemplate.ColumnSetPart]}
* }
* {@comment -------------------------------------------------------------------------------------------- }
* {@set [DslGrammarTemplate.ColumnGroupPart]
* {@get [DslGrammarTemplate.ColumnGroupPart]
* {@include [LineBreak]}
* ### What can be called on a [Column Group (reference)][DslGrammarTemplate.ColumnGroupDef]:
*
* {@include [LineBreak]}
* {@include [ColumnGroupRef]}
*
* {@get [DslGrammarTemplate.ColumnGroupFunctionsArg]}
* }{@get [DslGrammarTemplate.ColumnGroupPart]}
* {@comment -------------------------------------------------------------------------------------------- }
* {@comment Setting default arguments for the template}
* {@set [DslGrammarTemplate.DefinitionsArg]}
* {@set [DslGrammarTemplate.PlainDslFunctionsArg]}
* {@set [DslGrammarTemplate.ColumnSetFunctionsArg]}
* {@set [DslGrammarTemplate.ColumnGroupFunctionsArg]}
* }
*/
public interface DslGrammarTemplate {

Expand Down
12 changes: 4 additions & 8 deletions dataframe-csv/build.gradle.kts
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
import nl.jolanrensen.kodex.defaultProcessors.ARG_DOC_PROCESSOR_LOG_NOT_FOUND
import nl.jolanrensen.kodex.gradle.creatingProcessDocTask
import nl.jolanrensen.kodex.gradle.creatingRunKodexTask
import org.gradle.jvm.tasks.Jar

plugins {
Expand Down Expand Up @@ -85,20 +84,17 @@ val generatedSources by kotlin.sourceSets.creating {
}

// Task to generate the processed documentation
val processKDocsMain by creatingProcessDocTask(processKDocsMainSources) {
val processKDocsMain by creatingRunKodexTask(processKDocsMainSources) {
group = "KDocs"
target = file(generatedSourcesFolderName)
arguments += ARG_DOC_PROCESSOR_LOG_NOT_FOUND to false

// false, so `runKtlintFormatOverGeneratedSourcesSourceSet` can format the output
outputReadOnly = false

exportAsHtml {
dir = file("../docs/StardustDocs/snippets/kdocs")
}
task {
group = "KDocs"
finalizedBy("runKtlintFormatOverGeneratedSourcesSourceSet")
}
finalizedBy("runKtlintFormatOverGeneratedSourcesSourceSet")
}

tasks.named("ktlintGeneratedSourcesSourceSetCheck") {
Expand Down
2 changes: 1 addition & 1 deletion gradle/libs.versions.toml
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ kotestAsserions = "5.5.4"

jsoup = "1.18.3"
arrow = "18.1.0"
kodex = "0.4.0"
kodex = "0.4.2"
simpleGit = "2.0.3" # Can't be updated to 2.1.0+ due to Java 8 compatibility
dependencyVersions = "0.51.0"
plugin-publish = "1.3.0"
Expand Down
Loading