Add SkippedSupport opt-in annotation

drewhamilton · Dec 11, 2024 · cc619fd · cc619fd
1 parent 1884e8c
commit cc619fd
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 1 deletion.
diff --git a/poko-annotations/src/commonMain/kotlin/dev/drewhamilton/poko/Skipped.kt b/poko-annotations/src/commonMain/kotlin/dev/drewhamilton/poko/Skipped.kt
@@ -4,8 +4,9 @@ package dev.drewhamilton.poko
  * Primary constructor properties marked with this annotation will be omitted from generated
  * `equals`, `hashCode`, and `toString` functions, as if they were not properties.
  *
- * This annotation has no effect on properties declared outside of the primary constructor.
+ * This annotation has no effect on properties declared outside the primary constructor.
  */
+@SkippedSupport
 @Retention(AnnotationRetention.SOURCE)
 @Target(AnnotationTarget.PROPERTY)
 public annotation class Skipped
diff --git a/.../drewhamilton/poko/ArrayContentSupport.kt → ...dev/drewhamilton/poko/optInAnnotations.kt b/.../drewhamilton/poko/ArrayContentSupport.kt → ...dev/drewhamilton/poko/optInAnnotations.kt
@@ -1,5 +1,12 @@
 package dev.drewhamilton.poko
 
+/**
+ * Denotes an experimental API that enables the ability to skip a Poko class primary constructor property when
+ * generating Poko functions.
+ */
+@RequiresOptIn
+public annotation class SkippedSupport
+
 /**
  * Denotes an API that enables support for array content reading, which is experimental and may
  * change or break.

diff --git a/poko-tests-without-k2/src/commonMain/kotlin/poko/SkippedProperty.kt b/poko-tests-without-k2/src/commonMain/kotlin/poko/SkippedProperty.kt
@@ -2,7 +2,9 @@ package poko
 
 import dev.drewhamilton.poko.Poko
 import dev.drewhamilton.poko.Skipped
+import dev.drewhamilton.poko.SkippedSupport
 
+@OptIn(SkippedSupport::class)
 @Suppress("Unused")
 @Poko class SkippedProperty(
     val id: String,

diff --git a/poko-tests/src/commonMain/kotlin/poko/SkippedProperty.kt b/poko-tests/src/commonMain/kotlin/poko/SkippedProperty.kt
@@ -2,7 +2,9 @@ package poko
 
 import dev.drewhamilton.poko.Poko
 import dev.drewhamilton.poko.Skipped
+import dev.drewhamilton.poko.SkippedSupport
 
+@OptIn(SkippedSupport::class)
 @Suppress("Unused")
 @Poko class SkippedProperty(
     val id: String,