https://github.com/sbt/sbt-coffeescript

A CoffeeScript plugin for SBT
https://github.com/sbt/sbt-coffeescript

Last synced: 3 months ago
JSON representation

A CoffeeScript plugin for SBT

• Host: GitHub
• URL: https://github.com/sbt/sbt-coffeescript
• Owner: sbt
• License: other
• Fork: true (richdougherty/sbt-coffeescript)
• Created: 2014-02-11T01:10:42.000Z (almost 11 years ago)
• Default Branch: main
• Last Pushed: 2024-10-16T09:43:00.000Z (4 months ago)
• Last Synced: 2024-10-18T05:52:23.740Z (4 months ago)
• Language: Scala
• Size: 214 KB
• Stars: 14
• Watchers: 9
• Forks: 24
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-sbt-plugins - sbt-coffeescript

README

        
sbt-coffeescript

================

[![Build Status](https://github.com/sbt/sbt-coffeescript/actions/workflows/build-test.yml/badge.svg)](https://github.com/sbt/sbt-coffeescript/actions/workflows/build-test.yml)

An SBT plugin to compile [CoffeeScript](http://coffeescript.org/) sources to JavaScript.

To use this plugin use the addSbtPlugin command within your `project/plugins.sbt` file:

    addSbtPlugin("com.github.sbt" % "sbt-coffeescript" % "2.0.0")

Your project's build file also needs to enable sbt-web plugins. For example with build.sbt:

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

Once configured, any `*.coffee` or `*.litcoffee` 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 `true`.

  `CoffeeScriptKeys.sourceMap := true`

* `bare` When set, generates JavaScript without the [top-level function safety wrapper](http://coffeescript.org/#lexical-scope). Defaults to `false`.

  `CoffeeScriptKeys.bare := false`

The plugin is built on top of [JavaScript Engine](https://github.com/sbt/sbt-js-engine) which supports different JavaScript runtimes.