added includeCoreLibrariesJson parameter

Author: Jolanrensen

CONTRIBUTING.md

@@ -112,6 +112,9 @@ This library is built with Gradle.
   making local publishing faster: `./gradlew publishToMavenLocal -PskipKodex`.
   This, however, publishes the library with "broken" KDocs, 
   so it's only meant for faster iterations during development.
+* The parameter `-PincludeCoreLibrariesJson` makes the build include the `libraries.json` file in the `:core` module.
+  This file allows loading dataframe-jupyter when dataframe-core is present on its own in a Kotlin Notebook.
+  Usually only done when publishing.
 
 You can import this project into IDEA, but you have to delegate the build actions
 to Gradle (in Preferences -> Build, Execution, Deployment -> Build Tools -> Gradle -> Runner)

core/build.gradle.kts

@@ -281,41 +281,31 @@ val generateLibrariesJson by tasks.registering {
     }
 }
 
-// If `changeProcessResourcesTask` is run, modify the processResources task such that before running,
-// a META-INF libraries.json file is added to the resources.
+// If `includeCoreLibrariesJson` is set, modify the processResources task such that it includes
+// a META-INF libraries.json file.
 // This file allows loading dataframe-jupyter when dataframe-core is present on its own in a Kotlin Notebook.
 // This is usually only done when publishing.
-val changeProcessResourcesTask by tasks.registering {
-    doFirst {
-        tasks.processResources {
-            from(generatedJupyterResourcesDir) {
-                into("") // keep META-INF/... structure as generated
-            }
-            doLast {
-                logger.lifecycle("$this includes generated META-INF/kotlin-jupyter-libraries/libraries.json")
-            }
+tasks.processResources {
+    if (project.hasProperty("includeCoreLibrariesJson")) {
+        dependsOn(generateLibrariesJson)
+        from(generatedJupyterResourcesDir) {
+            into("") // keep META-INF/... structure as generated
+        }
+        doLast {
+            logger.lifecycle("$this includes generated META-INF/kotlin-jupyter-libraries/libraries.json")
         }
     }
 }
-tasks.processResources {
-    mustRunAfter(changeProcessResourcesTask)
-    dependsOn(generateLibrariesJson)
-}
 
 // if `processKDocsMain` runs, the Jar tasks must run after it so the generated-sources are there
 tasks.withType<Jar> {
     mustRunAfter(changeJarTask, tasks.generateKeywordsSrc, processKDocsMain)
 }
 
 // modify all publishing tasks to depend on `changeJarTask` so the sources are swapped out with generated sources
-// also `changeProcessResourcesTask`, so libraries.json is included in the resources
 tasks.configureEach {
-    if (name.startsWith("publish")) {
-        dependsOn(changeProcessResourcesTask)
-
-        if (!project.hasProperty("skipKodex")) {
-            dependsOn(processKDocsMain, changeJarTask)
-        }
+    if (!project.hasProperty("skipKodex") && name.startsWith("publish")) {
+        dependsOn(processKDocsMain, changeJarTask)
     }
 }
 

gradle.properties

@@ -22,3 +22,12 @@ ksp.useKSP2=false
 kotlin.dataframe.debug=false
 
 kotlin.incremental=false
+
+# Can speed up build time but stops KDocs from being preprocessed.
+# It can also be turned on from the command line with `-PskipKodex`
+# skipKodex=true
+
+# If `true`, builds include the core/src/main/resources/META-INF/kotlin-jupyter-libraries/libraries.json file.
+# This file allows loading dataframe-jupyter when dataframe-core is present on its own in a Kotlin Notebook.
+# This is usually only done when publishing and can be turned on from the command line with `-PincludeCoreLibrariesJson`
+# includeCoreLibrariesJson=true