https://github.com/softprops/sbt-growl-plugin

Growling sbt test results so you don't have to
https://github.com/softprops/sbt-growl-plugin

Last synced: about 1 year ago
JSON representation

Growling sbt test results so you don't have to

• Host: GitHub
• URL: https://github.com/softprops/sbt-growl-plugin
• Owner: softprops
• License: mit
• Created: 2010-02-06T20:29:46.000Z (over 16 years ago)
• Default Branch: master
• Last Pushed: 2019-08-22T14:03:17.000Z (almost 7 years ago)
• Last Synced: 2025-03-17T12:00:01.137Z (over 1 year ago)
• Language: Scala
• Homepage:
• Size: 54.7 KB
• Stars: 54
• Watchers: 4
• Forks: 14
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Growling Tests

An [sbt](https://github.com/harrah/xsbt#readme) 0.12.* plugin that growls/notifies test results.

## Install

### On Mac

Install the [growl](http://growl.info/) extra [growlnotify](http://growl.info/extras.php#growlnotify) commandline client, make sure it's in your path and you have growl turned on.

### On Ubuntu

Install the `libnotify-bin` package.

    sudo apt-get install libnotify-bin

### On Windows (7) / GIT bash

Install the `growl for windows` package. This is available from [growl for windows](http://www.growlforwindows.com/gfw/help/growlnotify.aspx). This must be on the windows path. Note that the usage of growlnotify has only been tested from cygwin (specifically GIT bash). The sbt growl plugin uses growlnotify.exe, not growlnotify.com.

### Project Configuration

To install on a per-project basis, add the following to your plugin definition file

    addSbtPlugin("me.lessis" % "sbt-growl-plugin" % "0.1.3")

    resolvers += Classpaths.sbtPluginReleases

To install globally, create a `Build.scala` file under `~/.sbt/plugins/project` directory and add the following

    import sbt._

    object PluginDef extends Build {

      override def projects = Seq(root)

      lazy val root = Project("plugins", file(".")) dependsOn(growl)

      lazy val growl = uri("git://github.com/softprops/sbt-growl-plugin.git#0.1.3")

    }

Run your tests with the sbt `test` task and you'll see the magikz.

## Configuring Icons

By default the growl plugin looks for icons in `~/.sbt/growl/icons/`.  Specifically, it looks for:

* `pass.png` - used when tests pass

* `fail.png` - used when tests fail

* `error.png` - used for catastrophic failures

If an icon is not found for Growl, the plugin extracts a Scala logo and places it in `~/.sbt/growl/icons/scala-logo.png` to use for notifications.

The directory in which Growl looks for icons can be configured by adding this to your `build.sbt` file:

    defaultImagePath in Growl := "/my/better/path"

You can configure images individually by reconfiguring the GrowlTestImages class.  e.g.

    (GrowlKeys.images in GrowlKeys.Growl) <<= (GrowlKeys.images in GrowlKeys.Growl)(i => i.copy(fail = Some("/better/fail/icon.png")))

## todo

* support like notifiers on other OS's

2010-2012 Doug Tangren (softprops) + Josh Suereth (jsuereth)