Merge pull request #9 from tindzk/feat/compiler-deps

Add support for compiler plug-ins

Author: tindzk

.gitignore

@@ -1,5 +1,6 @@
 .bloop/
+.idea/
 target/
 /.idea/
 /build/
-/test/
+/test/meta-module/

README.md

@@ -223,6 +223,7 @@ scalaVersion = ""  # If unset, the project-wide default will be used
 root         = ""  # Module root path for IntelliJ 
 sources      = []  # List of source directories and files
 scalaDeps    = []  # Module-specific Scala dependencies
+compilerDeps = []  # Compiler plug-ins (specified in the same format as scalaDeps)
 moduleDeps   = []  # Module dependencies
 mainClass    = ""  # Optional entry point; needed for running/packaging module
 targets      = []  # Platform targets
@@ -444,6 +445,20 @@ Setting `moduleDeps` to `core`, gives `webapp` and `server` access to its compil
 
 `bloop compile webapp` triggers the compilation of `core-js` whereas `bloop compile server` would compile `core-jvm`.
 
+### Compiler plug-ins
+A module can add Scala plug-ins with `compilerDeps`. The setting behaves like `scalaDeps`, but also adds the `-Xplugin` parameter to the Scala compiler when the module is compiled. A minimal example looks as follows:
+
+```toml
+[module.macros.js]
+compilerDeps = [
+  ["org.scalamacros", "paradise", "2.1.1", "full"]
+]
+```
+
+Note that plug-ins are inherited by all dependent modules such that `compilerDeps` only needs to be defined on the base module.
+
+For a complete cross-compiled Macro Paradise example, please refer to [this project](test/example-paradise/).
+
 ### Project dependencies
 External builds can be imported into the scope by using the `import` setting at the root level. It can point to a build file, or its parent directory in which case it will attempt to load `<path>/build.toml`. From the imported file, Seed will only make its modules accessible. Other project-level settings are being ignored. Multiple projects can be imported as `import` is a list.
 

src/main/scala/seed/artefact/ArtefactResolution.scala

@@ -41,7 +41,6 @@ object ArtefactResolution {
     val scalaJsVersion = build.project.scalaJsVersion.get
 
     Set(
-      Artefact.ScalaJsCompiler,
       Artefact.ScalaJsLibrary
     ).map(artefact =>
       javaDepFromArtefact(artefact, scalaJsVersion, JavaScript,
@@ -54,7 +53,6 @@ object ArtefactResolution {
     val scalaNativeVersion = build.project.scalaNativeVersion.get
 
     Set(
-      Artefact.ScalaNativePlugin,
       Artefact.ScalaNativeJavalib,
       Artefact.ScalaNativeScalalib,
       Artefact.ScalaNativeNativelib,
@@ -105,24 +103,34 @@ object ArtefactResolution {
     }
 
   def compilerDeps(build: Build, module: Module): List[Set[JavaDep]] = {
-    def f(build: Build, module: Module): Set[JavaDep] = {
+    def f(build: Build, module: Module, platform: Platform): Set[JavaDep] = {
       import build.project.scalaOrganisation
-      val scalaVersion = BuildConfig.scalaVersion(build.project, List(module))
-
-      Set(
-        Artefact.scalaCompiler(scalaOrganisation),
-        Artefact.scalaLibrary(scalaOrganisation),
-        Artefact.scalaReflect(scalaOrganisation)
-      ).map(artefact =>
-        javaDepFromArtefact(artefact, scalaVersion, JVM, scalaVersion,
-          scalaVersion))
+      val platformVer = BuildConfig.platformVersion(build, module, platform)
+      val compilerVer = BuildConfig.scalaVersion(build.project, List(module))
+
+      val scalaDeps = Set(
+        Artefact.scalaCompiler(scalaOrganisation) -> compilerVer,
+        Artefact.scalaLibrary(scalaOrganisation) -> compilerVer,
+        Artefact.scalaReflect(scalaOrganisation) -> compilerVer
+      ) ++ (
+        if (platform == Platform.Native)
+          Set(Artefact.ScalaNativePlugin -> platformVer)
+        else if (platform == Platform.JavaScript)
+          Set(Artefact.ScalaJsCompiler -> platformVer)
+        else Set()
+      )
+
+      scalaDeps.map { case (artefact, version) =>
+        javaDepFromArtefact(artefact, version, platform, platformVer,
+          compilerVer)
+      } ++ module.compilerDeps.map(dep =>
+        javaDepFromScalaDep(dep, platform, platformVer, compilerVer))
     }
 
-    List(
-      f(build, module),
-      module.jvm.toSet.flatMap(module => f(build, module)),
-      module.js.toSet.flatMap(module => f(build, module)),
-      module.native.toSet.flatMap(module => f(build, module))
+    module.targets.map(target =>
+      f(build,
+        BuildConfig.platformModule(module, target).getOrElse(module),
+        target)
     ).filter(_.nonEmpty)
   }
 

src/main/scala/seed/config/BuildConfig.scala

@@ -10,9 +10,7 @@ import seed.Log
 import seed.config.util.TomlUtils
 
 object BuildConfig {
-  def fixPath(projectPath: Path, path: Path): Path =
-    if (path.toString.startsWith("/")) path
-    else projectPath.resolve(path).normalize()
+  import TomlUtils.parseBuildToml
 
   def load(path: Path): (Path, Build) = {
     if (!Files.exists(path)) {
@@ -39,7 +37,7 @@ object BuildConfig {
     }
 
     val parsed = TomlUtils.parseFile(
-      projectFile, parseToml(projectPath), "build file")
+      projectFile, parseBuildToml(projectPath), "build file")
 
     (projectPath.normalize(), processBuild(parsed, { path =>
       val (_, build) = load(path)
@@ -51,16 +49,6 @@ object BuildConfig {
     }))
   }
 
-  def parseToml(projectPath: Path)(content: String) = {
-    import toml._
-    import toml.Codecs._
-    import seed.config.util.TomlUtils.Codecs._
-
-    implicit val pCodec = pathCodec(fixPath(projectPath, _))
-
-    Toml.parseAs[Build](content)
-  }
-
   def processBuild(build: Build, parse: Path => Build): Build = {
     val parsed = build match { case p =>
       p.copy(module = p.module.mapValues { module =>
@@ -160,6 +148,13 @@ object BuildConfig {
       .flatMap(_.scalaVersion)
       .getOrElse(project.scalaVersion)
 
+  def platformVersion(build: Build, module: Module, platform: Platform): String =
+    platform match {
+      case JVM => BuildConfig.scalaVersion(build.project, List(module))
+      case JavaScript => build.project.scalaJsVersion.get
+      case Native => build.project.scalaNativeVersion.get
+    }
+
   def isCrossBuild(module: Module): Boolean = module.targets.toSet.size > 1
 
   def targetName(build: Build, name: String, platform: Platform): String =
@@ -197,6 +192,13 @@ object BuildConfig {
     jvmModuleDeps(module).flatMap(m =>
       List(m) ++ collectJvmModuleDeps(build, build.module(m)))
 
+  def collectModuleDeps(build: Build, module: Module, platform: Platform): List[String] =
+    platform match {
+      case JVM => collectJvmModuleDeps(build, module)
+      case JavaScript => collectJsModuleDeps(build, module)
+      case Native => collectNativeModuleDeps(build, module)
+    }
+
   def collectJsClassPath(buildPath: Path,
                          build: Build,
                          module: Module): List[Path] =

src/main/scala/seed/config/util/TomlUtils.scala

@@ -6,7 +6,7 @@ import org.apache.commons.io.FileUtils
 import seed.Log
 import seed.cli.util.Ansi
 import seed.model.Build.VersionTag
-import seed.model.Platform
+import seed.model.{Build, Platform}
 import toml.{Codec, Value}
 
 object TomlUtils {
@@ -63,4 +63,18 @@ object TomlUtils {
       case Right(c) => c
     }
   }
+
+  def fixPath(projectPath: Path, path: Path): Path =
+    if (path.toString.startsWith("/")) path
+    else projectPath.resolve(path).normalize()
+
+  def parseBuildToml(projectPath: Path)(content: String): Either[Codec.Error, Build] = {
+    import toml._
+    import toml.Codecs._
+    import seed.config.util.TomlUtils.Codecs._
+
+    implicit val pCodec = pathCodec(fixPath(projectPath, _))
+
+    Toml.parseAs[Build](content)
+  }
 }

src/main/scala/seed/generation/Bloop.scala

@@ -20,7 +20,6 @@ object Bloop {
   def writeBloop(projectPath: Path,
                  name: String,
                  bloopPath: Path,
-                 buildPath: Path,
                  dependencies: List[String],
                  classesDir: Path,
                  classPath: List[Path],
@@ -35,7 +34,7 @@ object Bloop {
       directory = projectPath.toAbsolutePath,
       sources = sources.map(_.toAbsolutePath),
       dependencies = dependencies,
-      classpath = scalaCompiler.fold(List[Path]())(_.fullClassPath.sorted),
+      classpath = scalaCompiler.fold(List[Path]())(_.fullClassPath.map(_.toAbsolutePath).sorted),
       out = classesDir.toAbsolutePath,
       classesDir = classesDir.toAbsolutePath,
       `scala` = scalaCompiler.map(scalaCompiler =>
@@ -105,15 +104,12 @@ object Bloop {
         val scalaVersion = BuildConfig.scalaVersion(project,
           List(js, parentModule.js.getOrElse(Module()), parentModule))
 
-        val scalaJsArtefacts = Set(
-          Artefact.ScalaJsCompiler, Artefact.ScalaJsLibrary
-        ).map(a =>
-          a -> Coursier.artefactPath(resolution, a, JavaScript,
+        def resolveLibrary(artefact: Artefact): Path =
+          Coursier.artefactPath(resolution, artefact, JavaScript,
             scalaJsVersion.get, scalaVersion, scalaJsVersion.get).get
-        ).toMap
 
-        val scalaJsPluginOption =
-          "-Xplugin:" + scalaJsArtefacts(Artefact.ScalaJsCompiler)
+        val plugIns = util.ScalaCompiler.compilerPlugIns(build,
+          parentModule, compilerResolution, JavaScript)
 
         val resolvedDeps = Coursier.localArtefacts(
           resolution,
@@ -127,8 +123,7 @@ object Bloop {
         val classPath    = resolvedDeps.map(_.libraryJar) ++
           (if (test) List(buildPath.resolve(name))
            else List()
-          ) ++ parentClassPaths ++
-            List(scalaJsArtefacts(Artefact.ScalaJsLibrary))
+          ) ++ parentClassPaths ++ List(resolveLibrary(Artefact.ScalaJsLibrary))
 
         val scalaCompiler = ArtefactResolution.resolveScalaCompiler(
           compilerResolution, scalaOrganisation, scalaVersion, classPath)
@@ -137,13 +132,12 @@ object Bloop {
           projectPath = projectPath,
           name = bloopName,
           bloopPath = bloopPath,
-          buildPath = buildPath,
           dependencies = dependencies,
           classesDir = classesDir,
           classPath = classPath,
           sources = sources ++ js.sources,
           scalaCompiler = Some(scalaCompiler),
-          scalaOptions = scalaOptions :+ scalaJsPluginOption,
+          scalaOptions = scalaOptions ++ plugIns,
           testFrameworks = if (test) testFrameworks else List(),
           platform = Some(Config.Platform.Js(
             Config.JsConfig(
@@ -212,7 +206,6 @@ object Bloop {
           List(native, parentModule.native.getOrElse(Module()), parentModule))
 
         val scalaNativeArtefacts = Set(
-          Artefact.ScalaNativePlugin,
           Artefact.ScalaNativeJavalib,
           Artefact.ScalaNativeScalalib,
           Artefact.ScalaNativeNativelib,
@@ -222,8 +215,8 @@ object Bloop {
             scalaNativeVersion.get, scalaVersion, scalaNativeVersion.get).get
         ).toMap
 
-        val scalaJsPluginOption =
-          "-Xplugin:" + scalaNativeArtefacts(Artefact.ScalaNativePlugin)
+        val plugIns = util.ScalaCompiler.compilerPlugIns(build,
+          parentModule, compilerResolution, Native)
 
         val resolvedDeps =
           Coursier.localArtefacts(resolution,
@@ -253,13 +246,12 @@ object Bloop {
           projectPath = projectPath,
           name = bloopName,
           bloopPath = bloopPath,
-          buildPath = buildPath,
           dependencies = dependencies,
           classesDir = classesDir,
           classPath = classPath,
           sources = sources ++ native.sources,
           scalaCompiler = Some(scalaCompiler),
-          scalaOptions = scalaOptions :+ scalaJsPluginOption,
+          scalaOptions = scalaOptions ++ plugIns,
           testFrameworks = if (test) testFrameworks else List(),
           platform = Some(Config.Platform.Native(Config.NativeConfig(
             version = scalaNativeVersion.get,
@@ -315,10 +307,12 @@ object Bloop {
         val scalaDeps = (parentModule.scalaDeps ++ jvm.scalaDeps).map(dep =>
           ArtefactResolution.javaDepFromScalaDep(dep, JVM, scalaVersion,
             scalaVersion))
-
         val resolvedDeps = Coursier.localArtefacts(resolution,
           (javaDeps ++ scalaDeps).toSet)
 
+        val plugIns = util.ScalaCompiler.compilerPlugIns(build,
+          parentModule, compilerResolution, JVM)
+
         val dependencies = if (test) List(name)
                            else (moduleDeps ++ jvm.moduleDeps).map(name => BuildConfig.targetName(build, name, JVM))
         val classesDir   = buildPath.resolve(bloopName)
@@ -335,14 +329,13 @@ object Bloop {
           projectPath = projectPath,
           name = bloopName,
           bloopPath = bloopPath,
-          buildPath = buildPath,
           dependencies = dependencies,
           classesDir = classesDir,
           classPath = classPath,
           sources = sources ++ jvm.sources,
           resources = jvm.resources,
           scalaCompiler = Some(scalaCompiler),
-          scalaOptions = scalaOptions,
+          scalaOptions = scalaOptions ++ plugIns,
           testFrameworks = if (test) testFrameworks else List(),
           platform = Some(Config.Platform.Jvm(
             Config.JvmConfig(None, List()),
@@ -434,7 +427,6 @@ object Bloop {
           projectPath = projectPath,
           name = name + "-test",
           bloopPath = bloopPath,
-          buildPath = buildPath,
           dependencies = targets.map(t => name + "-" + t.id + "-test"),
           classesDir = buildPath,
           classPath = List(),
@@ -450,7 +442,6 @@ object Bloop {
         projectPath = projectPath,
         name = name,
         bloopPath = bloopPath,
-        buildPath = buildPath,
         dependencies = module.targets.map(t => name + "-" + t.id),
         classesDir = buildPath,
         classPath = List(),

src/main/scala/seed/generation/Idea.scala

@@ -119,9 +119,21 @@ object Idea {
   }
 
   def createCompilerSettings(build: Build,
+                             compilerResolution: List[Coursier.ResolutionResult],
                              ideaPath: Path,
                              modules: List[String]): Unit = {
-    val xml = IdeaFile.createScalaCompiler(build.project.scalaOptions, modules)
+    // Group all modules by additional settings; create compiler configuration
+    // for each unique set of parameters
+    val modulePlugIns = modules.filter(build.module.contains).map(m =>
+      m -> util.ScalaCompiler.compilerPlugIns(
+        build, build.module(m), compilerResolution, JVM))
+    val compilerSettings =
+      modulePlugIns.groupBy(_._2).mapValues(_.map(_._1)).toList.map {
+        case (settings, modules) =>
+          (build.project.scalaOptions ++ settings, modules)
+      }
+
+    val xml = IdeaFile.createScalaCompiler(compilerSettings)
     FileUtils.write(ideaPath.resolve("scala_compiler.xml").toFile, xml, "UTF-8")
   }
 
@@ -389,7 +401,7 @@ object Idea {
         resolution, name, module)
     }
 
-    createCompilerSettings(build, ideaPath, modules)
+    createCompilerSettings(build, compilerResolution, ideaPath, modules)
     writeModules(projectPath, ideaPath, modulesPath, modules)
 
     Log.info("IDEA project has been created")