Add support for JSDOM JSEnv (#456)

* Setup JSDOM in the build

* Add support for JSDOM

* Shuffling and fixing

* More fixes, runs on JSDOM :)

* Formatting

* Formatting

* Use %%%

* Add JSDOM to CI

* Add runtimeJSDOMTest to root aggregate

* Add npm package.json and lockfile

* Update CONTRIBUTING, .gitignore w/ npm stuff

Author: armanbilge

.github/workflows/ci.yml

@@ -39,6 +39,9 @@ jobs:
           distribution: 'temurin'
           java-version: ${{ matrix.java }}
 
+      - name: Install JSDOM
+        run: npm install
+
       - name: run tests
         run: sbt ++${{ matrix.scala.version }} plugin/test
 

.gitignore

@@ -18,4 +18,7 @@ credentials.sbt
 # IntelliJ IDEA specific
 .idea
 .idea_modules
-*.iml
+*.iml
+
+# npm specific
+node_modules/

CONTRIBUTING.md

@@ -1,5 +1,8 @@
 # Contributing
 
+To run the tests, you will first need to run `npm install`. This will
+install the JSDOM dependency used to run some of the Scala.js tests.
+
 When working in the code base it's a good idea to utilize the
 `.git-blame-ignore-revs` file at the root of this project. You can add it
 locally by doing a:

build.sbt

@@ -85,7 +85,7 @@ lazy val sharedSettings = List(
       scalacOptions.value
     }
   },
-  libraryDependencies += "org.scalameta" %% "munit" % munitVersion % Test
+  libraryDependencies += "org.scalameta" %%% "munit" % munitVersion % Test
 )
 
 lazy val root = Project("scalac-scoverage", file("."))
@@ -94,7 +94,15 @@ lazy val root = Project("scalac-scoverage", file("."))
     publishArtifact := false,
     publishLocal := {}
   )
-  .aggregate(plugin, runtime.jvm, runtime.js, reporter, domain, serializer)
+  .aggregate(
+    plugin,
+    runtime.jvm,
+    runtime.js,
+    runtimeJSDOMTest,
+    reporter,
+    domain,
+    serializer
+  )
 
 lazy val runtime = CrossProject(
   "runtime",
@@ -118,6 +126,16 @@ lazy val runtime = CrossProject(
 lazy val `runtimeJVM` = runtime.jvm
 lazy val `runtimeJS` = runtime.js
 
+lazy val runtimeJSDOMTest =
+  project
+    .enablePlugins(ScalaJSPlugin)
+    .dependsOn(runtimeJS % "test->test")
+    .settings(
+      publishArtifact := false,
+      publishLocal := {},
+      jsEnv := new org.scalajs.jsenv.jsdomnodejs.JSDOMNodeJSEnv()
+    )
+
 lazy val plugin =
   project
     .dependsOn(runtimeJVM % Test)