seucolega/grunt-notify

Automatic Notifications when Grunt tasks fail.

grunt-notify

Automatic desktop notifications for Grunt errors and warnings using Growl for OS X or Windows, Mountain Lion and Mavericks Notification Center, and Notify-Send.

Getting Started

This plugin recommends Grunt 0.4.1 or newer.

Installing

npm install grunt-notify --save-dev

Once that's done, add this line to your project's Gruntfile.js:

grunt.loadNpmTasks('grunt-notify');

That's all you need for automatic notifications.

Screenshots

OS X

OS X Notification Center

Growl for Mac

Windows

Growl for Windows

Snarl

Linux

Notify-Send

Notify_Hooks Options

If you want change the automatic messaging configure a task called notify_hooks.

grunt.initConfig({
  // This is optional!
  notify_hooks: {
    options: {
      enabled: true,
      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
grunt.loadNpmTasks('grunt-notify');

// This is required if you use any options.
grunt.task.run('notify_hooks');

Showing Specific Notifications

Sometimes you want to show messages like "Uglify complete" or "Project Deployed" - that's easy to do too.

grunt.initConfig({
  notify: {
    task_name: {
      options: {
        // Task-specific options go here.
      }
    },
    watch: {
      options: {
        title: 'Task Complete',  // optional
        message: 'SASS and Uglify finished running', //required
      }
    },
    server: {
      options: {
        message: 'Server is ready!'
      }
    }
  }
});

grunt.loadNpmTasks('grunt-notify');

// simplified example
grunt.registerTask('server', [
  'uglify',
  'sass',
  'server',
  'notify:server'
  ]);

Options

• title optional Notification title
• message required Notification message

Tests

Run grunt to lint and run the tests.

Notification Systems

Mac

OS X Notification System

Support Included.

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 /usr/local/bin/growlnotify.

Windows

Snarl

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!

Linux

Notify-Send

No install needed in Ubuntu.

I created an Ubuntu virutal 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.

Chrome

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

Run 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

Dylan is a senior JavaScript developer and tech lead at Opower, co-creator of Doodle or Die, and father of two awesome kids.

Here are some other Node modules Dylan has created:

Name	Description	Github Stars	Npm Installs
grunt-prompt	Add interactive console prompts to your Gruntfile such as lists, checkboxes, text input with filtering, and password fields.	117	4,832
rss	RSS feed generator. A really simple API to add RSS feeds to any project.	171	88,235
anthology	Module information and stats for any @npmjs user	New!	TBD
shortid	Amazingly short non-sequential url-friendly unique id generator.	123	20,441
xml	Fast and simple xml generator. Supports attributes, CDATA, etc. Includes tests and examples.	32	168,752
observatory	Beautiful UI for showing tasks running on the command line.	New!	74
grunt-attention	Display attention-grabbing messages in the terminal	New!	214
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.	46	2,040
logging	Super sexy color console logging with cluster support.	21	8,626
grunt-cat	Echo a file to the terminal. Works with text, figlets, ascii art, and full-color ansi.	New!	384

Data collected on Sunday, January 5, 2014 using anthology.

License

Copyright (c) 2014 Dylan Greene, contributors. Released under the MIT license

---

Generated by grunt-readme using grunt-templates-dylang on Sunday, January 5, 2014.