Generate annotation cleanup

kordlib · Aug 21, 2023 · 2c772f7 · 2c772f7
1 parent 54f8cc9
commit 2c772f7
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 14 deletions.
diff --git a/gateway/src/commonMain/kotlin/Intents.kt b/gateway/src/commonMain/kotlin/Intents.kt
@@ -28,7 +28,7 @@
             """,
         ),
         Entry(
-            "GuildMembers", shift = 1, additionalOptInMarkerAnnotations = [privilegedIntentAnnotation],
+            "GuildMembers", shift = 1, requiresOptInAnnotations = [privilegedIntentAnnotation],
             kDoc = """
                 Enables the following events:
                 - [GuildMemberAdd]
@@ -87,7 +87,7 @@
             """,
         ),
         Entry(
-            "GuildPresences", shift = 8, additionalOptInMarkerAnnotations = [privilegedIntentAnnotation],
+            "GuildPresences", shift = 8, requiresOptInAnnotations = [privilegedIntentAnnotation],
             kDoc = """
                 Enables the following events:
                 - [PresenceUpdate]
@@ -148,7 +148,7 @@
             """,
         ),
         Entry(
-            "MessageContent", shift = 15, additionalOptInMarkerAnnotations = [privilegedIntentAnnotation],
+            "MessageContent", shift = 15, requiresOptInAnnotations = [privilegedIntentAnnotation],
             kDoc = "[MessageContent] is a unique [privileged intent][PrivilegedIntent] that isn't directly " +
                 "associated with any Gateway [event][Event]s. Instead, access to [MessageContent] permits your app " +
                 "to receive message content data across the APIs.\n\nFor example, the [content][dev.kord.common." +

diff --git a/ksp-annotations/src/commonMain/kotlin/Generate.kt b/ksp-annotations/src/commonMain/kotlin/Generate.kt
@@ -1,7 +1,7 @@
 package dev.kord.ksp
 
-import dev.kord.ksp.Generate.*
 import dev.kord.ksp.Generate.EntityType.*
+import dev.kord.ksp.Generate.Entry
 import kotlin.annotation.AnnotationRetention.SOURCE
 import kotlin.annotation.AnnotationTarget.FILE
 
@@ -46,7 +46,7 @@ annotation class Generate(
         val kDoc: String = "",
         /** [Deprecated] annotation to mark this entry as deprecated. */
         val deprecated: Deprecated = Deprecated(""),
-        /** Additional annotations to add to this entry. */
-        val additionalOptInMarkerAnnotations: Array<String> = [],
+        /** [RequiresOptIn] annotations to add to this entry. */
+        val requiresOptInAnnotations: Array<String> = [],
     )
 }
diff --git a/ksp-processors/src/main/kotlin/generation/GenerationEntity.kt b/ksp-processors/src/main/kotlin/generation/GenerationEntity.kt
@@ -4,8 +4,9 @@ import com.google.devtools.ksp.processing.KSPLogger
 import com.google.devtools.ksp.symbol.KSAnnotation
 import dev.kord.ksp.AnnotationArguments.Companion.arguments
 import dev.kord.ksp.Generate
-import dev.kord.ksp.Generate.*
+import dev.kord.ksp.Generate.EntityType
 import dev.kord.ksp.Generate.EntityType.*
+import dev.kord.ksp.Generate.Entry
 import dev.kord.ksp.generation.GenerationEntity.BitFlags
 import dev.kord.ksp.generation.GenerationEntity.KordEnum
 import kotlin.reflect.KProperty1
@@ -45,7 +46,7 @@ internal sealed class GenerationEntity(
         val kDoc: String?,
         val value: Comparable<*>,
         val deprecated: Deprecated?,
-        val additionalOptInMarkerAnnotations: List<String>,
+        val requiresOptInAnnotations: List<String>,
     )
 }
 
@@ -72,8 +73,7 @@ internal fun Generate.toGenerationEntityOrNull(logger: KSPLogger, annotation: KS
         INT_FLAGS, BIT_SET_FLAGS -> true
     }
 
-    val entries = entries zip args[Generate::entries]!!
-    val mappedEntries = entries.mapNotNull { (entry, annotation) ->
+    val mappedEntries = (entries zip args[Generate::entries]!!).mapNotNull { (entry, annotation) ->
         entry.toGenerationEntityEntryOrNull(entityType, logger, annotation)
     }
 
@@ -153,10 +153,10 @@ private fun Entry.toGenerationEntityEntryOrNull(
             .run { Deprecated(message, replaceWith.run { ReplaceWith(expression, *imports) }, level) }
             .takeUnless { args.isDefault(Entry::deprecated) },
         // because of https://github.com/google/ksp/pull/1330#issuecomment-1616066129
-        if (args.isDefault(Entry::additionalOptInMarkerAnnotations)) {
+        if (args.isDefault(Entry::requiresOptInAnnotations)) {
             emptyList()
         } else {
-            additionalOptInMarkerAnnotations.toList()
+            requiresOptInAnnotations.toList()
         },
     )
 }
diff --git a/ksp-processors/src/main/kotlin/generation/shared/SharedContent.kt b/ksp-processors/src/main/kotlin/generation/shared/SharedContent.kt
@@ -30,7 +30,7 @@ internal fun TypeSpec.Builder.addEntityEntries() {
             entry.kDoc?.let { addKdoc(it) }
             @OptIn(DelicateKotlinPoetApi::class) // `AnnotationSpec.get` is ok for `Deprecated`
             entry.deprecated?.let { addAnnotation(it) }
-            entry.additionalOptInMarkerAnnotations.forEach { annotation ->
+            entry.requiresOptInAnnotations.forEach { annotation ->
                 addAnnotation(ClassName.bestGuess(annotation))
             }
             addModifiers(PUBLIC)

diff --git a/ksp-processors/src/main/kotlin/generation/shared/Util.kt b/ksp-processors/src/main/kotlin/generation/shared/Util.kt
@@ -18,7 +18,7 @@ internal val GenerationEntity.Entry.nameWithSuppressedDeprecation
 context(GenerationContext)
 internal fun Annotatable.Builder<*>.addEntryOptIns() {
     val optIns = entriesDistinctByValue
-        .flatMap { it.additionalOptInMarkerAnnotations }
+        .flatMap { it.requiresOptInAnnotations }
         .distinct()
         .map { name -> CodeBlock.of("%T::class", ClassName.bestGuess(name)) }
         .joinToCode()