Docusaurus Working Directories (#17)

mfwgenerics · Feb 18, 2023 · 7d5c5f2 · 7d5c5f2
1 parent 654cfa6
commit 7d5c5f2
Show file tree

Hide file tree

Showing 5 changed files with 64 additions and 16 deletions.
diff --git a/markout-docusaurus-plugin/build.gradle.kts b/markout-docusaurus-plugin/build.gradle.kts
@@ -5,7 +5,7 @@ plugins {
 dependencies {
     implementation("com.github.node-gradle:gradle-node-plugin:3.5.1")
     implementation("io.koalaql:kapshot-plugin-gradle:0.1.1")
-    implementation("io.koalaql:markout-plugin")
+    implementation("io.koalaql:markout-plugin:${project.version}")
 }
 
 pluginBundle {

diff --git a/markout-docusaurus-plugin/src/main/kotlin/io/koalaql/markout/docusaurus/GradlePlugin.kt b/markout-docusaurus-plugin/src/main/kotlin/io/koalaql/markout/docusaurus/GradlePlugin.kt
@@ -8,11 +8,11 @@ import com.github.gradle.node.variant.VariantComputer
 import com.github.gradle.node.yarn.exec.YarnExecRunner
 import org.gradle.api.Plugin
 import org.gradle.api.Project
-
 import com.github.gradle.node.yarn.task.YarnTask
 import io.koalaql.markout_plugin.BuildConfig
 import org.gradle.api.Action
 import org.gradle.api.DefaultTask
+import org.gradle.api.file.Directory
 import org.gradle.api.model.ObjectFactory
 import org.gradle.api.provider.ProviderFactory
 import org.gradle.api.tasks.Input
@@ -26,10 +26,13 @@ import org.gradle.nativeplatform.platform.internal.DefaultNativePlatform
 import org.gradle.process.ExecResult
 import org.gradle.process.ExecSpec
 import java.io.File
+import java.nio.file.Path
 import java.util.concurrent.atomic.AtomicBoolean
 import java.util.concurrent.atomic.AtomicReference
 import javax.inject.Inject
 import kotlin.concurrent.thread
+import org.gradle.api.provider.Provider
+import kotlin.io.readLines
 
 class StopHandle {
     private companion object {
@@ -173,14 +176,10 @@ abstract class RunDocusaurus: DefaultTask() {
                 )
             }
         } else {
-            project.logger.warn("""
-                WARNING: $path was run non-continuously and will not hot reload changes
-                WARNING: You probably want to run this with `./gradlew $path --continuous` instead 
+            error("""
+                ERROR: $path was run non-continuously and will not hot reload changes
+                ERROR: You want to run this with `./gradlew $path --continuous` instead
             """.trimIndent())
-
-            val start = buildYarnStart()
-
-            start()
         }
     }
 }
@@ -198,11 +197,24 @@ class GradlePlugin: Plugin<Project> {
 
         extensions.configure(NodeExtension::class.java) {
             it.download.set(true)
-            it.nodeProjectDir.set(File("$rootDir/docusaurus"))
         }
 
+        val workingDirProvider = layout
+            .buildDirectory
+            .file("markout/paths.txt")
+            .flatMap { file -> project.layout.buildDirectory.dir(file
+                .asFile
+                .readLines()
+                .asSequence()
+                .filter { it.endsWith("/docusaurus.config.js") }
+                .firstOrNull()
+                ?.removeSuffix("/docusaurus.config.js")
+                ?: error("No docusaurus directory configured")
+            ) }
+
         tasks.register("docusaurusInstall", YarnTask::class.java) {
             it.dependsOn("markout")
+            it.workingDir.set(workingDirProvider)
 
             it.args.set(listOf(
                 "--silent",
@@ -214,6 +226,7 @@ class GradlePlugin: Plugin<Project> {
 
         tasks.register("docusaurusCheckInstall", YarnTask::class.java) {
             it.dependsOn("markoutCheck")
+            it.workingDir.set(workingDirProvider)
 
             it.args.set(listOf(
                 "--silent",
@@ -226,6 +239,7 @@ class GradlePlugin: Plugin<Project> {
         tasks.register<RunDocusaurus>("docusaurusStart", RunDocusaurus::class.java) {
             it.dependsOn("docusaurusInstall")
             it.dependsOn("markout")
+            it.workingDir.set(workingDirProvider)
 
             it.doLast {
                 gradle.startParameter.setExcludedTaskNames(
@@ -237,6 +251,7 @@ class GradlePlugin: Plugin<Project> {
         tasks.register("docusaurusBuild", YarnTask::class.java) {
             it.dependsOn("markoutCheck")
             it.dependsOn("docusaurusCheckInstall")
+            it.workingDir.set(workingDirProvider)
 
             it.args.set(listOf(
                 "--silent",

diff --git a/markout-plugin/src/main/kotlin/io/koalaql/markout/GradlePlugin.kt b/markout-plugin/src/main/kotlin/io/koalaql/markout/GradlePlugin.kt
@@ -1,12 +1,32 @@
 package io.koalaql.markout
 
-import org.gradle.api.DefaultTask
-import org.gradle.api.Plugin
-import org.gradle.api.Project
 import org.gradle.api.plugins.JavaPluginExtension
 import org.gradle.api.tasks.JavaExec
 import java.util.concurrent.Callable
 import io.koalaql.markout_plugin.BuildConfig
+import org.gradle.api.*
+import org.gradle.api.tasks.Internal
+import org.gradle.api.tasks.OutputFile
+
+open class MarkoutExecTask: JavaExec() {
+    @Internal
+    val markoutBuildDir = project
+        .buildDir
+        .toPath()
+        .resolve("markout")
+
+    @OutputFile
+    val outputPath = project.buildDir.toPath().resolve("markout/paths.txt")
+
+    override fun exec() {
+        markoutBuildDir.toFile().apply {
+            deleteRecursively()
+            mkdir()
+        }
+
+        super.exec()
+    }
+}
 
 class GradlePlugin: Plugin<Project> {
     override fun apply(target: Project) = with(target) {
@@ -24,8 +44,8 @@ class GradlePlugin: Plugin<Project> {
             }
         }
 
-        fun execTask(name: String, builder: (JavaExec) -> Unit) = tasks
-            .register(name, JavaExec::class.java) {
+        fun execTask(name: String, builder: (MarkoutExecTask) -> Unit) = tasks
+            .register(name, MarkoutExecTask::class.java) {
                 val ext = target.extensions.getByType(MarkoutConfig::class.java)
 
                 it.group = "markout"
@@ -39,6 +59,7 @@ class GradlePlugin: Plugin<Project> {
                         .runtimeClasspath
                     })
 
+                it.environment("MARKOUT_BUILD_DIR", "${it.markoutBuildDir}")
                 it.environment("MARKOUT_PATH", (ext.rootDir ?: rootDir).absolutePath)
 
                 if (ext.mainClass != null) it.mainClass.set(ext.mainClass)

diff --git a/markout/src/main/kotlin/io/koalaql/markout/ActionableFiles.kt b/markout/src/main/kotlin/io/koalaql/markout/ActionableFiles.kt
@@ -10,6 +10,9 @@ class ActionableFiles(
         return paths.mapNotNull { (path, action) -> action.perform(path) }
     }
 
+    fun paths(): List<Path> =
+        paths.asSequence().map { it.key }.toList()
+
     fun expect(): List<Diff> {
         val visited = linkedMapOf<Path, Boolean>()
 

diff --git a/markout/src/main/kotlin/io/koalaql/markout/Markout.kt b/markout/src/main/kotlin/io/koalaql/markout/Markout.kt
@@ -13,6 +13,7 @@ import java.io.OutputStream
 import java.nio.file.Files
 import java.nio.file.NoSuchFileException
 import java.nio.file.Path
+import java.nio.file.StandardOpenOption
 import kotlin.io.path.*
 
 @MarkoutDsl
@@ -46,7 +47,9 @@ interface Markout {
         file(TrackedName(name), contents)
 }
 
-fun buildOutput(builder: Markout.() -> Unit): OutputDirectory = OutputDirectory {
+fun buildOutput(
+    builder: Markout.() -> Unit
+): OutputDirectory = OutputDirectory {
     val entries = linkedMapOf<String, OutputEntry>()
 
     fun set(name: FileName, output: Output) {
@@ -234,6 +237,12 @@ fun markout(
             if (diffs.isNotEmpty()) error(diffs.joinToString("\n"))
         }
     }
+
+    System.getenv("MARKOUT_BUILD_DIR")
+        ?.takeIf { it.isNotBlank() }
+        ?.let(::Path)
+        ?.resolve("paths.txt")
+        ?.writeLines(actions.paths().asSequence().map { "$it" })
 }
 
 fun markout(