sbt-typescript's Introduction

sbt-typescript

An SBT plugin to run the TypeScript compiler inside of SBT.

The Typescript compiler is provided by this fork. This fork also supports compilation of typescript classes to ExtJs classes.

Currently it supports typescript 1.8

To use this plugin add the following to your plugins.sbt file:

addSbtPlugin("com.typesafe.sbt" % "sbt-web" % "1.4.4")
addSbtPlugin("com.typesafe.sbt" % "sbt-js-engine" % "1.2.3")
addSbtPlugin("be.venneborg.sbt" % "sbt-typescript" % "1.1.0")

This plugin is compatible with sbt-web.

Usage

Simply run the tsc command to invoke the TypeScript compiler.

Use with sbt-web

To use this plugin with sbt-web start by enabling SbtWeb in your build.sbt file:

lazy val root = (project in file(".")).enablePlugins(SbtWeb)

Once configured, any *.ts files placed in src/main/assets will be compiled to JavaScript code in target/web/public.

Supported settings:

sourceMap When set, generates sourceMap files. Defaults to false.

TypeScriptKeys.sourceMap := true
esTarget Which ECMAScript version to transpile to . Defaults to ES5.

TypeScriptKeys.esTarget := 'ES5'
noImplicitAny When set, warn on expressions and declarations with an implied 'any' type. Default to false.

TypeScriptKeys.noImplicitAny := true
removeComments When set, do not emit comments to output. Defaults to false.

TypeScriptKeys.removeComments := true
moduleType Specify module code generation: Can be 'ExtJs', 'Commonjs' or 'Amd'. Defaults to ExtJs.

TypeScriptKeys.moduleType in Assets := TypeScriptKeys.ModuleType.Amd TypeScriptKeys.moduleType in TestAssets := TypeScriptKeys.ModuleType.CommonJs