Add support for compiler plugins (#140)

* Add support for compiler plugins

Author: lwronski

modules/build/src/main/scala/scala/build/options/BuildOptions.scala

@@ -75,7 +75,8 @@ final case class BuildOptions(
   def compilerPlugins: Seq[AnyDependency] =
     scalaJsOptions.compilerPlugins(scalaParams.scalaVersion) ++
       scalaNativeOptions.compilerPlugins ++
-      semanticDbPlugins
+      semanticDbPlugins ++
+      scalaOptions.compilerPlugins
 
   def allExtraJars: Seq[Path] =
     classPathOptions.extraJars.map(_.toNIO)

modules/build/src/main/scala/scala/build/options/ScalaOptions.scala

@@ -1,12 +1,15 @@
 package scala.build.options
 
+import dependency.AnyDependency
+
 final case class ScalaOptions(
   scalaVersion: Option[String] = None,
   scalaBinaryVersion: Option[String] = None,
   addScalaLibrary: Option[Boolean] = None,
   generateSemanticDbs: Option[Boolean] = None,
   scalacOptions: Seq[String] = Nil,
-  extraScalaVersions: Set[String] = Set.empty
+  extraScalaVersions: Set[String] = Set.empty,
+  compilerPlugins: Seq[AnyDependency] = Nil
 )
 
 object ScalaOptions {

modules/cli/src/main/scala/scala/cli/commands/SharedDependencyOptions.scala

@@ -15,7 +15,12 @@ final case class SharedDependencyOptions(
   @HelpMessage("")
   @Name("repo")
   @Name("r")
-    repository: List[String] = Nil
+    repository: List[String] = Nil,
+  @Group("Scala")
+  @Name("P")
+  @Name("plugin")
+  @HelpMessage("Add compiler plugins dependencies")
+  compilerPlugin: List[String] = Nil
 )
 // format: on
 

modules/cli/src/main/scala/scala/cli/commands/SharedOptions.scala

@@ -1,11 +1,11 @@
 package scala.cli.commands
 
 import java.io.{ByteArrayOutputStream, File, InputStream}
-
 import caseapp._
 import caseapp.core.help.Help
 import coursier.cache.FileCache
 import coursier.util.Artifact
+import dependency.AnyDependency
 import dependency.parser.DependencyParser
 
 import scala.build.blooprifle.BloopRifleConfig
@@ -115,6 +115,17 @@ final case class SharedOptions(
     if (classWrap) Some(CustomCodeClassWrapper)
     else None
 
+  private def parseDependencies(deps: List[String], ignoreErrors: Boolean): Seq[AnyDependency] =
+    deps.map(_.trim).filter(_.nonEmpty)
+      .flatMap { depStr =>
+        DependencyParser.parse(depStr) match {
+          case Left(err) =>
+            if (ignoreErrors) Nil
+            else sys.error(s"Error parsing dependency '$depStr': $err")
+          case Right(dep) => Seq(dep)
+        }
+      }
+
   def buildOptions(
     enableJmh: Boolean,
     jmhVersion: Option[String],
@@ -126,7 +137,8 @@ final case class SharedOptions(
         scalaBinaryVersion = scalaBinaryVersion.map(_.trim).filter(_.nonEmpty),
         addScalaLibrary = scalaLibrary.orElse(java.map(!_)),
         generateSemanticDbs = semanticDb,
-        scalacOptions = scalac.scalacOption.filter(_.nonEmpty)
+        scalacOptions = scalac.scalacOption.filter(_.nonEmpty),
+        compilerPlugins = parseDependencies(dependencies.compilerPlugin, ignoreErrors)
       ),
       scriptOptions = ScriptOptions(
         codeWrapper = codeWrapper
@@ -154,15 +166,7 @@ final case class SharedOptions(
           .filter(_.nonEmpty)
           .map(os.Path(_, os.pwd)),
         extraRepositories = dependencies.repository.map(_.trim).filter(_.nonEmpty),
-        extraDependencies = dependencies.dependency.map(_.trim).filter(_.nonEmpty)
-          .flatMap { depStr =>
-            DependencyParser.parse(depStr) match {
-              case Left(err) =>
-                if (ignoreErrors) Nil
-                else sys.error(s"Error parsing dependency '$depStr': $err")
-              case Right(dep) => Seq(dep)
-            }
-          }
+        extraDependencies = parseDependencies(dependencies.dependency, ignoreErrors)
       ),
       internal = InternalOptions(
         cache = Some(coursierCache),

modules/integration/src/test/scala/scala/cli/integration/CompileTestDefinitions.scala

@@ -5,7 +5,7 @@ import com.eed3si9n.expecty.Expecty.expect
 abstract class CompileTestDefinitions(val scalaVersionOpt: Option[String])
     extends munit.FunSuite with TestScalaVersionArgs {
 
-  private lazy val extraOptions = scalaVersionArgs ++ TestUtil.extraOptions
+  protected lazy val extraOptions = scalaVersionArgs ++ TestUtil.extraOptions
 
   val simpleInputs = TestInputs(
     Seq(

modules/integration/src/test/scala/scala/cli/integration/CompileTests212.scala

@@ -3,5 +3,37 @@ package scala.cli.integration
 // format: off
 class CompileTests212 extends CompileTestDefinitions(
   scalaVersionOpt = Some(Constants.scala212)
-)
-// format: on
+) {
+// format: on 
+
+  val pluginInputs = TestInputs(
+    Seq(
+      os.rel / "Plugin.scala" ->
+        // Copied from (https://github.com/typelevel/kind-projector/blob/00bf25cef1b7d01d61a3555cccb6cf38fe30e117/src/test/scala/polylambda.scala)
+        """object Plugin {
+          |  trait ~>[-F[_], +G[_]] {
+          |    def apply[A](x: F[A]): G[A]
+          |  }
+          |  type ToSelf[F[_]] = F ~> F
+          |  val kf5 = λ[Map[*, Int] ~> Map[*, Long]](_.map { case (k, v) => (k, v.toLong) }.toMap)
+          |  val kf6 = λ[ToSelf[Map[*, Int]]](_.map { case (k, v) => (k, v * 2) }.toMap)
+          |}
+          |""".stripMargin,
+      os.rel / "scala.conf" -> ""
+    )
+  )
+
+  val kindProjectPlugin = "org.typelevel:::kind-projector:0.13.2"
+
+  test("should compile with compiler plugin") {
+    pluginInputs.fromRoot { root =>
+      os.proc(
+        TestUtil.cli,
+        "compile",
+        extraOptions,
+        "--compiler-plugin",
+        kindProjectPlugin
+      ).call(cwd = root).out.text
+    }
+  }
+}

website/docs/compile.md

@@ -70,6 +70,13 @@ scala-cli compile Hello.scala -O -deprecation -O -Xlint:infer-any
 
 `-O` accepts both options with the prefixes above and those without such a prefix.
 
+## Scala compiler plugins
+Use `--compiler-plugin` to add compiler plugin dependencies:
+
+```bash
+scala-cli compile Main.scala --compiler-plugin org.typelevel:::kind-projector:0.13.2 --scala 2.12.14
+```
+
 ## Scala version
 
 Specify the Scala version you'd like to use with `--scala`:

website/docs/reference/cli-options.md

@@ -181,6 +181,12 @@ Aliases: `--repo`, `-r`
 
 Add repositories
 
+#### `--compiler-plugin`
+
+Aliases: `-P`, `--plugin`
+
+Add compiler plugins dependencies
+
 ## Export options
 
 Available in commands: