Merge pull request #20 from UdashFramework/commonjs-module

CommonJS module

Author: Starzu

.travis.yml

@@ -4,7 +4,7 @@ dist: trusty
 jdk: oraclejdk8
 scala:
   - 2.11.12
-  - 2.12.6
+  - 2.12.7
 
 before_script:
   - "export DISPLAY=:99.0"
@@ -24,4 +24,4 @@ before_script:
 script:
   - sbt ++$TRAVIS_SCALA_VERSION test
   - sbt ++$TRAVIS_SCALA_VERSION publishLocal
-  - cd example && sbt ++$TRAVIS_SCALA_VERSION compile fullOptJS
+  - cd example && sbt ++$TRAVIS_SCALA_VERSION compile jquery-global-demo/fullOptJS jquery-bundler-demo/compileStatics

README.md

@@ -7,7 +7,7 @@ Static types for the jQuery API for [Scala.js](http://www.scala-js.org/) program
 Add the following dependency to your SBT build:
 
 ```scala
-libraryDependencies += "io.udash" %%% "udash-jquery" % "2.0.0"
+libraryDependencies += "io.udash" %%% "udash-jquery" % "3.0.0"
 ```
 
 then import the jQuery package: 
@@ -16,8 +16,10 @@ then import the jQuery package:
 import io.udash.wrappers.jquery._
 ```
 
-Since version `2.0.0` the wrapper does not force JS dependency on jQuery. You have to 
-add it manually by:
+Since version `3.0.0` the wrapper is published as a CommonJS module with JS dependencies managed 
+by [scalajs-bundler](https://github.com/scalacenter/scalajs-bundler). 
+
+If you do not want to use the bundler, you have to include jQuery sources manually by:
  * explicit link in your `index.html`.
  ```html
  <script src="https://code.jquery.com/jquery-3.3.1.min.js" 

build.sbt

@@ -1,14 +1,15 @@
 import org.openqa.selenium.chrome.ChromeOptions
-import org.openqa.selenium.remote.DesiredCapabilities
-import org.scalajs.jsenv.selenium.SeleniumJSEnv
 
 name := "udash-jquery"
 
 inThisBuild(Seq(
-  version := "2.0.1",
+  version := "3.0.0-SNAPSHOT",
   organization := "io.udash",
-  scalaVersion := "2.12.6",
-  crossScalaVersions := Seq("2.11.12", "2.12.6"),
+))
+
+val commonSettings = Seq(
+  scalaVersion := "2.12.7",
+  crossScalaVersions := Seq("2.11.12", "2.12.7"),
   scalacOptions ++= Seq(
     "-feature",
     "-deprecation",
@@ -20,35 +21,25 @@ inThisBuild(Seq(
     "-language:experimental.macros",
     "-Xfuture",
     "-Xfatal-warnings",
-    "-Xlint:_",
+    "-Xlint:_"
   ),
   scalacOptions ++= {
-    if (CrossVersion.partialVersion((root / scalaVersion).value).contains((2, 12))) Seq(
+    if (scalaBinaryVersion.value == "2.12") Seq(
       "-Ywarn-unused:_,-explicits,-implicits",
       "-Ybackend-parallelism", "4",
       "-Ycache-plugin-class-loader:last-modified",
       "-Ycache-macro-class-loader:last-modified"
     ) else Seq.empty
-  },
-))
-
-// Settings for JS tests run in browser
-val browserCapabilities: DesiredCapabilities = {
-  // requires ChromeDriver: https://sites.google.com/a/chromium.org/chromedriver/
-  val capabilities = DesiredCapabilities.chrome()
-  capabilities.setCapability(ChromeOptions.CAPABILITY, {
-    val options = new ChromeOptions()
-    options.addArguments("--headless", "--disable-gpu")
-    options
-  })
-  capabilities
-}
+  }
+)
 
 val commonJSSettings = Seq(
   Compile / emitSourceMaps := true,
   Test / parallelExecution := false,
   Test / scalaJSStage := FastOptStage,
-  Test / jsEnv := new SeleniumJSEnv(browserCapabilities),
+  // ScalaJSBundlerPlugin does not work with scalajs-env-selenium:
+  // https://github.com/scalacenter/scalajs-bundler/issues/89
+  // Test / jsEnv := new SeleniumJSEnv(browserCapabilities),
   scalacOptions += {
     val localDir = (ThisBuild / baseDirectory).value.toURI.toString
     val githubDir = "https://raw.githubusercontent.com/UdashFramework/scala-js-jquery"
@@ -57,15 +48,18 @@ val commonJSSettings = Seq(
   scalacOptions += "-P:scalajs:sjsDefinedByDefault",
 )
 
-libraryDependencies ++= Seq(
-  "org.scala-js" %%% "scalajs-dom" % "0.9.6",
-  "org.scalatest" %%% "scalatest" % "3.0.5" % Test,
-  "com.lihaoyi" %%% "scalatags" % "0.6.7" % Test
-)
+lazy val root = project.in(file("."))
+  .enablePlugins(ScalaJSBundlerPlugin)
+  .settings(
+    commonSettings,
+    commonJSSettings,
 
-jsDependencies +=
-  "org.webjars" % "jquery" % "3.3.1" % Test / "3.3.1/jquery.js" minified "3.3.1/jquery.min.js"
+    libraryDependencies ++= Seq(
+      "org.scala-js" %%% "scalajs-dom" % "0.9.6",
+      "org.scalatest" %%% "scalatest" % "3.0.5" % Test,
+      "com.lihaoyi" %%% "scalatags" % "0.6.7" % Test
+    ),
 
-lazy val root = project.in(file("."))
-  .enablePlugins(ScalaJSPlugin)
-  .settings(commonJSSettings)
+    Compile / npmDependencies += "jquery" -> "3.3.1",
+    Test / requireJsDomEnv := true
+  )

example/README.md

@@ -1,4 +1,13 @@
+The `build.sbt` file contains two configurations:
+* `jquery-global-demo` uses global jQuery dependency.
+* `jquery-bundler-demo` uses `ScalaJSBundlerPlugin` in order to manage module dependencies. 
+
 ### How to use?
 
-Run `sbt fastOptJS` or `sbt fullOptJS` to compile this demo. You can find all generated files 
-in the `generated` directory. Open `index.html` in your browser. 
+Run `sbt jquery-global-demo/fastOptJS` or `sbt jquery-global-demo/fullOptJS` to compile this demo. You can find all generated files 
+in the `generated/global` directory. Open `index.html` in your browser. 
+
+### How to use? (ScalaJSBundlerPlugin)
+
+Run `sbt jquery-bundler-demo/compileStatics` to compile this demo. You can find all generated files 
+in the `generated/bundler` directory. Open `index.html` in your browser. 

example/build.sbt

@@ -1,10 +1,13 @@
 name := "jquery-demo"
 
 inThisBuild(Seq(
-  version := "2.0.0",
+  version := "3.0.0",
   organization := "io.udash",
-  scalaVersion := "2.12.6",
-  crossScalaVersions := Seq("2.11.12", "2.12.6"),
+))
+
+val commonSettings = Seq(
+  scalaVersion := "2.12.7",
+  crossScalaVersions := Seq("2.11.12", "2.12.7"),
   scalacOptions ++= Seq(
     "-feature",
     "-deprecation",
@@ -18,27 +21,37 @@ inThisBuild(Seq(
     "-Xlint:_",
   ),
   scalacOptions ++= {
-    if (CrossVersion.partialVersion((`jquery-demo` / scalaVersion).value).contains((2, 12))) Seq(
+    if (scalaBinaryVersion.value == "2.12") Seq(
       "-Ywarn-unused:_,-explicits,-implicits",
       "-Ybackend-parallelism", "4",
       "-Ycache-plugin-class-loader:last-modified",
       "-Ycache-macro-class-loader:last-modified"
     ) else Seq.empty
   },
-))
 
-val generatedDir = file("generated")
+  libraryDependencies ++= Dependencies.deps.value
+)
+
+val generatedGlobalDir = file("generated/global")
 val copyAssets = taskKey[Unit]("Copies all assets to the target directory.")
-val `jquery-demo` = project.in(file(".")).enablePlugins(ScalaJSPlugin)
+val root = project.in(file("."))
+  .enablePlugins(ScalaJSPlugin)
+  .settings(commonSettings)
+
+val `jquery-global-demo` = project.in(file("global-demo"))
+  .enablePlugins(ScalaJSPlugin)
   .settings(
-    libraryDependencies ++= Dependencies.deps.value,
+    commonSettings,
+
     jsDependencies ++= Dependencies.jsDeps.value,
 
+    sourceDirsSettings(_.getParentFile),
+
     /* move these files out of target/. */
-    Compile / fullOptJS / crossTarget := generatedDir,
-    Compile / fastOptJS / crossTarget := generatedDir,
-    Compile / packageJSDependencies / crossTarget := generatedDir,
-    Compile / packageMinifiedJSDependencies / crossTarget := generatedDir,
+    Compile / fullOptJS / crossTarget := generatedGlobalDir,
+    Compile / fastOptJS / crossTarget := generatedGlobalDir,
+    Compile / packageJSDependencies / crossTarget := generatedGlobalDir,
+    Compile / packageMinifiedJSDependencies / crossTarget := generatedGlobalDir,
 
     Compile / fastOptJS := (Compile / fastOptJS).dependsOn(copyAssets).value,
     Compile / fullOptJS := (Compile / fullOptJS).dependsOn(copyAssets).value,
@@ -48,7 +61,7 @@ val `jquery-demo` = project.in(file(".")).enablePlugins(ScalaJSPlugin)
     copyAssets := {
       IO.copyFile(
         sourceDirectory.value / "main/assets/index.html",
-        generatedDir / "index.html"
+        generatedGlobalDir / "index.html"
       )
     },
 
@@ -60,4 +73,57 @@ val `jquery-demo` = project.in(file(".")).enablePlugins(ScalaJSPlugin)
       (Compile / packageJSDependencies / crossTarget).value / "scripts" / "frontend-deps.js",
     Compile / packageMinifiedJSDependencies / artifactPath :=
       (Compile / packageMinifiedJSDependencies / crossTarget).value / "scripts" / "frontend-deps.js"
-  )
+  )
+
+val generatedBundlerDir = file("generated/bundler")
+val compileStatics = taskKey[Unit]("Compiles all static files.")
+val `jquery-bundler-demo` = project.in(file("bundler-demo"))
+  .enablePlugins(ScalaJSBundlerPlugin)
+  .settings(
+    commonSettings,
+
+    sourceDirsSettings(_.getParentFile),
+
+    Compile / scalaJSUseMainModuleInitializer := true,
+
+    copyAssets := {
+      IO.copyFile(
+        sourceDirectory.value / "main/assets/index.html",
+        generatedBundlerDir / "index.html"
+      )
+    },
+
+    compileStatics := {
+      val sjsFileName = (Compile / fastOptJS).value.data.name.stripSuffix(".js")
+      IO.copyFile(
+        (Compile / npmUpdate / crossTarget).value / s"$sjsFileName-bundle.js",
+        generatedBundlerDir / "scripts/frontend.js"
+      )
+      IO.copyFile(
+        (Compile / npmUpdate / crossTarget).value / s"$sjsFileName-bundle.js.map",
+        generatedBundlerDir / "scripts/frontend.js.map"
+      )
+    },
+    compileStatics := compileStatics.dependsOn(Compile / fastOptJS / webpack, copyAssets).value,
+  )
+
+def mkSourceDirs(base: File, scalaBinary: String, conf: String): Seq[File] = Seq(
+  base / "src" / conf / "scala",
+  base / "src" / conf / s"scala-$scalaBinary",
+  base / "src" / conf / "java"
+)
+
+def mkResourceDirs(base: File, conf: String): Seq[File] = Seq(
+  base / "src" / conf / "resources"
+)
+
+def sourceDirsSettings(baseMapper: File => File) = Seq(
+  Compile / unmanagedSourceDirectories ++=
+    mkSourceDirs(baseMapper(baseDirectory.value), scalaBinaryVersion.value, "main"),
+  Compile / unmanagedResourceDirectories ++=
+    mkResourceDirs(baseMapper(baseDirectory.value), "main"),
+  Test / unmanagedSourceDirectories ++=
+    mkSourceDirs(baseMapper(baseDirectory.value), scalaBinaryVersion.value, "test"),
+  Test / unmanagedResourceDirectories ++=
+    mkResourceDirs(baseMapper(baseDirectory.value), "test"),
+)

example/bundler-demo/src/main/assets/index.html

@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html>
+<head lang="en">
+    <meta charset="UTF-8">
+    <title>jquery-demo - ScalaJSBundlerPlugin demo</title>
+</head>
+<body>
+  <div id="application"></div>
+
+  <script src="scripts/frontend.js"></script>
+</body>
+</html>

example/global-demo/src/main/assets/index.html

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+<head lang="en">
+    <meta charset="UTF-8">
+    <title>jquery-demo - global scope</title>
+</head>
+<body>
+  <div id="application"></div>
+
+  <script src="scripts/frontend-deps.js"></script>
+  <script src="scripts/frontend-impl.js"></script>
+</body>
+</html>

example/project/Dependencies.scala

@@ -4,7 +4,7 @@ import sbt._
 
 object Dependencies {
   val udashCoreVersion = "0.6.1"
-  val udashJQueryVersion = "2.0.0"
+  val udashJQueryVersion = "3.0.0-SNAPSHOT"
 
   val deps = Def.setting(Seq[ModuleID](
     "io.udash" %%% "udash-core-frontend" % udashCoreVersion,

example/project/build.properties

@@ -1 +1 @@
-sbt.version = 1.2.0
+sbt.version = 1.2.6

example/project/plugins.sbt

@@ -1,3 +1,4 @@
 logLevel := Level.Warn
 
-addSbtPlugin("org.scala-js" % "sbt-scalajs" % "0.6.24")
+addSbtPlugin("org.scala-js" % "sbt-scalajs" % "0.6.25")
+addSbtPlugin("ch.epfl.scala" % "sbt-scalajs-bundler" % "0.14.0")