merge: Kotlin 2.1.20 support

maximegirardet · maximegirardet · commit ac943d21ea8d · 2025-06-26T17:55:08.000Z
Closes #55

See merge request opensavvy/automation/kotlin-vite!96
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
@@ -14,7 +14,7 @@ include:
 
 variables:
   # https://gitlab.com/opensavvy/automation/containers
-  ci_containers: 0.6.0
+  ci_containers: 0.7.0
 
   # Kotlin Multiplatform
   kotlin_jvm: "yes"
@@ -379,7 +379,7 @@ dokka:
 
   script:
     - >
-      ./gradlew :dokkatooGeneratePublicationHtml
+      ./gradlew :dokkaGeneratePublicationHtml
       --no-configuration-cache
       -PappVersion=$project_version
 
diff --git a/.idea/runConfigurations/Documentation.xml b/.idea/runConfigurations/Documentation.xml
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -21,8 +21,8 @@ plugins {
 
 dependencies {
 	// List the 'library' projects
-	dokkatoo(projects.viteKotlin)
-	dokkatoo(projects.viteBase)
+	dokka(projects.viteKotlin)
+	dokka(projects.viteBase)
 }
 
 // region Check the users of the project didn't forget to rename the group
diff --git a/docs/website/.gitignore b/docs/website/.gitignore
@@ -1 +1,4 @@
 .cache
+
+# Dokka output
+api/
diff --git a/docs/website/.gitlab-ci.yml b/docs/website/.gitlab-ci.yml
@@ -2,8 +2,11 @@
 mkdocs:
   image: registry.gitlab.com/opensavvy/automation/containers/mkdocs:$ci_containers
   stage: build
+  extends: [ .os.gradle ]
+  needs: [ os.version ]
 
   before_script:
+    - ./gradlew docs:website:embedDokkaIntoMkDocs -PappVersion=$project_version
     - cd docs/website
     - ls
     - 'echo "repo_url: $CI_PROJECT_URL">>mkdocs.yml'
@@ -12,6 +15,7 @@ mkdocs:
 
   script:
     - pwd
+    - ./generate-news.sh
     - mkdocs build --site-dir ../../docs-website
 
   after_script:
diff --git a/docs/website/build.gradle.kts b/docs/website/build.gradle.kts
@@ -0,0 +1,9 @@
+plugins {
+	alias(opensavvyConventions.plugins.base)
+	id("dev.opensavvy.dokka-mkdocs")
+}
+
+dependencies {
+	// List the 'library' projects
+	// dokka(projects.core)
+}
diff --git a/docs/website/docs/news/index.md b/docs/website/docs/news/index.md
@@ -0,0 +1 @@
+# News
diff --git a/docs/website/docs/news/tags.md b/docs/website/docs/news/tags.md
@@ -0,0 +1 @@
+# News by category
diff --git a/docs/website/generate-news.sh b/docs/website/generate-news.sh
@@ -0,0 +1,20 @@
+#!/usr/bin/env bash
+
+mkdir -p docs/news/posts/releases
+
+for tag in $(git tag --list -n1 | cut -d' ' -f1); do
+	echo "Found tag $tag"
+	tag_file="docs/news/posts/releases/release-$tag.md"
+
+	git for-each-ref \
+		--format="---%ndate:%n  created: %(taggerdate:short)%nslug: v$tag%ntags: [New version]%n---%n%n# $tag • %(subject)%n%n%(contents:body)" \
+		"refs/tags/$tag" \
+		| sed 's/%n/\n/g' \
+		| sed -r "s~\#([0-9]+)~[#\1]($CI_PROJECT_URL/-/issues/\1)~g" \
+		| sed -r "s~([0-9a-f]{4,40})([,\)])~[#\1]($CI_PROJECT_URL/-/commit/\1)\2~g" \
+		| sed -r "s~!([0-9]+)~[!\1]($CI_PROJECT_URL/-/merge_requests/\1)~g" \
+		>"$tag_file"
+
+	echo -e "\n\n<!-- more -->" >>"$tag_file"
+	echo -e "\n\n***\n\n[Browse the documentation for this version]($CI_PROJECT_URL/-/jobs/artifacts/$tag/browse/docs-website?job=mkdocs) • [View release in GitLab]($CI_PROJECT_URL/-/releases/$tag)" >>"$tag_file"
+done
diff --git a/docs/website/mkdocs.yml b/docs/website/mkdocs.yml
@@ -60,14 +60,29 @@ theme:
         name: "Dark theme (click to switch to system)"
 
 plugins:
-  - social
+  # - social # https://github.com/squidfunk/mkdocs-material/issues/7818
   - search
   - privacy
+  - blog:
+      post_excerpt: optional
+      authors: false
+      blog_dir: news
+  - tags:
+      tag_file: news/tags.md
+  - rss:
+      match_path: 'news/posts/.*'
+      date_from_meta:
+        as_creation: date.created
+        as_update: date.updated
+      use_git: false
 
 markdown_extensions:
   - admonition
   - attr_list
+  - def_list
   - md_in_html
+  - footnotes
+  - tables
   - pymdownx.details
   - pymdownx.superfences
   - pymdownx.highlight:
@@ -77,6 +92,8 @@ markdown_extensions:
   - pymdownx.inlinehilite
   - pymdownx.tabbed:
       alternate_style: true
+  - toc:
+      permalink: true
 
 edit_uri: edit/main/docs/website/docs
 
@@ -91,5 +108,12 @@ nav:
 
   - Module2: []
 
-  - Reference:
+# !!! EMBEDDED DOKKA START, DO NOT COMMIT !!! #
+# !!! EMBEDDED DOKKA END, DO NOT COMMIT !!! #
+
+  - Reference (external):
       - reference.md
+
+  - News:
+      - news/index.md
+      - news/tags.md
diff --git a/examples/multi-project/app/build.gradle.kts b/examples/multi-project/app/build.gradle.kts
@@ -1,5 +1,5 @@
 plugins {
-	kotlin("multiplatform") version "1.9.10"
+	kotlin("multiplatform")
 
 	// List of releases: https://gitlab.com/opensavvy/kotlin-vite/-/releases
 	id("dev.opensavvy.vite.kotlin") // version "REPLACE THIS"
diff --git a/examples/multi-project/build.gradle.kts b/examples/multi-project/build.gradle.kts
@@ -1,6 +1,6 @@
 plugins {
 	base
-	kotlin("multiplatform") version "1.9.10" apply false
+	kotlin("multiplatform") version "2.1.20" apply false
 }
 
 repositories {
diff --git a/examples/multi-project/core/build.gradle.kts b/examples/multi-project/core/build.gradle.kts
@@ -1,5 +1,5 @@
 plugins {
-	kotlin("multiplatform") version "1.9.10"
+	kotlin("multiplatform")
 }
 
 repositories {
diff --git a/examples/simple/build.gradle.kts b/examples/simple/build.gradle.kts
@@ -1,5 +1,5 @@
 plugins {
-	kotlin("multiplatform") version "1.9.10"
+	kotlin("multiplatform") version "2.1.20"
 
 	// List of releases: https://gitlab.com/opensavvy/kotlin-vite/-/releases
 	id("dev.opensavvy.vite.kotlin") // version "REPLACE THIS"
diff --git a/gradle.properties b/gradle.properties
@@ -20,3 +20,11 @@ org.gradle.caching=true
 # Configuration on demand allows Gradle to only configure projects which take part in the build.
 # See https://docs.gradle.org/current/userguide/multi_project_configuration_and_execution.html#sec:configuration_on_demand
 org.gradle.configureondemand=true
+
+# Dokka v2
+# See https://kotl.in/dokka-gradle-migration
+org.jetbrains.dokka.experimental.gradle.pluginMode=V2Enabled
+
+# System resource usage
+org.gradle.jvmargs=-Xmx1024m -XX:MaxMetaspaceSize=1024m
+kotlin.daemon.jvmargs=-Xmx1024m -XX:MaxMetaspaceSize=512m
diff --git a/gradle/conventions/settings.gradle.kts b/gradle/conventions/settings.gradle.kts
@@ -45,7 +45,7 @@ pluginManagement {
 }
 
 plugins {
-	id("dev.opensavvy.conventions.settings") version "1.5.2"
+	id("dev.opensavvy.conventions.settings") version "1.6.3"
 }
 
 enableFeaturePreview("TYPESAFE_PROJECT_ACCESSORS")
diff --git a/gradle/templates/template-app/build.gradle.kts b/gradle/templates/template-app/build.gradle.kts
@@ -1,19 +1,18 @@
 plugins {
 	alias(opensavvyConventions.plugins.base)
 	alias(opensavvyConventions.plugins.kotlin.application)
-	application
 }
 
 kotlin {
 	jvm {
-		withJava() // required by the application plugin
+		binaries {
+			executable {
+				mainClass.set("opensavvy.playground.app.MainKt")
+			}
+		}
 	}
 
 	sourceSets.commonMain.dependencies {
 		implementation(projects.gradle.templates.templateLib)
 	}
 }
-
-application {
-	mainClass.set("opensavvy.playground.app.MainKt")
-}
diff --git a/gradle/templates/template-lib/src/commonMain/kotlin/HelloWorld.kt b/gradle/templates/template-lib/src/commonMain/kotlin/HelloWorld.kt
@@ -1,3 +1,6 @@
 package opensavvy.playground.core
 
+/**
+ * A hello world message.
+ */
 const val message = "Hello World!"
diff --git a/settings.gradle.kts b/settings.gradle.kts
@@ -49,10 +49,11 @@ pluginManagement {
 }
 
 plugins {
-	id("dev.opensavvy.conventions.settings") version "1.5.2"
+	id("dev.opensavvy.conventions.settings") version "1.6.3"
 }
 
 include(
+	"docs:website",
 	"gradle:templates:template-app",
 	"gradle:templates:template-lib",
 
diff --git a/vite-base/src/main/kotlin/tasks/ViteExec.kt b/vite-base/src/main/kotlin/tasks/ViteExec.kt
@@ -51,8 +51,8 @@ abstract class ViteExec @Inject constructor(
 	 * Use this property to override which Node installation is used.
 	 * By default, the Node installation used by the Kotlin plugin is used.
 	 */
-	@get:InputFile
-	@get:PathSensitive(PathSensitivity.RELATIVE)
+	@get:Internal // WORKAROUND for https://youtrack.jetbrains.com/issue/KT-78612
+	// Once it's fixed, revert the commit that added this comment
 	abstract val nodePath: RegularFileProperty
 
 	/**
diff --git a/vite-kotlin/src/main/kotlin/tasks/Copy.kt b/vite-kotlin/src/main/kotlin/tasks/Copy.kt
@@ -20,7 +20,7 @@ internal fun createCopyTask(project: Project, name: String, sourceTask: String,
 		group = KotlinVitePlugin.GROUP
 		description = "Prepares the Vite working directory"
 
-		dependsOn("jsPackageJson", ":kotlinNodeJsSetup")
+		dependsOn("jsPackageJson", "kotlinNodeJsSetup")
 
 		from(project.tasks.named(sourceTask))
 		into(destination.map { it.dir("kotlin") })
diff --git a/vite-kotlin/src/main/kotlin/tasks/ViteExecTask.kt b/vite-kotlin/src/main/kotlin/tasks/ViteExecTask.kt
@@ -6,34 +6,60 @@ import opensavvy.gradle.vite.kotlin.viteBuildDevDir
 import opensavvy.gradle.vite.kotlin.viteBuildDistDir
 import opensavvy.gradle.vite.kotlin.viteBuildProdDir
 import org.gradle.api.Project
-import org.gradle.api.file.RegularFile
-import org.jetbrains.kotlin.gradle.targets.js.nodejs.NodeJsRootPlugin.Companion.kotlinNodeJsExtension
-import org.jetbrains.kotlin.gradle.targets.js.npm.NpmProject
+import org.gradle.api.tasks.CacheableTask
+import org.gradle.api.tasks.Internal
+import org.gradle.kotlin.dsl.getByType
+import org.gradle.process.ExecOperations
+import org.jetbrains.kotlin.gradle.dsl.KotlinMultiplatformExtension
+import org.jetbrains.kotlin.gradle.plugin.KotlinCompilation
+import org.jetbrains.kotlin.gradle.targets.js.NpmPackageVersion
+import org.jetbrains.kotlin.gradle.targets.js.RequiredKotlinJsDependency
+import org.jetbrains.kotlin.gradle.targets.js.ir.KotlinJsIrCompilation
+import org.jetbrains.kotlin.gradle.targets.js.nodejs.NodeJsPlugin
+import org.jetbrains.kotlin.gradle.targets.js.npm.RequiresNpmDependencies
 import java.io.File
+import javax.inject.Inject
 
-private fun ViteExec.execConventions() {
-	dependsOn(":kotlinNpmInstall")
-	group = KotlinVitePlugin.GROUP
-
-	val kotlinEnvironment = project.rootProject.kotlinNodeJsExtension
-	nodePath.set(
-		kotlinEnvironment
-			.requireConfigured()
-			.let { RegularFile { File(it.nodeExecutable) } }
-	)
-
-	vitePath.set(
-		kotlinEnvironment
-			.projectPackagesDir.parentFile.resolve(NpmProject.NODE_MODULES)
-			.let { RegularFile { File("$it/vite/bin/vite.js") } }
-	)
+/**
+ * A specialization of [ViteExec] that uses the Kotlin Gradle Plugin to download
+ * Vite.
+ */
+@CacheableTask
+abstract class KotlinViteExec @Inject constructor(
+	process: ExecOperations,
+) : ViteExec(process), RequiresNpmDependencies {
+
+	@get:Internal
+	override val compilation: KotlinJsIrCompilation
+		get() = project.extensions.getByType<KotlinMultiplatformExtension>().js()
+			.compilations.getByName(KotlinCompilation.MAIN_COMPILATION_NAME)
+
+	@get:Internal
+	override val requiredNpmDependencies: Set<RequiredKotlinJsDependency>
+		get() = setOf(NpmPackageVersion("vite", config.version.get()))
+
+	init {
+		dependsOn("kotlinNodeJsSetup", "jsPackageJson", ":kotlinNpmInstall")
+		group = KotlinVitePlugin.GROUP
+
+		nodePath.set {
+			File(NodeJsPlugin.apply(project.rootProject).executable.get())
+		}
+
+		// In theory, we should be able to access the Vite path via:
+		//     File(compilation.npmProject.require("vite"))
+		// However, the configuration cache will initialize all inputs eagerly, and the above line
+		// throws if executed before the :kotlinNpmInstall task. Using the line above thus
+		// results in a build that crashes after a clean build, but works if a :kotlinNpmInstall is executed
+		// by itself first.
+		vitePath.set(project.rootProject.layout.buildDirectory.file("js/node_modules/vite/bin/vite.js"))
+	}
 }
 
 internal fun createExecTasks(project: Project) {
-	project.tasks.register("viteBuild", ViteExec::class.java) {
+	project.tasks.register("viteBuild", KotlinViteExec::class.java) {
 		description = "Builds the production variant of the project"
 		dependsOn("viteConfigureProd", "viteCompileProd")
-		execConventions()
 
 		command.set("build")
 
@@ -42,10 +68,9 @@ internal fun createExecTasks(project: Project) {
 		outputs.dir(project.viteBuildDistDir)
 	}
 
-	project.tasks.register("viteRun", ViteExec::class.java) {
+	project.tasks.register("viteRun", KotlinViteExec::class.java) {
 		description = "Hosts the development variant of the project"
 		dependsOn("viteConfigureDev", "viteCompileDev")
-		execConventions()
 
 		config.root.set(project.viteBuildDevDir.map { it.dir("kotlin") })
 		configurationFile.set(project.viteBuildDevDir.map { it.file("vite.config.js") })

Original file line number	Diff line number	Diff line change
`@@ -21,8 +21,8 @@ plugins {`
`21`	`21`
`22`	`22`	`dependencies {`
`23`	`23`	`// List the 'library' projects`
`24`		`- dokkatoo(projects.viteKotlin)`
`25`		`- dokkatoo(projects.viteBase)`
	`24`	`+ dokka(projects.viteKotlin)`
	`25`	`+ dokka(projects.viteBase)`
`26`	`26`	`}`
`27`	`27`
`28`	`28`	`// region Check the users of the project didn't forget to rename the group`
-Original file line number
+Diff line change
@@ @@ -1 +1,4 @@ @@
 .cache
++
 +# Dokka output
 +api/