This is the SBT-based plugin for the scala2ts project. Scala2TS is a Scala to Typescript transpiler that takes a variety of Scala constructs and emits Typescript-compliant code.

Currently handles:

• Case Classes
• Sealed Trait Hierarchies
• General Traits
• Generics
• Primitives
• Collections/Map
• java.time.*
• UUID
• Enums (Scala and Enumeratum's EnumEntry)
  • Only supporting plain Enumeratum sealed trait enums without any name-trait mixins.

// project/plugins.sbt

addSbtPlugin("com.github.scala2ts" % "scala2ts-sbt" % "1.1.0")

// build.sbt

lazy val root = (project in file("."))
  .enablePlugins(Scala2TSPlugin)
  .settings(
    // Configuration options below
  )

No need to mess with running any SBT tasks, once you run compile the Typescript interfaces are emitted to your outDir.

The scala2ts-core compiler plugin emits a Typescript implementation file (.ts) versus a declaration file (.d.ts).

A declaration file can be consumed by any Typescript project with relative ease while consuming an implementation file, usually through an npm module, causes issues when compiling your project. This is because most frontend build tooling expects npm modules to be transplied and in vanilla Javascript (unless you tune your bundlers correctly).

This plugin ships with the ability to transpile the emitted implementation file using the shipped WebJar typescript compiler using the tsTranspile task. You shouldn't need to have tsc or node installed locally for this to work as it leverages the sbt-js-engine plugin (and will fallback to the Trireme node runtime if node is not found locally)

This task produces a transpiled .js file as well as a .d.ts declaration file that is then safe to publish or consume locally in any Typescript or Javascript project.

All configuration options are prefixed with ts.

A Seq of Regexes can be passed to tsIncludeTypes to include a certain set of packages to be transpiled by scala2ts.

// build.sbt

lazy val root = (project in file("."))
  .enablePlugins(Scala2TSPlugin)
  .settings(
    tsEnable := true,
    tsIncludeTypes := Seq(
      "com\\.some\\.package".r,
      "org\\.some\\.other\\.package".r
    )
  )

One can emit the transpiled typescript anywhere, but usually it's emitted to SBT's build directory.

// build.sbt

lazy val root = (project in file("."))
  .enablePlugins(Scala2TSPlugin)
  .settings(
    tsEnable := true,
    tsIncludeTypes := Seq(
      "com\\.some\\.package".r,
      "org\\.some\\.other\\.package".r
    ),
    tsOutDir := {
      val targetPath = (target in Compile).value.getPath
    
      s"${targetPath}/typescript"
    } 
  )

// build.sbt

lazy val root = (project in file("."))
  .enablePlugins(Scala2TSPlugin)
  .settings(
    tsEnable := true,
    tsIncludeTypes := Seq(
      "com\\.some\\.package".r,
      "org\\.some\\.other\\.package".r
    ),
    tsOutDir := {
      val targetPath = (target in Compile).value.getPath
    
      s"${targetPath}/typescript"
    },
    tsPackageJsonName := "@yourcompany/types",
    tsPackageJsonVersion := version.value,
  )