Renamed and refactored some tasks in KotlinJsModule

Author: lefou

kotlinlib/src/mill/kotlinlib/js/KotlinJsModule.scala

@@ -11,26 +11,25 @@ import mill.testrunner.TestResult
 import mill.util.Jvm
 import mill.{Args, T}
 import sbt.testing.Status
-import upickle.default.{macroRW, ReadWriter => RW}
-
+import upickle.default.{macroRW, ReadWriter as RW}
 import java.io.{File, FileNotFoundException}
 import java.util.zip.ZipFile
+
 import scala.xml.XML
 
 /**
  * This module is very experimental. Don't use it, it is still under the development, APIs can change.
  */
+@mill.api.experimental
 trait KotlinJsModule extends KotlinModule { outer =>
 
   // region Kotlin/JS configuration
 
   /** The kind of JS module generated by the compiler */
-  // FIXME: Rename to kotlinKsModuleKind
-  def moduleKind: T[ModuleKind] = ModuleKind.PlainModule
+  def kotlinJsModuleKind: T[ModuleKind] = ModuleKind.PlainModule
 
   /** Call main function upon execution. */
-  // FIXME: Rename to kotlinJsCallMain
-  def callMain: T[Boolean] = true
+  def kotlinJsCallMain: T[Boolean] = true
 
   /** Binary type (if any) to produce. If [[BinaryKind.Executable]] is selected, then .js file(s) will be produced. */
   def kotlinJsBinaryKind: T[Option[BinaryKind]] = Some(BinaryKind.Executable)
@@ -51,8 +50,7 @@ trait KotlinJsModule extends KotlinModule { outer =>
   def kotlinJsSourceMapNamesPolicy: T[SourceMapNamesPolicy] = SourceMapNamesPolicy.No
 
   /** Split generated .js per-module. Effective only if [[BinaryKind.Executable]] is selected. */
-  // FIXME: rename to kotlinJsSplitPerModule
-  def splitPerModule: T[Boolean] = true
+  def kotlinJsSplitPerModule: T[Boolean] = true
 
   /** Run target for the executable (if [[BinaryKind.Executable]] is set). */
   def kotlinJsRunTarget: T[Option[RunTarget]] = None
@@ -66,21 +64,26 @@ trait KotlinJsModule extends KotlinModule { outer =>
   }
 
   override def mandatoryIvyDeps: T[Seq[Dep]] = Task {
-    Seq(
-      ivy"org.jetbrains.kotlin:kotlin-stdlib-js:${kotlinVersion()}"
-    )
+    super.mandatoryIvyDeps()
+      // TODO: find source or docs, why this is the correct behavior
+      // Filter out the non-js kotlin-stdlib
+      .filterNot(d => d.organization == "org.jetbrains.kotlin" && d.name == "kotlin-stdlib") ++
+      Seq(
+        ivy"org.jetbrains.kotlin:kotlin-stdlib-js:${kotlinVersion()}"
+      )
   }
 
   override def transitiveCompileClasspath: T[Seq[PathRef]] = Task {
-    Task.traverse(transitiveModuleCompileModuleDeps)(m =>
-      Task.Anon {
-        val transitiveModuleArtifactPath =
-          if (m.isInstanceOf[KotlinJsModule] && m != friendModule.orNull) {
-            m.asInstanceOf[KotlinJsModule].klib()
-          } else m.compile().classes
-        m.localCompileClasspath() ++ Seq(transitiveModuleArtifactPath)
-      }
-    )().flatten
+    Task.traverse(transitiveModuleCompileModuleDeps) {
+      case js: KotlinJsModule if js != kotlinJsFriendModule.orNull =>
+        Task.Anon {
+          js.localCompileClasspath() ++ Seq(js.klib())
+        }
+      case m => Task.Anon {
+          // this is the super-implementation
+          m.localCompileClasspath() ++ Seq(m.compile().classes)
+        }
+    }().flatten
   }
 
   /**
@@ -92,12 +95,12 @@ trait KotlinJsModule extends KotlinModule { outer =>
       irClasspath = None,
       allKotlinSourceFiles = allKotlinSourceFiles(),
       librariesClasspath = compileClasspath(),
-      callMain = callMain(),
-      moduleKind = moduleKind(),
+      callMain = kotlinJsCallMain(),
+      moduleKind = kotlinJsModuleKind(),
       produceSourceMaps = kotlinJsSourceMap(),
       sourceMapEmbedSourcesKind = kotlinJsSourceMapEmbedSources(),
       sourceMapNamesPolicy = kotlinJsSourceMapNamesPolicy(),
-      splitPerModule = splitPerModule(),
+      splitPerModule = kotlinJsSplitPerModule(),
       esTarget = kotlinJsESTarget(),
       kotlinVersion = kotlinVersion(),
       destinationRoot = Task.dest,
@@ -112,10 +115,10 @@ trait KotlinJsModule extends KotlinModule { outer =>
     Task.Command { run(args)() }
 
   override def run(args: Task[Args] = Task.Anon(Args())): Command[Unit] = Task.Command {
-    runJsBinary(
+    kotlinJsRunBinary(
       args = args(),
       binaryKind = kotlinJsBinaryKind(),
-      moduleKind = moduleKind(),
+      moduleKind = kotlinJsModuleKind(),
       binaryDir = linkBinary().classes.path,
       runTarget = kotlinJsRunTarget(),
       artifactId = artifactId(),
@@ -136,9 +139,9 @@ trait KotlinJsModule extends KotlinModule { outer =>
       mill.api.Result.Failure("runMain is not supported in Kotlin/JS.")
     }
 
-  protected[js] def friendModule: Option[KotlinJsModule] = None
+  protected[js] def kotlinJsFriendModule: Option[KotlinJsModule] = None
 
-  protected[js] def runJsBinary(
+  protected[js] def kotlinJsRunBinary(
       args: Args = Args(),
       binaryKind: Option[BinaryKind],
       moduleKind: ModuleKind,
@@ -192,12 +195,12 @@ trait KotlinJsModule extends KotlinModule { outer =>
       allKotlinSourceFiles = allKotlinSourceFiles(),
       irClasspath = None,
       librariesClasspath = compileClasspath(),
-      callMain = callMain(),
-      moduleKind = moduleKind(),
+      callMain = kotlinJsCallMain(),
+      moduleKind = kotlinJsModuleKind(),
       produceSourceMaps = kotlinJsSourceMap(),
       sourceMapEmbedSourcesKind = kotlinJsSourceMapEmbedSources(),
       sourceMapNamesPolicy = kotlinJsSourceMapNamesPolicy(),
-      splitPerModule = splitPerModule(),
+      splitPerModule = kotlinJsSplitPerModule(),
       esTarget = kotlinJsESTarget(),
       kotlinVersion = kotlinVersion(),
       destinationRoot = Task.dest,
@@ -219,12 +222,12 @@ trait KotlinJsModule extends KotlinModule { outer =>
       allKotlinSourceFiles = Seq.empty,
       // classpath of libraries to be used to run this module's code
       librariesClasspath = upstreamAssemblyClasspath(),
-      callMain = callMain(),
-      moduleKind = moduleKind(),
+      callMain = kotlinJsCallMain(),
+      moduleKind = kotlinJsModuleKind(),
       produceSourceMaps = kotlinJsSourceMap(),
       sourceMapEmbedSourcesKind = kotlinJsSourceMapEmbedSources(),
       sourceMapNamesPolicy = kotlinJsSourceMapNamesPolicy(),
-      splitPerModule = splitPerModule(),
+      splitPerModule = kotlinJsSplitPerModule(),
       esTarget = kotlinJsESTarget(),
       kotlinVersion = kotlinVersion(),
       destinationRoot = Task.dest,
@@ -513,16 +516,16 @@ trait KotlinJsModule extends KotlinModule { outer =>
 
     override def kotlinJsRunTarget: T[Option[RunTarget]] = outer.kotlinJsRunTarget()
 
-    override def moduleKind: T[ModuleKind] = ModuleKind.PlainModule
+    override def kotlinJsModuleKind: T[ModuleKind] = ModuleKind.PlainModule
 
-    override def splitPerModule = false
+    override def kotlinJsSplitPerModule = false
 
     override def testLocal(args: String*): Command[(String, Seq[TestResult])] =
       Task.Command {
         this.testForked(args*)()
       }
 
-    override protected[js] def friendModule: Option[KotlinJsModule] = Some(outer)
+    override protected[js] def kotlinJsFriendModule: Option[KotlinJsModule] = Some(outer)
 
     override protected def testTask(
         args: Task[Seq[String]],
@@ -534,7 +537,7 @@ trait KotlinJsModule extends KotlinModule { outer =>
           "Cannot run Kotlin/JS tests, because run target is not specified."
         )
       }
-      runJsBinary(
+      kotlinJsRunBinary(
         // TODO add runner to be able to use test selector
         args = Args(args() ++ Seq(
           // TODO this is valid only for the NodeJS target. Once browser support is
@@ -550,7 +553,7 @@ trait KotlinJsModule extends KotlinModule { outer =>
           s"output=${testReportXml().getOrElse(defaultXmlReportName)}"
         )),
         binaryKind = Some(BinaryKind.Executable),
-        moduleKind = moduleKind(),
+        moduleKind = kotlinJsModuleKind(),
         binaryDir = linkBinary().classes.path,
         runTarget = runTarget,
         artifactId = artifactId(),

kotlinlib/test/src/mill/kotlinlib/js/KotlinJsLinkTests.scala

@@ -13,7 +13,7 @@ object KotlinJsLinkTests extends TestSuite {
 
   trait KotlinJsCrossModule extends KotlinJsModule with Cross.Module[Boolean] {
     override def kotlinVersion = KotlinJsLinkTests.kotlinVersion
-    override def splitPerModule: T[Boolean] = crossValue
+    override def kotlinJsSplitPerModule: T[Boolean] = crossValue
     override def kotlinJsBinaryKind: T[Option[BinaryKind]] = Some(BinaryKind.Executable)
     override def moduleDeps = Seq(module.bar)
     // drop cross-value

kotlinlib/test/src/mill/kotlinlib/js/KotlinJsNodeRunTests.scala

@@ -24,7 +24,7 @@ object KotlinJsNodeRunTests extends TestSuite {
 
       def kotlinVersion = KotlinJsNodeRunTests.kotlinVersion
 
-      override def moduleKind = crossValue2 match {
+      override def kotlinJsModuleKind = crossValue2 match {
         case "no" => ModuleKind.NoModule
         case "plain" => ModuleKind.PlainModule
         case "es" => ModuleKind.ESModule
@@ -34,7 +34,7 @@ object KotlinJsNodeRunTests extends TestSuite {
       }
 
       override def moduleDeps = Seq(module.bar)
-      override def splitPerModule = crossValue
+      override def kotlinJsSplitPerModule = crossValue
       override def kotlinJsRunTarget = Some(RunTarget.Node)
     }