Add internal and CLI options for javac plugins and options

alexarchambault · alexarchambault · commit fd3410aa277a · 2022-01-25T12:03:23.000+01:00
diff --git a/modules/build/src/main/scala/scala/build/Artifacts.scala b/modules/build/src/main/scala/scala/build/Artifacts.scala
@@ -24,6 +24,8 @@ final case class Artifacts(
   compilerDependencies: Seq[AnyDependency],
   compilerArtifacts: Seq[(String, Path)],
   compilerPlugins: Seq[(AnyDependency, String, Path)],
+  javacPluginDependencies: Seq[(AnyDependency, String, Path)],
+  extraJavacPlugins: Seq[Path],
   dependencies: Seq[AnyDependency],
   scalaNativeCli: Seq[Path],
   detailedArtifacts: Seq[(CsDependency, csCore.Publication, csUtil.Artifact, Path)],
@@ -63,6 +65,8 @@ object Artifacts {
   def apply(
     params: ScalaParameters,
     compilerPlugins: Seq[Positioned[AnyDependency]],
+    javacPluginDependencies: Seq[Positioned[AnyDependency]],
+    extraJavacPlugins: Seq[Path],
     dependencies: Seq[Positioned[AnyDependency]],
     extraClassPath: Seq[Path],
     extraCompileOnlyJars: Seq[Path],
@@ -198,10 +202,23 @@ object Artifacts {
         .map(_.flatten)
     }
 
+    val javacPlugins0 = value {
+      javacPluginDependencies
+        .map { posDep =>
+          artifacts(posDep.map(Seq(_)), allExtraRepositories, params, logger)
+            .map(_.map { case (url, path) => (posDep.value, url, path) })
+        }
+        .sequence
+        .left.map(CompositeBuildException(_))
+        .map(_.flatten)
+    }
+
     Artifacts(
       compilerDependencies,
       compilerArtifacts,
       compilerPlugins0,
+      javacPlugins0,
+      extraJavacPlugins,
       updatedDependencies.map(_.value),
       scalaNativeCli,
       fetchRes.fullDetailedArtifacts.collect { case (d, p, a, Some(f)) => (d, p, a, f.toPath) },
diff --git a/modules/build/src/main/scala/scala/build/Build.scala b/modules/build/src/main/scala/scala/build/Build.scala
@@ -601,6 +601,8 @@ object Build {
       compilerClassPath = artifacts.compilerClassPath
     )
 
+    val javacOptions = javacReleaseV ++ options.javaOptions.javacOptions
+
     // `test` scope should contains class path to main scope
     val mainClassesPath =
       if (scope == Scope.Test)
@@ -609,6 +611,11 @@ object Build {
 
     value(validate(logger, options))
 
+    val fullClassPath = artifacts.compileClassPath ++
+      mainClassesPath ++
+      artifacts.javacPluginDependencies.map(_._3) ++
+      artifacts.extraJavacPlugins
+
     val project = Project(
       directory = inputs.workspace / ".scala",
       workspace = inputs.workspace,
@@ -622,13 +629,13 @@ object Build {
           Some(options.scalaNativeOptions.bloopConfig())
         else None,
       projectName = inputs.scopeProjectName(scope),
-      classPath = artifacts.compileClassPath ++ mainClassesPath,
+      classPath = fullClassPath,
       resolution = Some(Project.resolution(artifacts.detailedArtifacts)),
       sources = allSources,
       resourceDirs = sources.resourceDirs,
       scope = scope,
       javaHomeOpt = Option(options.javaHomeLocation().value),
-      javacOptions = javacReleaseV
+      javacOptions = javacOptions
     )
     project
   }
diff --git a/modules/build/src/main/scala/scala/build/options/BuildOptions.scala b/modules/build/src/main/scala/scala/build/options/BuildOptions.scala
@@ -114,6 +114,10 @@ final case class BuildOptions(
       scalaOptions.compilerPlugins
   }
 
+  def javacPluginDependencies: Either[BuildException, Seq[Positioned[AnyDependency]]] = either {
+    javaOptions.javacPluginDependencies
+  }
+
   def allExtraJars: Seq[Path] =
     classPathOptions.extraClassPath.map(_.toNIO)
   def allExtraCompileOnlyJars: Seq[Path] =
@@ -337,6 +341,8 @@ final case class BuildOptions(
     val maybeArtifacts = Artifacts(
       params = value(scalaParams),
       compilerPlugins = value(compilerPlugins),
+      javacPluginDependencies = value(javacPluginDependencies),
+      extraJavacPlugins = javaOptions.javacPlugins.map(_.value.toNIO),
       dependencies = value(dependencies),
       extraClassPath = allExtraJars,
       scalaNativeCliVersion =
diff --git a/modules/build/src/main/scala/scala/build/options/JavaOptions.scala b/modules/build/src/main/scala/scala/build/options/JavaOptions.scala
@@ -1,5 +1,7 @@
 package scala.build.options
 
+import dependency.AnyDependency
+
 import scala.build.Positioned
 
 final case class JavaOptions(
@@ -9,7 +11,10 @@ final case class JavaOptions(
   jvmIndexOs: Option[String] = None,
   jvmIndexArch: Option[String] = None,
   javaOpts: Seq[Positioned[String]] = Nil,
-  bloopJvmVersion: Option[Positioned[Int]] = None
+  bloopJvmVersion: Option[Positioned[Int]] = None,
+  javacPluginDependencies: Seq[Positioned[AnyDependency]] = Nil,
+  javacPlugins: Seq[Positioned[os.Path]] = Nil,
+  javacOptions: Seq[String] = Nil
 )
 
 object JavaOptions {
diff --git a/modules/cli/src/main/scala/scala/cli/commands/SharedJvmOptions.scala b/modules/cli/src/main/scala/scala/cli/commands/SharedJvmOptions.scala
@@ -3,8 +3,11 @@ package scala.cli.commands
 import caseapp._
 import upickle.default.{ReadWriter, macroRW}
 
+import java.io.File
+
 import scala.build.options.JavaOptions
 import scala.build.{Os, Position, Positioned}
+import scala.util.Properties
 
 // format: off
 final case class SharedJvmOptions(
@@ -33,18 +36,44 @@ final case class SharedJvmOptions(
   @HelpMessage("CPU architecture to use when looking up in the JVM index")
   @ValueDescription("amd64|arm64|arm|…")
   @Hidden
-    jvmIndexArch: Option[String] = None
+    jvmIndexArch: Option[String] = None,
+
+  @Group("Java")
+  @HelpMessage("Javac plugin dependencies or files")
+  @Hidden
+    javacPlugin: List[String] = Nil,
+
+  @Group("Java")
+  @HelpMessage("Javac options")
+  @Name("javacOpt")
+  @Hidden
+    javacOption: List[String] = Nil
 ) {
   // format: on
 
+  private lazy val (javacFilePlugins, javacPluginDeps) =
+    javacPlugin
+      .filter(_.trim.nonEmpty)
+      .partition { input =>
+        input.contains(File.separator) ||
+        (Properties.isWin && input.contains("/")) ||
+        input.count(_ == ':') < 2
+      }
+
   def javaOptions = JavaOptions(
     javaHomeOpt = javaHome.filter(_.nonEmpty).map(v =>
       Positioned(Seq(Position.CommandLine("--java-home")), os.Path(v, Os.pwd))
     ),
     jvmIdOpt = jvm.filter(_.nonEmpty),
     jvmIndexOpt = jvmIndex.filter(_.nonEmpty),
     jvmIndexOs = jvmIndexOs.map(_.trim).filter(_.nonEmpty),
-    jvmIndexArch = jvmIndexArch.map(_.trim).filter(_.nonEmpty)
+    jvmIndexArch = jvmIndexArch.map(_.trim).filter(_.nonEmpty),
+    javacPluginDependencies = SharedOptions.parseDependencies(
+      javacPluginDeps.map(Positioned.none(_)),
+      ignoreErrors = false
+    ),
+    javacPlugins = javacFilePlugins.map(s => Positioned.none(os.Path(s, Os.pwd))),
+    javacOptions = javacOption
   )
 
 }
diff --git a/modules/cli/src/main/scala/scala/cli/commands/SharedOptions.scala b/modules/cli/src/main/scala/scala/cli/commands/SharedOptions.scala
@@ -107,21 +107,6 @@ final case class SharedOptions(
 
   def logger = logging.logger
 
-  private def parseDependencies(
-    deps: List[Positioned[String]],
-    ignoreErrors: Boolean
-  ): Seq[Positioned[AnyDependency]] =
-    deps.map(_.map(_.trim)).filter(_.value.nonEmpty)
-      .flatMap { posDepStr =>
-        val depStr = posDepStr.value
-        DependencyParser.parse(depStr) match {
-          case Left(err) =>
-            if (ignoreErrors) Nil
-            else sys.error(s"Error parsing dependency '$depStr': $err")
-          case Right(dep) => Seq(posDepStr.map(_ => dep))
-        }
-      }
-
   def buildOptions(
     enableJmh: Boolean,
     jmhVersion: Option[String],
@@ -139,7 +124,10 @@ final case class SharedOptions(
         generateSemanticDbs = semanticDb,
         scalacOptions = scalac.scalacOption.filter(_.nonEmpty),
         compilerPlugins =
-          parseDependencies(dependencies.compilerPlugin.map(Positioned.none(_)), ignoreErrors),
+          SharedOptions.parseDependencies(
+            dependencies.compilerPlugin.map(Positioned.none(_)),
+            ignoreErrors
+          ),
         platform = platformOpt.map(o => Positioned(List(Position.CommandLine()), o))
       ),
       scriptOptions = ScriptOptions(
@@ -169,7 +157,10 @@ final case class SharedOptions(
           .map(os.Path(_, os.pwd)),
         extraRepositories = dependencies.repository.map(_.trim).filter(_.nonEmpty),
         extraDependencies =
-          parseDependencies(dependencies.dependency.map(Positioned.none(_)), ignoreErrors)
+          SharedOptions.parseDependencies(
+            dependencies.dependency.map(Positioned.none(_)),
+            ignoreErrors
+          )
       ),
       internal = InternalOptions(
         cache = Some(coursierCache),
@@ -258,6 +249,21 @@ object SharedOptions {
   implicit lazy val help: Help[SharedOptions]            = Help.derive
   implicit lazy val jsonCodec: ReadWriter[SharedOptions] = macroRW
 
+  def parseDependencies(
+    deps: List[Positioned[String]],
+    ignoreErrors: Boolean
+  ): Seq[Positioned[AnyDependency]] =
+    deps.map(_.map(_.trim)).filter(_.value.nonEmpty)
+      .flatMap { posDepStr =>
+        val depStr = posDepStr.value
+        DependencyParser.parse(depStr) match {
+          case Left(err) =>
+            if (ignoreErrors) Nil
+            else sys.error(s"Error parsing dependency '$depStr': $err")
+          case Right(dep) => Seq(posDepStr.map(_ => dep))
+        }
+      }
+
   def readStdin(in: InputStream = System.in, logger: Logger): Option[Array[Byte]] =
     if (in == null) {
       logger.debug("No stdin available")
diff --git a/modules/integration/src/test/scala/scala/cli/integration/CompileTestDefinitions.scala b/modules/integration/src/test/scala/scala/cli/integration/CompileTestDefinitions.scala
@@ -273,4 +273,52 @@ abstract class CompileTestDefinitions(val scalaVersionOpt: Option[String])
 
       }
     }
+
+  test("Manual javac SemanticDB") {
+    val inputs = TestInputs(
+      Seq(
+        os.rel / "foo" / "Test.java" ->
+          """package foo;
+            |
+            |public class Test {
+            |  public static void main(String[] args) {
+            |    System.err.println("Hello");
+            |  }
+            |}
+            |""".stripMargin
+      )
+    )
+    inputs.fromRoot { root =>
+      val compilerPackages = Seq(
+        "com.sun.tools.javac.api",
+        "com.sun.tools.javac.code",
+        "com.sun.tools.javac.model",
+        "com.sun.tools.javac.tree",
+        "com.sun.tools.javac.util"
+      )
+      val exports = compilerPackages
+        .flatMap { pkg =>
+          Seq("-J--add-exports", s"-Jjdk.compiler/$pkg=ALL-UNNAMED")
+        }
+        .flatMap(opt => List("--javac-opt", opt))
+      val javaSemDbOptions = Seq(
+        "--javac-plugin",
+        "com.sourcegraph:semanticdb-javac:0.7.4",
+        "--javac-opt",
+        s"-Xplugin:semanticdb -sourceroot:$root -targetroot:javac-classes-directory"
+      ) ++ exports
+      os.proc(TestUtil.cli, "compile", extraOptions, javaSemDbOptions, ".")
+        .call(cwd = root)
+
+      val files = os.walk(root / ".scala")
+      val semDbFiles = files
+        .filter(_.last.endsWith(".semanticdb"))
+        .filter(!_.segments.exists(_ == "bloop-internal-classes"))
+      expect(semDbFiles.length == 1)
+      val semDbFile = semDbFiles.head
+      expect(
+        semDbFile.endsWith(os.rel / "META-INF" / "semanticdb" / "foo" / "Test.java.semanticdb")
+      )
+    }
+  }
 }
diff --git a/website/docs/reference/cli-options.md b/website/docs/reference/cli-options.md
@@ -524,6 +524,16 @@ Operating system to use when looking up in the JVM index
 
 CPU architecture to use when looking up in the JVM index
 
+#### `--javac-plugin`
+
+Javac plugin dependencies or files
+
+#### `--javac-option`
+
+Aliases: `--javac-opt`
+
+Javac options
+
 ## Logging options
 
 Available in commands:
