Groovy Compiler options for bytecode version, preview features and ast transoformations

Author: lostiniceland

libs/groovylib/api/src/mill/groovylib/worker/api/GroovyCompilerConfiguration.scala

@@ -0,0 +1,6 @@
+package mill.groovylib.worker.api
+
+case class GroovyCompilerConfiguration (
+  enablePreview: Boolean = false,
+  disabledGlobalAstTransformations: Set[String]= Set.empty,
+  targetBytecode: Option[String]= None)

libs/groovylib/api/src/mill/groovylib/worker/api/GroovyWorker.scala

@@ -1,7 +1,6 @@
 package mill.groovylib.worker.api
 
-import mill.api.TaskCtx
-import mill.api.Result
+import mill.api.{Result, TaskCtx}
 import mill.javalib.api.CompilationResult
 
 /**
@@ -20,7 +19,8 @@ trait GroovyWorker {
   def compileGroovyStubs(
       sourceFiles: Seq[os.Path],
       classpath: Seq[os.Path],
-      outputDir: os.Path
+      outputDir: os.Path,
+      config: GroovyCompilerConfiguration
   )(implicit
       ctx: TaskCtx
   )
@@ -30,7 +30,12 @@ trait GroovyWorker {
    * Compiles the Groovy sources. In a mixed setup this method assumes that the Java stubs
    * are already present in the outputDir.
    */
-  def compile(sourceFiles: Seq[os.Path], classpath: Seq[os.Path], outputDir: os.Path)(implicit
+  def compile(
+      sourceFiles: Seq[os.Path],
+      classpath: Seq[os.Path],
+      outputDir: os.Path,
+      config: GroovyCompilerConfiguration
+  )(implicit
       ctx: TaskCtx
   )
       : Result[CompilationResult]

libs/groovylib/src/mill/groovylib/GroovyModule.scala

@@ -9,6 +9,7 @@ import mill.javalib.{Dep, JavaModule, JvmWorkerModule, Lib}
 import mill.*
 import mainargs.Flag
 import mill.api.daemon.internal.bsp.{BspBuildTarget, BspModuleApi}
+import mill.groovylib.worker.api.GroovyCompilerConfiguration
 import mill.javalib.api.internal.{JavaCompilerOptions, JvmWorkerApi, ZincCompileJava}
 import mill.util.Version
 
@@ -49,6 +50,29 @@ trait GroovyModule extends JavaModule with GroovyModuleApi { outer =>
     allGroovySourceFiles() ++ allJavaSourceFiles()
   }
 
+  /**
+   * Specifiy the bytecode version for the Groovy compiler.
+   * {{{
+   *   def targetBytecode = Some("17")
+   * }}}
+   */
+  def targetBytecode: T[Option[String]] = None
+
+  /**
+   * Specify if the Groovy compiler should enable preview features.
+   */
+  def enablePreview: T[Boolean] = false
+
+  /**
+   * Specify which global AST transformations should be disabled. Be aware that transformations
+   * like [[groovy.transform.Immutable]] are so-called "local" transformations and will not be
+   * affected.
+   *
+   * see [[https://docs.groovy-lang.org/latest/html/api/org/codehaus/groovy/control/CompilerConfiguration.html#setDisabledGlobalASTTransformations(java.util.Set) Groovy-Docs]]
+   */
+  def disabledGlobalAstTransformations: T[Set[String]] = Set.empty
+
+
   /**
    * All individual Java source files fed into the compiler.
    * Subset of [[allSourceFiles]].
@@ -92,7 +116,7 @@ trait GroovyModule extends JavaModule with GroovyModuleApi { outer =>
   }
 
   /**
-   * The Ivy/Coursier dependencies resembling the Groovy compiler.
+   * The Coursier dependencies resembling the Groovy compiler.
    *
    * Default is derived from [[groovyVersion]].
    */
@@ -128,6 +152,12 @@ trait GroovyModule extends JavaModule with GroovyModuleApi { outer =>
       val compileCp = compileClasspath().map(_.path).filter(os.exists)
       val updateCompileOutput = upstreamCompileOutput()
 
+      val config = GroovyCompilerConfiguration(
+        enablePreview = enablePreview(),
+        targetBytecode = targetBytecode(),
+        disabledGlobalAstTransformations = disabledGlobalAstTransformations(),
+      )
+
       def compileJava: Result[CompilationResult] = {
         ctx.log.info(
           s"Compiling ${javaSourceFiles.size} Java sources to $classes ..."
@@ -150,7 +180,7 @@ trait GroovyModule extends JavaModule with GroovyModuleApi { outer =>
 
         val workerStubResult =
           GroovyWorkerManager.groovyWorker().withValue(groovyCompilerClasspath()) {
-            _.compileGroovyStubs(groovySourceFiles, compileCp, classes)
+            _.compileGroovyStubs(groovySourceFiles, compileCp, classes, config)
           }
         workerStubResult match {
           case Result.Success(_) => compileJava
@@ -165,7 +195,7 @@ trait GroovyModule extends JavaModule with GroovyModuleApi { outer =>
 
         val workerGroovyResult =
           GroovyWorkerManager.groovyWorker().withValue(groovyCompilerClasspath()) {
-            _.compile(groovySourceFiles, compileCp, classes)
+            _.compile(groovySourceFiles, compileCp, classes, config)
           }
 
         // TODO figure out if there is a better way to do this

libs/groovylib/src/mill/groovylib/publish/exports.scala

@@ -26,7 +26,7 @@ export mill.javalib.publish.PackagingType
 
 export mill.javalib.publish.SonatypeHelpers
 export mill.javalib.publish.SonatypeHttpApi
-export mill.javalib.publish.SonatypePublisher
+export mill.javalib.SonatypeCentralPublisher
 
 export mill.javalib.publish.VersionControl
 

libs/groovylib/worker/src/mill/groovylib/worker/impl/GroovyWorkerImpl.scala

@@ -4,7 +4,7 @@ import groovy.lang.GroovyClassLoader
 import mill.api.Result
 import mill.api.TaskCtx
 import mill.javalib.api.CompilationResult
-import mill.groovylib.worker.api.GroovyWorker
+import mill.groovylib.worker.api.{GroovyCompilerConfiguration, GroovyWorker}
 import org.codehaus.groovy.control.{CompilationUnit, CompilerConfiguration, Phases}
 import org.codehaus.groovy.tools.javac.JavaStubCompilationUnit
 import os.Path
@@ -17,22 +17,26 @@ class GroovyWorkerImpl extends GroovyWorker {
   override def compileGroovyStubs(
       sourceFiles: Seq[Path],
       classpath: Seq[Path],
-      outputDir: Path
+      outputDir: Path,
+      config: GroovyCompilerConfiguration,
   )(implicit ctx: TaskCtx): Result[CompilationResult] = {
-    val config = new CompilerConfiguration()
-    config.setTargetDirectory(outputDir.toIO)
-    config.setClasspathList(classpath.map(_.toIO.getAbsolutePath).asJava)
-    config.setJointCompilationOptions(Map(
+    val compilerConfig = new CompilerConfiguration()
+    compilerConfig.setTargetDirectory(outputDir.toIO)
+    compilerConfig.setClasspathList(classpath.map(_.toIO.getAbsolutePath).asJava)
+    compilerConfig.setJointCompilationOptions(Map(
       "stubDir" -> outputDir.toIO,
       "keepStubs" -> false
     ).asJava)
+    compilerConfig.setDisabledGlobalASTTransformations(config.disabledGlobalAstTransformations.asJava)
+    compilerConfig.setPreviewFeatures(config.enablePreview)
+    config.targetBytecode.foreach(compilerConfig.setTargetBytecode)
 
     // we need to set the classloader for groovy to use the worker classloader
     val parentCl: ClassLoader = this.getClass.getClassLoader
-    // config in the GroovyClassLoader is needed when the CL itself is compiling classes
-    val gcl = new GroovyClassLoader(parentCl, config)
-    // config for actual compilation
-    val stubUnit = JavaStubCompilationUnit(config, gcl)
+    // compilerConfig in the GroovyClassLoader is needed when the CL itself is compiling classes
+    val gcl = new GroovyClassLoader(parentCl, compilerConfig)
+    // compilerConfig for actual compilation
+    val stubUnit = JavaStubCompilationUnit(compilerConfig, gcl)
 
     sourceFiles.foreach { sourceFile =>
       stubUnit.addSource(sourceFile.toIO)
@@ -51,26 +55,28 @@ class GroovyWorkerImpl extends GroovyWorker {
   def compile(
       sourceFiles: Seq[os.Path],
       classpath: Seq[os.Path],
-      outputDir: os.Path
+      outputDir: os.Path,
+      config: GroovyCompilerConfiguration,
   )(implicit
       ctx: TaskCtx
   ): Result[CompilationResult] = {
 
     val extendedClasspath = classpath :+ outputDir
 
-    val config = new CompilerConfiguration()
-    config.setTargetDirectory(outputDir.toIO)
-    config.setClasspathList(extendedClasspath.map(_.toIO.getAbsolutePath).asJava)
-    // TODO
-//    config.setDisabledGlobalASTTransformations()
-//    config.setSourceEncoding()
+    val compilerConfig = new CompilerConfiguration()
+    compilerConfig.setTargetDirectory(outputDir.toIO)
+    compilerConfig.setClasspathList(extendedClasspath.map(_.toIO.getAbsolutePath).asJava)
+    compilerConfig.setDisabledGlobalASTTransformations(config.disabledGlobalAstTransformations.asJava)
+    compilerConfig.setPreviewFeatures(config.enablePreview)
+    config.targetBytecode.foreach(compilerConfig.setTargetBytecode)
 
     // we need to set the classloader for groovy to use the worker classloader
     val parentCl: ClassLoader = this.getClass.getClassLoader
-    // config in the GroovyClassLoader is needed when the CL itself is compiling classes
-    val gcl = new GroovyClassLoader(parentCl, config)
-    // config for actual compilation
-    val unit = new CompilationUnit(config, null, gcl)
+    // compilerConfig in the GroovyClassLoader is needed when the CL itself is compiling classes
+    val gcl = new GroovyClassLoader(parentCl, compilerConfig)
+
+    // compilerConfig for actual compilation
+    val unit = new CompilationUnit(compilerConfig, null, gcl)
 
     sourceFiles.foreach { sourceFile =>
       unit.addSource(sourceFile.toIO)