Implement pnpm, fix tests

Author: ptrdom

.github/workflows/ci.yml

@@ -15,6 +15,11 @@ jobs:
         with:
           java-version: "[email protected]"
       - uses: coursier/cache-action@v5
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16.14.2
+      - name: Setup yarn
+        run: npm install -g [email protected]
       - name: Unit tests
         run: sbt test
       - name: Scripted tests

sbt-scalajs-bundler/src/main/scala/scalajsbundler/PackageManager.scala

@@ -6,12 +6,11 @@ import sbt._
 import scalajsbundler.util.Commands
 import scalajsbundler.util.JSON
 
-/**
-  * Attempts to smoothen platform-specific differences when invoking commands.
-  *
-  * @param name Name of the command to run
-  */
-abstract class PackageManager(val name: String, val installCommand: String, val installArgs: Seq[String]) {
+abstract class PackageManager {
+
+  val name: String
+  val installCommand: String
+  val installArgs: Seq[String]
 
   /**
     * Runs the command `cmd`
@@ -118,29 +117,47 @@ trait LockFileSupport {
 }
 
 case class Npm(
+    name: String = "npm",
     lockFileName: String = "package-lock.json",
-    override val installCommand: String = "install",
-    override val installArgs: Seq[String] = Seq.empty,
+    installCommand: String = "install",
+    installArgs: Seq[String] = Seq.empty,
     addPackagesCommand: String = "install",
-    override val addPackagesArgs: Seq[String] = Seq.empty,
-) extends PackageManager("npm", "install", installArgs)
+    addPackagesArgs: Seq[String] = Seq.empty,
+) extends PackageManager
     with LockFileSupport
     with AddPackagesSupport {
   override val packageJsonContents: Map[String, JSON] = Map.empty
 }
 
 case class Yarn(
-    version: String,
+    name: String = "yarn",
+    version: Option[String] = None,
     lockFileName: String = "yarn.lock",
     override val installCommand: String = "install",
     override val installArgs: Seq[String] = Yarn.DefaultArgs,
     addPackagesCommand: String = "add",
     override val addPackagesArgs: Seq[String] = Yarn.DefaultArgs
-) extends PackageManager("yarn", "install", installArgs)
+) extends PackageManager
     with LockFileSupport
     with AddPackagesSupport {
-  override val packageJsonContents: Map[String, JSON] = Map("packageManager" -> JSON.str(s"yarn@$version"))
+  override val packageJsonContents: Map[String, JSON] =
+    version.map(v => Map("packageManager" -> JSON.str(s"$name@$v"))).getOrElse(Map.empty)
 }
 object Yarn {
   val DefaultArgs: Seq[String] = Seq("--non-interactive", "--mutex", "network")
 }
+
+case class Pnpm(
+    name: String = "pnpm",
+    version: Option[String] = None,
+    lockFileName: String = "pnpm-lock.yaml",
+    override val installCommand: String = "install",
+    override val installArgs: Seq[String] = Seq.empty,
+    addPackagesCommand: String = "add",
+    override val addPackagesArgs: Seq[String] = Seq.empty
+) extends PackageManager
+    with LockFileSupport
+    with AddPackagesSupport {
+  override val packageJsonContents: Map[String, JSON] =
+    version.map(v => Map("packageManager" -> JSON.str(s"$name@$v"))).getOrElse(Map.empty)
+}

sbt-scalajs-bundler/src/main/scala/scalajsbundler/sbtplugin/PackageJsonTasks.scala

@@ -43,7 +43,8 @@ object PackageJsonTasks {
       fullClasspath.map(_.data.name).toString,
       webpackVersion,
       webpackDevServerVersion,
-      webpackCliVersion
+      webpackCliVersion,
+      packageManager.toString
     ).mkString(",")
 
     val packageJsonFile = targetDir / "package.json"

sbt-scalajs-bundler/src/sbt-test/sbt-scalajs-bundler/custom-test-config/build.sbt

@@ -25,7 +25,7 @@ requireJsDomEnv in Test := true
 
 webpackBundlingMode := BundlingMode.LibraryAndApplication()
 
-useYarn := true
+packageManager := scalajsbundler.Yarn()
 
 npmDependencies in Compile ++= Seq(
   "react"     -> reactJS,

sbt-scalajs-bundler/src/sbt-test/sbt-scalajs-bundler/global-namespace-with-jsdom-unit-testing/build.sbt

@@ -28,6 +28,6 @@ requireJsDomEnv in Test := true
 
 version in installJsdom := "12.0.0"
 
-useYarn := true
+packageManager := scalajsbundler.Yarn()
 
 ivyLoggingLevel in ThisBuild := UpdateLogging.Quiet

sbt-scalajs-bundler/src/sbt-test/sbt-scalajs-bundler/npm/build.sbt

@@ -0,0 +1,11 @@
+scalaVersion := "2.12.8"
+
+packageManager := scalajsbundler.Npm()
+
+scalaJSUseMainModuleInitializer := true
+
+npmDependencies in Compile += "neat" -> "2.1.0"
+
+enablePlugins(ScalaJSBundlerPlugin)
+
+ivyLoggingLevel in ThisBuild := UpdateLogging.Quiet

sbt-scalajs-bundler/src/sbt-test/sbt-scalajs-bundler/npm/project/plugins.sbt

@@ -0,0 +1,8 @@
+val scalaJSVersion = sys.props.getOrElse("scalajs.version", sys.error("'scalajs.version' environment variable is not defined"))
+val scalaJSBundlerVersion = sys.props.getOrElse("plugin.version", sys.error("'plugin.version' environment variable is not set"))
+
+addSbtPlugin("org.scala-js" % "sbt-scalajs" % scalaJSVersion)
+
+addSbtPlugin("ch.epfl.scala" % "sbt-scalajs-bundler" % scalaJSBundlerVersion)
+
+ivyLoggingLevel in ThisBuild := UpdateLogging.Quiet

sbt-scalajs-bundler/src/sbt-test/sbt-scalajs-bundler/npm/src/main/scala/example/Main.scala

@@ -0,0 +1,7 @@
+package example
+
+object Main {
+  def main(args: Array[String]): Unit = {
+    println("npm main")
+  }
+}

sbt-scalajs-bundler/src/sbt-test/sbt-scalajs-bundler/npm/test

@@ -0,0 +1,2 @@
+> fastOptJS::webpack
+$ exists package-lock.json

sbt-scalajs-bundler/src/sbt-test/sbt-scalajs-bundler/pnpm/build.sbt

@@ -0,0 +1,11 @@
+scalaVersion := "2.12.8"
+
+packageManager := scalajsbundler.Pnpm(version = Some("7.0.1"))
+
+scalaJSUseMainModuleInitializer := true
+
+npmDependencies in Compile += "neat" -> "2.1.0"
+
+enablePlugins(ScalaJSBundlerPlugin)
+
+ivyLoggingLevel in ThisBuild := UpdateLogging.Quiet