Make the kotlinpoet module multi-platform and add source set configuration for the JS and wasmJs platforms

docs/changelog.md

@@ -8,6 +8,7 @@ Change Log
 * Fix: Preserve nullability in `KSType.toClassName()`. (#1956)
 * New: Add `KSTypeAlias.toClassName()`. (#1956)
 * New: Add `KSType.toClassNameOrNull()`. (#1956)
+* New: Make the kotlinpoet module multi-platform and add source set configuration for the JS and wasmJs platforms. (#1959)
 
 ## Version 1.18.1
 

kotlinpoet/api/kotlinpoet.api

@@ -434,6 +434,9 @@ public final class com/squareup/kotlinpoet/Import : java/lang/Comparable {
 	public fun toString ()Ljava/lang/String;
 }
 
+public abstract interface annotation class com/squareup/kotlinpoet/JvmTypeAliasKotlinPoetApi : java/lang/annotation/Annotation {
+}
+
 public final class com/squareup/kotlinpoet/KModifier : java/lang/Enum {
 	public static final field ABSTRACT Lcom/squareup/kotlinpoet/KModifier;
 	public static final field ACTUAL Lcom/squareup/kotlinpoet/KModifier;
@@ -1253,6 +1256,15 @@ public final class com/squareup/kotlinpoet/jvm/JvmAnnotations {
 	public static final fun volatile (Lcom/squareup/kotlinpoet/PropertySpec$Builder;)Lcom/squareup/kotlinpoet/PropertySpec$Builder;
 }
 
+public final class com/squareup/kotlinpoet/jvm/alias/JvmClasses {
+	public static final fun getKotlin (Ljava/lang/Class;)Lkotlin/reflect/KClass;
+	public static final fun typeName (Ljava/lang/reflect/Type;)Ljava/lang/String;
+}
+
+public final class com/squareup/kotlinpoet/jvm/alias/JvmPath_jvmKt {
+	public static final fun toJvmFile (Ljava/nio/file/Path;)Ljava/io/File;
+}
+
 public final class com/squareup/kotlinpoet/tags/TypeAliasTag {
 	public fun <init> (Lcom/squareup/kotlinpoet/TypeName;)V
 	public final fun getAbbreviatedType ()Lcom/squareup/kotlinpoet/TypeName;

kotlinpoet/build.gradle.kts

@@ -14,6 +14,7 @@
  * limitations under the License.
  */
 import org.jetbrains.kotlin.gradle.ExperimentalKotlinGradlePluginApi
+import org.jetbrains.kotlin.gradle.targets.js.dsl.ExperimentalWasmDsl
 
 plugins {
   kotlin("multiplatform")
@@ -23,11 +24,12 @@ spotless {
   kotlin {
     targetExclude(
       // Non-Square licensed files
-      "src/commonMain/kotlin/com/squareup/kotlinpoet/ClassName.kt",
-      "src/commonTest/kotlin/com/squareup/kotlinpoet/AbstractTypesTest.kt",
-      "src/commonTest/kotlin/com/squareup/kotlinpoet/ClassNameTest.kt",
-      "src/commonTest/kotlin/com/squareup/kotlinpoet/TypesEclipseTest.kt",
-      "src/commonTest/kotlin/com/squareup/kotlinpoet/TypesTest.kt",
+      "src/*Main/kotlin/com/squareup/kotlinpoet/ClassName.kt",
+      "src/*Main/kotlin/com/squareup/kotlinpoet/ClassName.*.kt",
+      "src/*Test/kotlin/com/squareup/kotlinpoet/AbstractTypesTest.kt",
+      "src/*Test/kotlin/com/squareup/kotlinpoet/ClassNameTest.kt",
+      "src/*Test/kotlin/com/squareup/kotlinpoet/TypesEclipseTest.kt",
+      "src/*Test/kotlin/com/squareup/kotlinpoet/TypesTest.kt",
     )
   }
 }
@@ -37,19 +39,46 @@ kotlin {
     withJava()
   }
 
+  js {
+    nodejs {
+      testTask {
+        useMocha()
+      }
+    }
+    binaries.library()
+  }
+
+  @OptIn(ExperimentalWasmDsl::class)
+  wasmJs {
+    nodejs {
+      testTask {
+        useMocha()
+      }
+    }
+    binaries.library()
+  }
+
   @OptIn(ExperimentalKotlinGradlePluginApi::class)
   compilerOptions {
     allWarningsAsErrors.set(true)
     optIn.add("com.squareup.kotlinpoet.DelicateKotlinPoetApi")
+    freeCompilerArgs.add("-Xexpect-actual-classes")
   }
 
   sourceSets {
-    val commonMain by getting {
+    commonMain {
       dependencies {
         implementation(libs.kotlin.reflect)
       }
     }
-    val commonTest by getting {
+
+    commonTest {
+      dependencies {
+        implementation(kotlin("test"))
+      }
+    }
+
+    jvmTest {
       dependencies {
         implementation(libs.kotlin.junit)
         implementation(libs.truth)
@@ -62,6 +91,17 @@ kotlin {
         implementation(libs.kotlin.compilerEmbeddable)
       }
     }
+
+    val nonJvmMain by creating {
+      dependsOn(commonMain.get())
+    }
+
+    jsMain {
+      dependsOn(nonJvmMain)
+    }
+    wasmJsMain {
+      dependsOn(nonJvmMain)
+    }
   }
 }
 

kotlinpoet/gradle.properties

@@ -2,3 +2,4 @@ POM_ARTIFACT_ID=kotlinpoet
 POM_NAME=KotlinPoet
 POM_DESCRIPTION=Use beautiful Kotlin code to generate beautiful Kotlin code.
 POM_PACKAGING=jar
+kotlin.mpp.applyDefaultHierarchyTemplate=false

kotlinpoet/src/commonMain/kotlin/com/squareup/kotlinpoet/Annotatable.kt

@@ -15,6 +15,7 @@
  */
 package com.squareup.kotlinpoet
 
+import com.squareup.kotlinpoet.jvm.alias.JvmClass
 import kotlin.reflect.KClass
 
 /** A spec or type which can be annotated. */
@@ -42,7 +43,7 @@ public interface Annotatable {
       message = "Java reflection APIs don't give complete information on Kotlin types. Consider " +
         "using the kotlinpoet-metadata APIs instead.",
     )
-    public fun addAnnotation(annotation: Class<*>): T = addAnnotation(annotation.asClassName())
+    public fun addAnnotation(annotation: JvmClass<*>): T = addAnnotation(annotation.asClassName())
 
     public fun addAnnotation(annotation: KClass<*>): T = addAnnotation(annotation.asClassName())
   }

kotlinpoet/src/commonMain/kotlin/com/squareup/kotlinpoet/AnnotationSpec.kt

@@ -13,17 +13,18 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+@file:JvmName("AnnotationSpecs")
+@file:JvmMultifileClass
+
 package com.squareup.kotlinpoet
 
-import java.lang.reflect.Array
-import java.util.Objects
-import javax.lang.model.element.AnnotationMirror
-import javax.lang.model.element.AnnotationValue
-import javax.lang.model.element.TypeElement
-import javax.lang.model.element.VariableElement
-import javax.lang.model.type.TypeMirror
-import javax.lang.model.util.SimpleAnnotationValueVisitor8
+import com.squareup.kotlinpoet.jvm.alias.JvmAnnotationMirror
+import com.squareup.kotlinpoet.jvm.alias.JvmClass
 import kotlin.LazyThreadSafetyMode.NONE
+import kotlin.jvm.JvmMultifileClass
+import kotlin.jvm.JvmName
+import kotlin.jvm.JvmOverloads
+import kotlin.jvm.JvmStatic
 import kotlin.reflect.KClass
 
 /** A generated annotation on a declaration. */
@@ -98,7 +99,7 @@ public class AnnotationSpec private constructor(
   override fun equals(other: Any?): Boolean {
     if (this === other) return true
     if (other == null) return false
-    if (javaClass != other.javaClass) return false
+    if (this::class != other::class) return false
     return toString() == other.toString()
   }
 
@@ -146,8 +147,8 @@ public class AnnotationSpec private constructor(
        * `%L` for other types.
        */
       internal fun memberForValue(value: Any) = when (value) {
-        is Class<*> -> CodeBlock.of("%T::class", value)
-        is Enum<*> -> CodeBlock.of("%T.%L", value.javaClass, value.name)
+        is JvmClass<*> -> CodeBlock.of("%T::class", value)
+        is Enum<*> -> resolveEnumValueCodeBlock(value)
         is String -> CodeBlock.of("%S", value)
         is Float -> CodeBlock.of("%Lf", value)
         is Char -> CodeBlock.of("'%L'", characterLiteralWithoutSingleQuotes(value))
@@ -156,37 +157,6 @@ public class AnnotationSpec private constructor(
     }
   }
 
-  /**
-   * Annotation value visitor adding members to the given builder instance.
-   */
-  @OptIn(DelicateKotlinPoetApi::class)
-  private class Visitor(
-    val builder: CodeBlock.Builder,
-  ) : SimpleAnnotationValueVisitor8<CodeBlock.Builder, String>(builder) {
-
-    override fun defaultAction(o: Any, name: String) =
-      builder.add(Builder.memberForValue(o))
-
-    override fun visitAnnotation(a: AnnotationMirror, name: String) =
-      builder.add("%L", get(a))
-
-    override fun visitEnumConstant(c: VariableElement, name: String) =
-      builder.add("%T.%L", c.asType().asTypeName(), c.simpleName)
-
-    override fun visitType(t: TypeMirror, name: String) =
-      builder.add("%T::class", t.asTypeName())
-
-    override fun visitArray(values: List<AnnotationValue>, name: String): CodeBlock.Builder {
-      builder.add("arrayOf(⇥⇥")
-      values.forEachIndexed { index, value ->
-        if (index > 0) builder.add(", ")
-        value.accept(this, name)
-      }
-      builder.add("⇤⇤)")
-      return builder
-    }
-  }
-
   public companion object {
     @DelicateKotlinPoetApi(
       message = "Java reflection APIs don't give complete information on Kotlin types. Consider " +
@@ -198,63 +168,16 @@ public class AnnotationSpec private constructor(
       annotation: Annotation,
       includeDefaultValues: Boolean = false,
     ): AnnotationSpec {
-      try {
-        @Suppress("PLATFORM_CLASS_MAPPED_TO_KOTLIN")
-        val javaAnnotation = annotation as java.lang.annotation.Annotation
-        val builder = builder(javaAnnotation.annotationType())
-          .tag(annotation)
-        val methods = annotation.annotationType().declaredMethods.sortedBy { it.name }
-        for (method in methods) {
-          val value = method.invoke(annotation)
-          if (!includeDefaultValues) {
-            if (Objects.deepEquals(value, method.defaultValue)) {
-              continue
-            }
-          }
-          val member = CodeBlock.builder()
-          member.add("%L = ", method.name)
-          if (value.javaClass.isArray) {
-            member.add("arrayOf(⇥⇥")
-            for (i in 0..<Array.getLength(value)) {
-              if (i > 0) member.add(", ")
-              member.add(Builder.memberForValue(Array.get(value, i)))
-            }
-            member.add("⇤⇤)")
-            builder.addMember(member.build())
-            continue
-          }
-          if (value is Annotation) {
-            member.add("%L", get(value))
-            builder.addMember(member.build())
-            continue
-          }
-          member.add("%L", Builder.memberForValue(value))
-          builder.addMember(member.build())
-        }
-        return builder.build()
-      } catch (e: Exception) {
-        throw RuntimeException("Reflecting $annotation failed!", e)
-      }
+      return doGet(annotation, includeDefaultValues)
     }
 
     @DelicateKotlinPoetApi(
       message = "Mirror APIs don't give complete information on Kotlin types. Consider using" +
         " the kotlinpoet-metadata APIs instead.",
     )
     @JvmStatic
-    public fun get(annotation: AnnotationMirror): AnnotationSpec {
-      val element = annotation.annotationType.asElement() as TypeElement
-      val builder = builder(element.asClassName()).tag(annotation)
-      for (executableElement in annotation.elementValues.keys) {
-        val member = CodeBlock.builder()
-        val visitor = Visitor(member)
-        val name = executableElement.simpleName.toString()
-        member.add("%L = ", name)
-        val value = annotation.elementValues[executableElement]!!
-        value.accept(visitor, name)
-        builder.addMember(member.build())
-      }
-      return builder.build()
+    public fun get(annotation: JvmAnnotationMirror): AnnotationSpec {
+      return doGet(annotation)
     }
 
     @JvmStatic public fun builder(type: ClassName): Builder = Builder(type)
@@ -266,10 +189,19 @@ public class AnnotationSpec private constructor(
         "using the kotlinpoet-metadata APIs instead.",
     )
     @JvmStatic
-    public fun builder(type: Class<out Annotation>): Builder =
+    public fun builder(type: JvmClass<out Annotation>): Builder =
       builder(type.asClassName())
 
     @JvmStatic public fun builder(type: KClass<out Annotation>): Builder =
       builder(type.asClassName())
   }
 }
+
+internal expect fun resolveEnumValueCodeBlock(value: Enum<*>): CodeBlock
+
+internal expect fun doGet(
+  annotation: Annotation,
+  includeDefaultValues: Boolean,
+): AnnotationSpec
+
+internal expect fun doGet(annotation: JvmAnnotationMirror): AnnotationSpec