Knit clean task (#565)

Co-authored-by: Andrey Bragin <[email protected]>

Author: tiginamaria

build.gradle.kts

@@ -223,7 +223,8 @@ kover {
     val excludedProjects = setOf(
         ":integration-tests",
         ":examples",
-        ":buildSrc"
+        ":buildSrc",
+        ":docs",
     )
     merge {
         subprojects {

docs/README.md

@@ -31,18 +31,14 @@ To ensure code snippets in documentation are compilable and up-to-date with the
 Knit provides a Gradle plugin that extracts specially annotated Kotlin code snippets from markdown files and generates Kotlin source files.
 
 #### How to fix docs?
-1. Run knit to extract code snippets to /src/main/kotlin:
+1. Run `:docs:knitAssemble` task which will clean old knit-generated files, extract fresh code snippets to /src/main/kotlin and assemble the docs project:
 ```
-./gradlew :docs:knit
+./gradlew :docs:knitAssemble
 ```
-2. Run assemble to get compilation arrows:
-```
-./gradlew :docs:assemble
-```
-3. Navigate to the file with the compilation error `example-[md-file-name]-[index].kt`
-4. Fix the error in this file
-5. Navigate to the code snippet in Markdown `md-file-name.md` by searing `<!--- KNIT example-[md-file-name]-[index].kt` -->`
-6. Update the code snippet to reflect the changes in kt file
+2. Navigate to the file with the compilation error `example-[md-file-name]-[index].kt`
+3. Fix the error in this file
+4. Navigate to the code snippet in Markdown `md-file-name.md` by searing `<!--- KNIT example-[md-file-name]-[index].kt` -->`
+5. Update the code snippet to reflect the changes in kt file
    * Update dependencies (usually they are provided in `<!--- INCLUDE -->` section)
    * Edit code (don't forget about tabulation when you just copy paste from kt)
 

docs/build.gradle.kts

@@ -1,3 +1,5 @@
+import java.util.Properties
+
 group = rootProject.group
 version = rootProject.version
 
@@ -14,6 +16,28 @@ dependencies {
     implementation(libs.opentelemetry.exporter.logging)
 }
 
+val knitProperties: Provider<Properties> =
+    providers.fileContents(layout.projectDirectory.file("knit.properties"))
+        .asText
+        .map { text ->
+            Properties().apply {
+                text.reader().use { load(it) }
+            }
+        }
+
+val knitDir: Provider<String> =
+    knitProperties.map { props ->
+        requireNotNull(props.getProperty("knit.dir")) {
+            "Missing 'knit.dir' in knit.properties"
+        }
+    }
+
+ktlint {
+    filter {
+        exclude { it.file.path.contains("/docs/${knitDir.get()}/") }
+    }
+}
+
 knit {
     rootDir = project.rootDir
     files = fileTree("docs/") {
@@ -22,3 +46,22 @@ knit {
     moduleDocs = "docs/modules.md"
     siteRoot = "https://docs.koog.ai/"
 }
+
+tasks.register<Delete>("knitClean") {
+    delete(
+        fileTree(project.rootDir) {
+            include("**/docs/${knitDir.get()}/**")
+        }
+    )
+}
+
+tasks.named("clean") {
+    dependsOn("knitClean")
+}
+
+tasks.register<Delete>("knitAssemble") {
+    dependsOn("knitClean", "knit", "assemble")
+}
+
+tasks.named("knit").configure { mustRunAfter("knitClean") }
+tasks.named("assemble").configure { mustRunAfter("knit") }