enabled docProcessor plugin and configured auto git-add with simple-git

Author: Jolanrensen

build.gradle.kts

@@ -14,6 +14,8 @@ plugins {
     id("org.jetbrains.dokka") version libs.versions.dokka
     id("org.jetbrains.kotlinx.kover") version libs.versions.kover
     id("org.jmailen.kotlinter") version libs.versions.ktlint
+    id("nl.jolanrensen.docProcessor") version libs.versions.docProcessor apply false
+    id("xyz.ronella.simple-git") version libs.versions.simpleGit apply false
 }
 
 val jupyterApiTCRepo: String by project

core/build.gradle.kts

@@ -1,3 +1,8 @@
+import nl.jolanrensen.docProcessor.defaultProcessors.*
+import nl.jolanrensen.docProcessor.gradle.creatingProcessDocTask
+import org.gradle.jvm.tasks.Jar
+import xyz.ronella.gradle.plugin.simple.git.task.GitTask
+
 @Suppress("DSL_SCOPE_VIOLATION", "UnstableApiUsage")
 plugins {
     kotlin("jvm")
@@ -10,6 +15,9 @@ plugins {
     id("org.jetbrains.kotlinx.kover")
     id("org.jmailen.kotlinter")
     id("org.jetbrains.kotlinx.dataframe")
+    id("nl.jolanrensen.docProcessor")
+    id("xyz.ronella.simple-git")
+    idea
 }
 
 group = "org.jetbrains.kotlinx"
@@ -52,6 +60,66 @@ kotlin.sourceSets {
     }
 }
 
+val generatedSourcesFolderName = "generated-sources"
+val addGeneratedSourcesToGit by tasks.creating(GitTask::class) {
+    directory.set(file("."))
+    command.set("add")
+    args.set(listOf("-A", generatedSourcesFolderName))
+}
+
+// Backup the kotlin source files location
+val kotlinMainSources = kotlin.sourceSets.main.get().kotlin.sourceDirectories
+
+// Task to generate the processed documentation
+val processKDocsMain by creatingProcessDocTask(
+    sources = kotlinMainSources.filterNot { "build/generated" in it.path }, // Exclude generated sources
+) {
+    target = file(generatedSourcesFolderName)
+    processors = listOf(
+        INCLUDE_DOC_PROCESSOR,
+        INCLUDE_FILE_DOC_PROCESSOR,
+        INCLUDE_ARG_DOC_PROCESSOR,
+        COMMENT_DOC_PROCESSOR,
+        SAMPLE_DOC_PROCESSOR,
+    )
+
+    task {
+        doLast {
+            // ensure generated sources are added to git
+            addGeneratedSourcesToGit.executeCommand()
+        }
+    }
+}
+
+// Exclude the generated/processed sources from the IDE
+idea {
+    module {
+        excludeDirs.add(file(generatedSourcesFolderName))
+    }
+}
+
+// Modify all Jar tasks such that before running the Kotlin sources are set to
+// the target of processKdocMain and they are returned back to normal afterwards.
+tasks.withType<Jar> {
+    dependsOn(processKDocsMain)
+    outputs.upToDateWhen { false }
+
+    doFirst {
+        kotlin.sourceSets.main {
+            kotlin.setSrcDirs(
+                processKDocsMain.targets +
+                    kotlinMainSources.filter { "build/generated" in it.path } // Include generated sources (which were excluded above)
+            )
+        }
+    }
+
+    doLast {
+        kotlin.sourceSets.main {
+            kotlin.setSrcDirs(kotlinMainSources)
+        }
+    }
+}
+
 korro {
     docs = fileTree(rootProject.rootDir) {
         include("docs/StardustDocs/topics/*.md")
@@ -169,3 +237,13 @@ dataframes {
         name = "org.jetbrains.kotlinx.dataframe.samples.api.Repository"
     }
 }
+
+// If we want to use Dokka, make sure to use the preprocessed sources
+tasks.withType<org.jetbrains.dokka.gradle.AbstractDokkaLeafTask> {
+    dependsOn(processKDocsMain)
+    dokkaSourceSets {
+        all {
+            sourceRoot(processKDocsMain.target.get())
+        }
+    }
+}

gradle/libs.versions.toml

@@ -24,6 +24,8 @@ junit = "4.13.2"
 kotestAsserions = "4.6.3"
 jsoup = "1.14.3"
 arrow = "10.0.0"
+docProcessor = "0.1.0"
+simpleGit = "2.0.1"
 
 [libraries]
 ksp-gradle = { group = "com.google.devtools.ksp", name = "symbol-processing-gradle-plugin", version.ref = "ksp" }
@@ -65,3 +67,5 @@ korro = { id = "io.github.devcrocod.korro", version.ref = "korro" }
 kotlinter = { id = "org.jmailen.kotlinter", version.ref = "ktlint" }
 dataframe = { id = "org.jetbrains.kotlinx.dataframe", version.ref = "dataframe" }
 kotlin-serialization = { id = "org.jetbrains.kotlin.plugin.serialization", version.ref = "kotlin" }
+docProcessor = { id = "nl.jolanrensen.docProcessor", version.ref = "docProcessor" }
+simpleGit = { id = "xyz.ronella.simple-git", version.ref = "simpleGit"}