Clean up MillBuildRootModule codegen (#3424)

Move a bunch of logic into helper methods in order to minimize the complexity of the codegen This PR shouldn't have any runtime impact, just a bit of internal tidying up
com-lihaoyi · Aug 27, 2024 · 12194ac · 12194ac
1 parent 2f93387
commit 12194ac
Show file tree

Hide file tree

Showing 2 changed files with 85 additions and 71 deletions.
diff --git a/main/src/mill/main/RootModule.scala b/main/src/mill/main/RootModule.scala
@@ -41,6 +41,12 @@ object RootModule {
         millFile0,
         Caller(null)
       ) with mill.main.MainModule {
+    def this(segments: String*)(implicit
+        baseModuleInfo: RootModule.Info,
+        millModuleEnclosing0: sourcecode.Enclosing,
+        millModuleLine0: sourcecode.Line,
+        millFile0: sourcecode.File
+    ) = this(Some(Segments.labels(segments: _*)))
 
     // Make BaseModule take the `millDiscover` as an implicit param, rather than
     // defining it itself. That is so we can define it externally in the wrapper
@@ -64,7 +70,12 @@ object RootModule {
         millFile0,
         Caller(null)
       ) {
-
+    def this(segments: String*)(implicit
+        baseModuleInfo: RootModule.Info,
+        millModuleEnclosing0: sourcecode.Enclosing,
+        millModuleLine0: sourcecode.Line,
+        millFile0: sourcecode.File
+    ) = this(Some(Segments.labels(segments: _*)))
     object interp extends Interp
 
     override lazy val millDiscover: Discover[this.type] =

diff --git a/runner/src/mill/runner/MillBuildRootModule.scala b/runner/src/mill/runner/MillBuildRootModule.scala
@@ -316,87 +316,90 @@ object MillBuildRootModule {
       val relative = scriptSource.path.relativeTo(base)
       val dest = targetDest / FileImportGraph.fileImportToSegments(base, scriptSource.path, false)
 
-      val pkg = FileImportGraph.fileImportToSegments(base, scriptSource.path, true).dropRight(1)
+      val pkg0 = FileImportGraph.fileImportToSegments(base, scriptSource.path, true).dropRight(1)
       val specialNames = Set("build", "module")
-      val newSource = MillBuildRootModule.top(
-        specialNames(scriptSource.path.baseName),
-        if (specialNames(scriptSource.path.baseName)) relative.segments.init
-        else relative.segments.init :+ relative.baseName,
-        scriptSource.path / os.up,
-        if (specialNames(scriptSource.path.baseName)) pkg.dropRight(1) else pkg,
-        if (specialNames(scriptSource.path.baseName)) pkg.last else scriptSource.path.baseName,
-        enclosingClasspath,
-        millTopLevelProjectRoot,
-        scriptSource.path
-      ) +
-        scriptCode(scriptSource.path) +
-        MillBuildRootModule.bottom
-
-      os.write(dest, newSource, createFolders = true)
+      val (pkg, newSource) =
+        if (specialNames(scriptSource.path.baseName)) {
+          val pkg :+ pkgLast = pkg0
+
+          pkg -> topBuild(
+            relative.segments.init,
+            scriptSource.path / os.up,
+            pkgLast,
+            enclosingClasspath,
+            millTopLevelProjectRoot
+          )
+        } else {
+          val pkg = pkg0
+          pkg -> s"""object ${backtickWrap(scriptSource.path.baseName)} {"""
+        }
+
+      val pkgLine = pkg.map(p => "package " + backtickWrap(p)).mkString("\n")
+      val markerComment =
+        s"""//MILL_ORIGINAL_FILE_PATH=${scriptSource.path}
+           |//MILL_USER_CODE_START_MARKER""".stripMargin
+
+      os.write(
+        dest,
+        Seq(
+          pkgLine,
+          newSource,
+          markerComment,
+          scriptCode(scriptSource.path),
+          MillBuildRootModule.bottom
+        ).mkString("\n"),
+        createFolders = true
+      )
     }
   }
 
-  def top(
-      isBuildOrModuleSc: Boolean,
+  def topBuild(
       segs: Seq[String],
       base: os.Path,
-      pkg: Seq[String],
       name: String,
       enclosingClasspath: Seq[os.Path],
-      millTopLevelProjectRoot: os.Path,
-      originalFilePath: os.Path
+      millTopLevelProjectRoot: os.Path
   ): String = {
     val segsList = segs.map(pprint.Util.literalize(_)).mkString(", ")
-    val superClass =
-      if (name == "build") {
-        s"_root_.mill.main.RootModule.Base(Some(_root_.mill.define.Segments.labels($segsList)))"
-      } else {
-        s"_root_.mill.main.RootModule.Foreign(Some(_root_.mill.define.Segments.labels($segsList)))"
-      }
-
-    val imports = ""
-//      if (name == "build") "import mill.main.RootModule"
-//      else "import mill.main.{RootModuleForeign => RootModule}"
-
-    val miscInfoName = s"MiscInfo_$name"
-
-    val pkgLine = pkg.map(p => "package " + backtickWrap(p)).mkString("\n")
-
-    if (isBuildOrModuleSc) {
-      s"""$pkgLine
-         |
-         |import _root_.mill.runner.MillBuildRootModule
-         |$imports
-         |
-         |@scala.annotation.nowarn
-         |object ${backtickWrap(miscInfoName)} {
-         |  implicit lazy val millBuildRootModuleInfo: _root_.mill.runner.MillBuildRootModule.Info = _root_.mill.runner.MillBuildRootModule.Info(
-         |    ${enclosingClasspath.map(p => literalize(p.toString))}.map(_root_.os.Path(_)),
-         |    _root_.os.Path(${literalize(base.toString)}),
-         |    _root_.os.Path(${literalize(millTopLevelProjectRoot.toString)}),
-         |  )
-         |  implicit lazy val millBaseModuleInfo: _root_.mill.main.RootModule.Info = _root_.mill.main.RootModule.Info(
-         |    millBuildRootModuleInfo.projectRoot,
-         |    _root_.mill.define.Discover[${backtickWrap(name + "_")}]
-         |  )
-         |}
-         |import ${backtickWrap(miscInfoName)}.{millBuildRootModuleInfo, millBaseModuleInfo}
-         |package object ${backtickWrap(name)} extends ${backtickWrap(name + "_")}
-         |import ${backtickWrap(name)}._
-         |class ${backtickWrap(name + "_")} extends $superClass {
-         |
-         |//MILL_ORIGINAL_FILE_PATH=${originalFilePath}
-         |//MILL_USER_CODE_START_MARKER
-         |""".stripMargin
-    } else {
-      s"""$pkgLine
-         |object ${backtickWrap(name)} {
-         |
-         |//MILL_ORIGINAL_FILE_PATH=${originalFilePath}
-         |//MILL_USER_CODE_START_MARKER
-         |""".stripMargin
-    }
+    val superClass = if (name == "build") "Base" else "Foreign"
+
+    s"""import _root_.mill.runner.MillBuildRootModule
+       |package ${backtickWrap(name)}{
+       |  @_root_.scala.annotation.nowarn
+       |  object MillMiscInfo extends MillBuildRootModule.MillMiscInfo(
+       |    ${enclosingClasspath.map(p => literalize(p.toString))},
+       |    ${literalize(base.toString)},
+       |    ${literalize(millTopLevelProjectRoot.toString)},
+       |    _root_.mill.define.Discover[${backtickWrap(name + "_")}]
+       |  )
+       |}
+       |
+       |import ${backtickWrap(name)}.MillMiscInfo._
+       |
+       |package object ${backtickWrap(name)} extends ${backtickWrap(name + "_")}
+       |
+       |class ${backtickWrap(name + "_")}
+       |extends _root_.mill.main.RootModule.$superClass($segsList) {
+       |""".stripMargin
   }
 
   val bottom = "\n}"
+
+  class MillMiscInfo(
+      enclosingClasspath: Seq[String],
+      projectRoot: String,
+      topLevelProjectRoot: String,
+      discover: Discover[_]
+  ) {
+    implicit val millBuildRootModuleInfo: MillBuildRootModule.Info = MillBuildRootModule.Info(
+      enclosingClasspath.map(os.Path(_)),
+      os.Path(projectRoot),
+      os.Path(topLevelProjectRoot)
+    )
+    implicit val millBaseModuleInfo: RootModule.Info = RootModule.Info(
+      millBuildRootModuleInfo.projectRoot,
+      discover
+    )
+  }
+
 }