Adding an annotation to flag experimental features. (#107)

Fixes #106
Kantis · Feb 17, 2024 · 73f9ee3 · 73f9ee3
1 parent 7d40223
commit 73f9ee3
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 0 deletions.
diff --git a/ks3-core/api/ks3-core.api b/ks3-core/api/ks3-core.api
@@ -1,3 +1,6 @@
+public abstract interface annotation class io/ks3/core/ExperimentalKs3 : java/lang/annotation/Annotation {
+}
+
 public abstract interface annotation class io/ks3/core/Ks3Internal : java/lang/annotation/Annotation {
 }
 
diff --git a/ks3-core/src/commonMain/kotlin/io/ks3/core/ExperimentalKs3.kt b/ks3-core/src/commonMain/kotlin/io/ks3/core/ExperimentalKs3.kt
@@ -0,0 +1,6 @@
+package io.ks3.core
+
+@RequiresOptIn(level = RequiresOptIn.Level.WARNING, message = "This API is experimental and is prone to change in the future.")
+@MustBeDocumented
+@Retention(value = AnnotationRetention.BINARY)
+annotation class ExperimentalKs3
diff --git a/ks3-standard/build.gradle.kts b/ks3-standard/build.gradle.kts
@@ -39,6 +39,7 @@ kotlin {
    sourceSets {
       commonMain {
          dependencies {
+            implementation(projects.ks3Core)
             implementation(libs.kotlinxSerialization.core)
             implementation(libs.kotlinxSerialization.json)
          }

diff --git a/ks3-standard/src/commonMain/kotlin/io/ks3/standard/LenientJsonArraySerializer.kt b/ks3-standard/src/commonMain/kotlin/io/ks3/standard/LenientJsonArraySerializer.kt
@@ -1,5 +1,6 @@
 package io.ks3.standard
 
+import io.ks3.core.ExperimentalKs3
 import kotlinx.serialization.KSerializer
 import kotlinx.serialization.SerializationException
 import kotlinx.serialization.SerializationStrategy
@@ -22,6 +23,7 @@ import kotlinx.serialization.serializer
  * println(numbers) // > [1, 2, 3, 5]
  * ```
  */
+@ExperimentalKs3
 inline fun <reified T> lenientJsonArraySerializer(explicitElementSerializer: KSerializer<T>? = null) =
    object : KSerializer<List<T>> {
       private val elementSerializer = explicitElementSerializer ?: serializer<T>()