Merge pull request scala-js#1879 from nicolasstucki/append-prepend-to-emmited-js

sjrd · sjrd · commit f80641f7ba14 · 2015-08-28T16:50:27.000+02:00
Fix scala-js#1845: Add scalaJSOutputWrapper sbt setting.
diff --git a/project/BinaryIncompatibilities.scala b/project/BinaryIncompatibilities.scala
@@ -28,6 +28,8 @@ object BinaryIncompatibilities {
           "org.scalajs.core.tools.optimizer.Analyzer#ClassInfo.isClass"),
       ProblemFilters.exclude[MissingMethodProblem](
           "org.scalajs.core.tools.optimizer.Analyzer#ClassInfo.isHijackedClass"),
+      ProblemFilters.exclude[IncompatibleMethTypeProblem](
+          "org.scalajs.core.tools.optimizer.ScalaJSClosureOptimizer.org$scalajs$core$tools$optimizer$ScalaJSClosureOptimizer$$writeResult"),
 
       ProblemFilters.exclude[MissingMethodProblem](
           "org.scalajs.core.tools.javascript.JSDesugaring#JSDesugar.org$scalajs$core$tools$javascript$JSDesugaring$JSDesugar$$implicitOutputMode"),
diff --git a/sbt-plugin-test/build.sbt b/sbt-plugin-test/build.sbt
@@ -23,7 +23,10 @@ lazy val root = project.in(file(".")).
 lazy val noDOM = project.settings(baseSettings: _*).
   enablePlugins(ScalaJSPlugin).
   settings(
-    name := "Scala.js sbt test w/o DOM"
+    name := "Scala.js sbt test w/o DOM",
+    scalaJSOutputWrapper := (
+        "// Scala.js - noDOM sbt test\n//\n// Compiled with Scala.js\n",
+        "// End of Scala.js generated script")
   )
 
 lazy val withDOM = project.settings(baseSettings: _*).
@@ -32,8 +35,10 @@ lazy val withDOM = project.settings(baseSettings: _*).
     name := "Scala.js sbt test w/ DOM",
     jsDependencies ++= Seq(
         RuntimeDOM,
-        "org.webjars" % "jquery" % "1.10.2" / "jquery.js"
-    )
+        "org.webjars" % "jquery" % "1.10.2" / "jquery.js"),
+    scalaJSOutputWrapper := (
+        "// Scala.js - withDOM sbt test\n//\n// Compiled with Scala.js\n",
+        "// End of Scala.js generated script")
   )
 
 lazy val jetty9 = project.settings(baseSettings: _*).
diff --git a/sbt-plugin/src/main/scala/scala/scalajs/sbtplugin/ScalaJSPlugin.scala b/sbt-plugin/src/main/scala/scala/scalajs/sbtplugin/ScalaJSPlugin.scala
@@ -154,6 +154,9 @@ object ScalaJSPlugin extends AutoPlugin {
     val emitSourceMaps = SettingKey[Boolean]("emitSourceMaps",
         "Whether package and optimize stages should emit source maps at all", BPlusSetting)
 
+    val scalaJSOutputWrapper = TaskKey[(String, String)]("scalaJSOutputWrapper",
+      "Custom wrapper for the generated .js files. Formatted as tuple (header, footer).", BPlusTask)
+
     val jsDependencies = SettingKey[Seq[AbstractJSDep]]("jsDependencies",
         "JavaScript libraries this project depends upon. Also used to depend on the DOM.", APlusSetting)
 
diff --git a/sbt-plugin/src/main/scala/scala/scalajs/sbtplugin/ScalaJSPluginInternal.scala b/sbt-plugin/src/main/scala/scala/scalajs/sbtplugin/ScalaJSPluginInternal.scala
@@ -275,15 +275,15 @@ object ScalaJSPluginInternal {
         import ScalaJSOptimizer._
         val outCP = (scalaJSOptimizer in fastOptJS).value.optimizeCP(
             (scalaJSPreLinkClasspath in fastOptJS).value,
-            Config(
-                output = AtomicWritableFileVirtualJSFile(output),
-                cache = Some(taskCache),
-                wantSourceMap = (emitSourceMaps in fastOptJS).value,
-                relativizeSourceMapBase = relSourceMapBase,
-                bypassLinkingErrors = opts.bypassLinkingErrors,
-                checkIR = opts.checkScalaJSIR,
-                disableOptimizer = opts.disableOptimizer,
-                batchMode = opts.batchMode),
+            Config(AtomicWritableFileVirtualJSFile(output))
+              .withCache(Some(taskCache))
+              .withWantSourceMap((emitSourceMaps in fastOptJS).value)
+              .withRelativizeSourceMapBase(relSourceMapBase)
+              .withBypassLinkingErrors(opts.bypassLinkingErrors)
+              .withCheckIR(opts.checkScalaJSIR)
+              .withDisableOptimizer(opts.disableOptimizer)
+              .withBatchMode(opts.batchMode)
+              .withCustomOutputWrapper(scalaJSOutputWrapper.value),
             s.log)
 
          Attributed.blank(output).put(scalaJSCompleteClasspath, outCP)
@@ -319,16 +319,16 @@ object ScalaJSPluginInternal {
         val outCP = new ScalaJSClosureOptimizer().optimizeCP(
             (scalaJSOptimizer in fullOptJS).value,
             (scalaJSPreLinkClasspath in fullOptJS).value,
-            Config(
-                output = AtomicWritableFileVirtualJSFile(output),
-                cache = Some(taskCache),
-                wantSourceMap = (emitSourceMaps in fullOptJS).value,
-                relativizeSourceMapBase = relSourceMapBase,
-                bypassLinkingErrors = opts.bypassLinkingErrors,
-                checkIR = opts.checkScalaJSIR,
-                disableOptimizer = opts.disableOptimizer,
-                batchMode = opts.batchMode,
-                prettyPrint = opts.prettyPrintFullOptJS),
+            Config(AtomicWritableFileVirtualJSFile(output))
+              .withCache(Some(taskCache))
+              .withWantSourceMap((emitSourceMaps in fullOptJS).value)
+              .withRelativizeSourceMapBase(relSourceMapBase)
+              .withBypassLinkingErrors(opts.bypassLinkingErrors)
+              .withCheckIR(opts.checkScalaJSIR)
+              .withDisableOptimizer(opts.disableOptimizer)
+              .withBatchMode(opts.batchMode)
+              .withCustomOutputWrapper(scalaJSOutputWrapper.value)
+              .withPrettyPrint(opts.prettyPrintFullOptJS),
             s.log)
 
         Attributed.blank(output).put(scalaJSCompleteClasspath, outCP)
@@ -625,6 +625,8 @@ object ScalaJSPluginInternal {
 
       emitSourceMaps := true,
 
+      scalaJSOutputWrapper := ("", ""),
+
       scalaJSOptimizerOptions := OptimizerOptions(),
 
       jsDependencies := Seq(),
diff --git a/tools/jvm/src/main/scala/org/scalajs/core/tools/optimizer/ScalaJSClosureOptimizer.scala b/tools/jvm/src/main/scala/org/scalajs/core/tools/optimizer/ScalaJSClosureOptimizer.scala
@@ -85,28 +85,39 @@ class ScalaJSClosureOptimizer {
     }
 
     logTime(logger, "Closure: Write result") {
-      writeResult(result, compiler, cfg.output)
+      writeResult(result, compiler, cfg)
     }
   }
 
   private def writeResult(result: Result, compiler: ClosureCompiler,
-      output: WritableVirtualJSFile): Unit = {
+      cfg: Config): Unit = {
+    val output = cfg.output
 
-    val outputContent = if (result.errors.nonEmpty) ""
-    else "(function(){'use strict';" + compiler.toSource + "}).call(this);\n"
+    def withNewLine(str: String): String = if (str == "") "" else str + "\n"
+
+    val (header0, footer0) = cfg.customOutputWrapper
+    val header = withNewLine(header0) + "(function(){'use strict';\n"
+    val footer = "}).call(this);\n" + withNewLine(footer0)
+
+    val outputContent =
+      if (result.errors.nonEmpty) "// errors while producing source\n"
+      else compiler.toSource + "\n"
 
     val sourceMap = Option(compiler.getSourceMap())
 
     // Write optimized code
     val w = output.contentWriter
     try {
+      w.write(header)
       w.write(outputContent)
+      w.write(footer)
       if (sourceMap.isDefined)
         w.write("//# sourceMappingURL=" + output.name + ".map\n")
     } finally w.close()
 
     // Write source map (if available)
     sourceMap.foreach { sm =>
+      sm.setWrapperPrefix(header)
       val w = output.sourceMapWriter
       try sm.appendTo(w, output.name)
       finally w.close()
@@ -151,34 +162,225 @@ object ScalaJSClosureOptimizer {
   }
 
   /** Configuration for the output of the Scala.js Closure optimizer */
-  final case class Config(
+  final class Config private[Config] (
       /** Writer for the output */
-      output: WritableVirtualJSFile,
+      val output: WritableVirtualJSFile,
       /** Cache file */
-      cache: Option[WritableVirtualTextFile] = None,
+      val cache: Option[WritableVirtualTextFile],
       /** Whether to only warn if the linker has errors. Implicitly true, if
-       *  noWarnMissing is nonEmpty
-       */
-      bypassLinkingErrors: Boolean = false,
+       *  noWarnMissing is nonEmpty */
+      val bypassLinkingErrors: Boolean,
       /** If true, performs expensive checks of the IR for the used parts. */
-      checkIR: Boolean = false,
+      val checkIR: Boolean,
       /** If true, the optimizer removes trees that have not been used in the
        *  last run from the cache. Otherwise, all trees that has been used once,
        *  are kept in memory. */
-      unCache: Boolean = true,
+      val unCache: Boolean,
       /** If true, no optimizations are performed */
-      disableOptimizer: Boolean = false,
+      val disableOptimizer: Boolean,
       /** If true, nothing is performed incrementally */
-      batchMode: Boolean = false,
+      val batchMode: Boolean,
       /** Ask to produce source map for the output */
-      wantSourceMap: Boolean = false,
+      val wantSourceMap: Boolean,
       /** Pretty-print the output. */
-      prettyPrint: Boolean = false,
+      val prettyPrint: Boolean,
       /** Base path to relativize paths in the source map */
-      relativizeSourceMapBase: Option[URI] = None,
+      val relativizeSourceMapBase: Option[URI],
       /** Elements we won't warn even if they don't exist */
-      noWarnMissing: Seq[ScalaJSOptimizer.NoWarnMissing] = Nil
+      val noWarnMissing: Seq[ScalaJSOptimizer.NoWarnMissing],
+      /** Custom js code that wraps the output */
+      val customOutputWrapper: (String, String)
   ) extends OptimizerConfig with ScalaJSOptimizer.OptimizerConfig
+      /* for binary compatibility */ with Product with Serializable with Equals {
+
+    /* NOTE: This class was previously a case class and hence many useless
+     * methods were implemented for binary compatibility :(
+     */
+
+    // For binary compatibility
+    @deprecated("Use Config(output) and .withXYZ() methods", "0.6.5")
+    def this(
+        output: WritableVirtualJSFile,
+        cache: Option[WritableVirtualTextFile] = None,
+        bypassLinkingErrors: Boolean = false,
+        checkIR: Boolean = false,
+        unCache: Boolean = true,
+        disableOptimizer: Boolean = false,
+        batchMode: Boolean = false,
+        wantSourceMap: Boolean = false,
+        prettyPrint: Boolean = false,
+        relativizeSourceMapBase: Option[URI] = None,
+        noWarnMissing: Seq[ScalaJSOptimizer.NoWarnMissing] = Nil) = {
+
+      this(
+          output = output,
+          cache = cache,
+          bypassLinkingErrors = bypassLinkingErrors,
+          checkIR = checkIR,
+          unCache = unCache,
+          disableOptimizer = disableOptimizer,
+          batchMode = batchMode,
+          wantSourceMap = wantSourceMap,
+          prettyPrint = prettyPrint,
+          relativizeSourceMapBase = relativizeSourceMapBase,
+          noWarnMissing = noWarnMissing,
+          customOutputWrapper = ("", ""))
+    }
+
+    def withCache(cache: Option[WritableVirtualTextFile]): Config =
+      copyWith(cache = cache)
+
+    def withBypassLinkingErrors(bypassLinkingErrors: Boolean): Config =
+      copyWith(bypassLinkingErrors = bypassLinkingErrors)
+
+    def withCheckIR(checkIR: Boolean): Config =
+      copyWith(checkIR = checkIR)
+
+    def withUnCache(unCache: Boolean): Config =
+      copyWith(unCache = unCache)
+
+    def withDisableOptimizer(disableOptimizer: Boolean): Config =
+      copyWith(disableOptimizer = disableOptimizer)
+
+    def withBatchMode(batchMode: Boolean): Config =
+      copyWith(batchMode = batchMode)
+
+    def withWantSourceMap(wantSourceMap: Boolean): Config =
+      copyWith(wantSourceMap = wantSourceMap)
+
+    def withPrettyPrint(prettyPrint: Boolean): Config =
+      copyWith(prettyPrint = prettyPrint)
+
+    def withRelativizeSourceMapBase(relativizeSourceMapBase: Option[URI]): Config =
+      copyWith(relativizeSourceMapBase = relativizeSourceMapBase)
+
+    def withNoWarnMissing(noWarnMissing: Seq[ScalaJSOptimizer.NoWarnMissing]): Config =
+      copyWith(noWarnMissing = noWarnMissing)
+
+    def withCustomOutputWrapper(customOutputWrapper: (String, String)): Config =
+      copyWith(customOutputWrapper = customOutputWrapper)
+
+    @deprecated("Not a case class anymore", "0.6.5")
+    def copy(
+        output: WritableVirtualJSFile = this.output,
+        cache: Option[WritableVirtualTextFile] = this.cache,
+        bypassLinkingErrors: Boolean = this.bypassLinkingErrors,
+        checkIR: Boolean = this.checkIR,
+        unCache: Boolean = this.unCache,
+        disableOptimizer: Boolean = this.disableOptimizer,
+        batchMode: Boolean = this.batchMode,
+        wantSourceMap: Boolean = this.wantSourceMap,
+        prettyPrint: Boolean = this.prettyPrint,
+        relativizeSourceMapBase: Option[URI] = this.relativizeSourceMapBase,
+        noWarnMissing: Seq[ScalaJSOptimizer.NoWarnMissing] = this.noWarnMissing): Config = {
+
+      copyWith(output, cache, bypassLinkingErrors, checkIR, unCache,
+          disableOptimizer, batchMode, wantSourceMap, prettyPrint,
+          relativizeSourceMapBase, noWarnMissing)
+    }
+
+    private def copyWith(
+        output: WritableVirtualJSFile = this.output,
+        cache: Option[WritableVirtualTextFile] = this.cache,
+        bypassLinkingErrors: Boolean = this.bypassLinkingErrors,
+        checkIR: Boolean = this.checkIR,
+        unCache: Boolean = this.unCache,
+        disableOptimizer: Boolean = this.disableOptimizer,
+        batchMode: Boolean = this.batchMode,
+        wantSourceMap: Boolean = this.wantSourceMap,
+        prettyPrint: Boolean = this.prettyPrint,
+        relativizeSourceMapBase: Option[URI] = this.relativizeSourceMapBase,
+        noWarnMissing: Seq[ScalaJSOptimizer.NoWarnMissing] = this.noWarnMissing,
+        customOutputWrapper: (String, String) = this.customOutputWrapper): Config = {
+
+      new Config(output, cache, bypassLinkingErrors, checkIR, unCache,
+          disableOptimizer, batchMode, wantSourceMap, prettyPrint,
+          relativizeSourceMapBase, noWarnMissing, customOutputWrapper)
+    }
+
+    // For binary compatibility
+    @deprecated("Not a case class anymore", "0.6.5")
+    def canEqual(that: Any): Boolean = true
+
+    // For binary compatibility
+    @deprecated("Not a case class anymore", "0.6.5")
+    def productArity: Int = productArray.length
+
+    // For binary compatibility
+    @deprecated("Not a case class anymore", "0.6.5")
+    def productElement(n: Int): Any = productArray(n)
+
+    private def productArray: Array[Any] = {
+      Array[Any](output, cache, bypassLinkingErrors, checkIR, unCache,
+          disableOptimizer, batchMode, wantSourceMap, prettyPrint,
+          relativizeSourceMapBase, noWarnMissing, customOutputWrapper)
+    }
+
+    // For binary compatibility
+    override def equals(other: Any): Boolean = super.equals(other)
+
+    // For binary compatibility
+    override def hashCode(): Int = super.hashCode()
+
+    // For binary compatibility
+    override def toString(): String =
+      productArray.mkString("Config(", ", ", ")")
+  }
+
+  object Config extends runtime.AbstractFunction11[WritableVirtualJSFile,
+      Option[WritableVirtualTextFile], Boolean, Boolean, Boolean,
+      Boolean, Boolean, Boolean, Boolean, Option[URI],
+      Seq[ScalaJSOptimizer.NoWarnMissing], Config] {
+
+    def apply(output: WritableVirtualJSFile): Config = {
+      new Config(
+          output = output,
+          cache = None,
+          bypassLinkingErrors = false,
+          checkIR = false,
+          unCache = true,
+          disableOptimizer = false,
+          batchMode = false,
+          wantSourceMap = false,
+          prettyPrint = false,
+          relativizeSourceMapBase = None,
+          noWarnMissing = Nil,
+          customOutputWrapper = ("", ""))
+    }
+
+    // For binary compatibility
+    @deprecated("Use Config(output) and .withXYZ() methods", "0.6.5")
+    def apply(
+        output: WritableVirtualJSFile,
+        cache: Option[WritableVirtualTextFile] = None,
+        bypassLinkingErrors: Boolean = false,
+        checkIR: Boolean = false,
+        unCache: Boolean = true,
+        disableOptimizer: Boolean = false,
+        batchMode: Boolean = false,
+        wantSourceMap: Boolean = false,
+        prettyPrint: Boolean = false,
+        relativizeSourceMapBase: Option[URI] = None,
+        noWarnMissing: Seq[ScalaJSOptimizer.NoWarnMissing] = Nil): Config = {
+
+      new Config(output, cache, bypassLinkingErrors, checkIR, unCache,
+          disableOptimizer, batchMode, wantSourceMap, prettyPrint,
+          relativizeSourceMapBase, noWarnMissing, customOutputWrapper = ("", ""))
+    }
+
+    // For binary compatibility
+    @deprecated("Not a case class anymore", "0.6.5")
+    def unapply(config: Config): Option[(WritableVirtualJSFile,
+        Option[WritableVirtualTextFile], Boolean, Boolean, Boolean,
+        Boolean, Boolean, Boolean, Boolean, Option[URI],
+        Seq[ScalaJSOptimizer.NoWarnMissing])] = {
+
+      Some((config.output, config.cache, config.bypassLinkingErrors,
+          config.checkIR, config.unCache, config.disableOptimizer,
+          config.batchMode, config.wantSourceMap, config.prettyPrint,
+          config.relativizeSourceMapBase, config.noWarnMissing))
+    }
+  }
 
   /** Minimal set of externs to compile Scala.js-emitted code with Closure. */
   val ScalaJSExterns = """
diff --git a/tools/shared/src/main/scala/org/scalajs/core/tools/optimizer/Emitter.scala b/tools/shared/src/main/scala/org/scalajs/core/tools/optimizer/Emitter.scala
diff --git a/tools/shared/src/main/scala/org/scalajs/core/tools/optimizer/ScalaJSOptimizer.scala b/tools/shared/src/main/scala/org/scalajs/core/tools/optimizer/ScalaJSOptimizer.scala
