Automatic desktop notifications for Grunt errors and warnings using Growl for OS X or Windows, Mountain Lion and Mavericks Notification Center, and Notify-Send.
Want to see pretty graphs? Log in now!
npm install grunt-notify
|779|| downloads in the last day|
|3 491|| downloads in the last week|
|19 479|| downloads in the last month|
> Automatic desktop notifications for Grunt errors and warnings using Growl for OS X or Windows, Mountain Lion and Mavericks Notification Center, and Notify-Send.
| OS | Tool | Screenshots |
| OS X | OS X Notification Center | |
| OS X | Growl for Mac | |
| Windows | Growl for Windows | |
| Windows | Snarl | |
| Linux | Notify-Send | |
### Getting Started
This plugin recommends Grunt
0.4.1 or newer.
npm install grunt-notify --save-dev
Once that's done, add this line to your project's
That's all you need for automatic notifications.
### NotifyHooks Options
If you want change the automatic messaging configure a task called
// This is optional!
max_jshint_notifications: 5, // maximum number of notifications from jshint output
title: "Project Name" // defaults to the name in package.json, or will use project directory's name
// Load the task
// This is required if you use any options.
### Showing Specific Notifications
Sometimes you want to show messages like "Uglify complete" or "Project Deployed" - that's easy to do too.
| Custom Message - Grunt |
| Custom Message - Notification Center |
| Custom Message - Notify-Send |
// Task-specific options go here.
title: 'Task Complete', // optional
message: 'SASS and Uglify finished running', //required
message: 'Server is ready!'
// simplified example
title _optional Notification title
message required Notification message
grunt to lint and run the tests.
### Notification Systems
##### OS X Notification System
If you are using OS X 10.8 Mountain Lion or newer a notification system is built in, but Apple does not provide a
notification API that Node can access. Only code written in Objective C and signed in XCode can access it.
This is not very friendly for Node users so we are using the tiny signed MIT-licensed native application
Terminal Notifier from Eloy Durán.
I've changed the default icon which is owned by Apple to the Grunt logo.
##### Growl for OS X
Requires growlnotify for OS X.
Install growlnotify from the Growl Downloads Page. This will install in
Included with Snarl.
If you have downloaded and installed Snarl from Snarl's web site you'll have the commandline tool heysnarl as well.
##### Growl for Windows
Requires growlnotify for Windows.
Install growlnotify from the growlnotify Page.
##### Windows 8.1 Notifications
Not supported yet.
Create a pull request!
No install needed in Ubuntu.
I created an Ubuntu virtual machine and it had
notify-send in the path.
I don't use Linux frequently so I don't know if this utility is available for other distros.
notify-send man page.
notify-send has an addition
duration option which takes a number seconds. The default is 3 seconds.
Not supported yet.
Chrome has a notification system but I'm not sure if it's possible to use from a command-line Node app. Somebody could
probably create a Chrome Plugin helper for this.
#### Notifications aren't showing
grunt -v (for
verbose mode) to show
grunt-notify debug messages. It will tell you what notification system
it thinks it can use. Create an issue and I'll look into it asap.
### About the Author
Hello fellow developer! My name is Dylan Greene. When
not overwhelmed with my two kids I enjoy contributing to the open source community.
I'm a tech lead at Opower. I lead a team using Grunt and Angular to build software that
successfully helps people like us use less power.
Not too long ago I co-created Doodle or Die, a hilarious web game with millions of
doodles that won us Node Knockout for the "most fun" category.
I'm dylang on Twitter and other places.
Some of my other Node projects:
| Name | Description | Github Stars | Npm Installs |
grunt-prompt | Interactive prompt for your Grunt config using console checkboxes, text input with filtering, password fields. | 142 | 6,885 |
rss | RSS feed generator. A really simple API to add RSS feeds to any project. | 177 | 98,802 |
shortid | Amazingly short non-sequential url-friendly unique id generator. | 129 | 22,984 |
xml | Fast and simple xml generator. Supports attributes, CDATA, etc. Includes tests and examples. | 35 | 180,625 |
anthology | Module information and stats for any @npmjs user | New! | TBD |
grunt-attention | Display attention-grabbing messages in the terminal | New! | 336 |
observatory | Beautiful UI for showing tasks running on the command line. | New! | 81 |
changelog | Command line tool (and Node module) that generates a changelog in color output, markdown, or json for modules in npmjs.org's registry as well as any public github.com repo. | 51 | 2,081 |
logging | Super sexy color console logging with cluster support. | 21 | 8,793 |
grunt-cat | Echo a file to the terminal. Works with text, figlets, ascii art, and full-color ansi. | New! | 396 |
This list was generated using anthology.
Copyright (c) 2014 Dylan Greene, contributors.
Released under the MIT license.
Screenshots are CC BY-SA (Attribution-ShareAlike).
Generated using grunt-readme with grunt-templates-dylang on Monday, March 10, 2014.