copying scala.js linker artifacts after linking

copying scala.js linker artifacts after linking

There have been a few requests for a plugin to copy the scala.js linker artifacts to another location after the linker has run. While you could set the output path for the artifact to a different location, you may want to have the artifacts generated into the standard location then copy it to somewhere else to provide better compatibility with existing tooling.

Ad-hoc Approach

Here’s one way to add a copy process to a specific sub-project:

def copyTask(odir: String) = {
  lazy val copyJSOutput = taskKey[Unit]("copy scala.js linker outputs to another location")
  Seq(
    copyJSOutput := {
      println(s"Copying artifact ${scalaJSLinkedFile.in(Compile).value.path} to [${odir}]")
      val src = file(scalaJSLinkedFile.in(Compile).value.path)
      IO.copy(Seq(
        (src, file(odir) / src.name),
        (file(src.getCanonicalPath() + ".map"), file(odir) / (src.name + ".map"))
      ), CopyOptions(true, true, true))
    },
    fastOptJS / copyJSOutput := (copyJSOutput triggeredBy fastOptJS.in(Compile)).value,
    fullOptJS / copyJSOutput := (copyJSOutput triggeredBy fullOptJS.in(Compile)).value
  )
}

Notice that dev and prod linker tasks are modified. This does not show testing artifacts being changed.

Modify your project definition to use:

lazy val myproject = project.in(...)
   .settings(copyTask("../node-server/src"))

Create a Plugin

You can also create a plugin in projects/CopyScalaJS.scala

package ttg
package scalajs

import sbt._
import Keys._
import org.scalajs.sbtplugin.ScalaJSPlugin
import org.scalajs.sbtplugin.ScalaJSPlugin.autoImport._

/**
 * Copy JS linker artifacts to another location. Add to your project to enable.
 */
object CopyJSPlugin extends AutoPlugin {
  override def requires = ScalaJSPlugin

  final object autoImport {
    val copyTarget = SettingKey[String]("copyTarget", "scala.js linker artifact copy target directory")
    val copyJS = TaskKey[Unit]("copyJS", "Copy scala.js linker artifacts to another location after linking.")
  }
  import autoImport._

  override lazy val projectSettings = Seq(
    copyJS := copyJSTask.value,
    fastOptJS / copyJS := (copyJS triggeredBy fastOptJS.in(Compile)).value,
    fullOptJS / copyJS := (copyJS triggeredBy fullOptJS.in(Compile)).value
  )
  //define inline via `copyJS := {` or separately like this
  private def copyJSTask = Def.task {
      val odir = copyTarget.value
      println(s"Copying artifact ${scalaJSLinkedFile.in(Compile).value.path} to [${odir}]")
      val src = file(scalaJSLinkedFile.in(Compile).value.path)
      IO.copy(Seq(
        (src, file(odir) / src.name),
        (file(src.getCanonicalPath() + ".map"), file(odir) / (src.name + ".map"))
      ), CopyOptions(true, true, true))
    }
}

Enable like any other plugin:

lazy val myproject = ...
  .enablePlugins(CopyJSPlugin)
  .setting(copyTarget := "../somedir")

If you forget to set copyTarget you will have a sbt static compilation error when trying to load the project file.

Comments

Post a Comment

Popular posts from this blog

quick note on scala.js, react hooks, monix, auth

quick note on scala.js, react hooks, monix, auth Reactjs hooks finally came out of preview in a recent version of React. scalajs-reaction has had support for hooks since they were in preview. React hooks seem like the hot new thing but for me the question is, do hooks help improve your code by improving maintainability, time to market, TCO, etc.? Let’s take a look using authentication as an example and employ monix , a reactive observable framework that also builds on cats . We will assume we are building a SPA. Does it improve your code and make your application & development experience better? Auth Auth processing can be complex. Many react auth examples you find in blogs like to show how to use “react-routing” and “auth” as a switch that determines which routes are protected or unprotected. Protected routes show application specific data. Unprotected routes show login content . Based on storing a “User” object in the browser session/local storage, th...
Read more

attributes with react and typescript.md

If you use typescript with react you may wonder what the right signature is for your “properties” interface. Obviously, your component will have few to many specific properties that reflect your domain. However, you may wish to also provide for the ability to add other attributes, such as those valid for a div property. In other words, you want to extend your props interface with that of the properties from a div element. How do you do that? There are really two issues: How do you extend your props interfaces How do you filter the props once you receive them to just those that apply. Extend Your Prop Interface or Use Sum Types It’s not uncommon to see interface Props { className ? : string yourProp ? : number } with the idea of using it in class MyComponent extends React.Component<Props, any> somewhere. If your component will have an outer div, you may also pass in a react element so that its configurable. But let’s say your outer element is a div and you wan...
Read more

zio environment and modules pattern: zio, scala.js, react, query management

zio environment and modules pattern: zio, scala.js, react, query management This blog covers a zio-based fetch design for scala.js, react web applications. It heavily uses the zio “environment” feature to help motivate a point of view on the modules pattern in effect systems. At the end, I summarize some thoughts on ergonomics and complexity. This blog assumes a basic knowledge of zio and react. scala.js is just like scala so you mostly already know scala.js. This blog is a follow-on to previous blogs: https://appddeevvmeanderings.blogspot.com/2019/10/scalajs-react-fetcher-hook_48.html and https://appddeevvmeanderings.blogspot.com/2019/11/scalajs-and-react-suspense.html . I have been keeping an eye on and culling ideas from typscript/javascript fetching libraries that address query management concerns. The formulation below incorporates some of those concerns but does not try to comprehensively duplicate well established javascript libraries. I only care about ...
Read more