Skip to content

jonahx/tape-growl

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

tape-growl

what is it?

Growl alerts for your node TDD cycle.

Simple command line tool that turns TAP output into growl alerts.

requirements

Requires:

  • growl
  • growlnotify

recommendations

In this workflow, your npm test command starts tape-watch, which watches your test (and implementation) files, re-running your tape tests anytime a file changes. You'll instantly get a success or failure alert via growl anytime you save.

This way you don't need an extra tmux pane to view your test results, or have to switch from your editor to your terminal and back (unless you want to view specific results).

how to use

Say your project has a test folder, which includes index.js, a main entry point that runs all your other test files (such a file is currently required by tape-watch). Then to start your TDD workflow, create a scripts entry in your package.json that looks like this:

...
"scripts": {
  "test": "tape-watch test/index.js 2>&1 | tape-growl | tap-spec"
},
...

This will turn on growl notifications and give you tap-spec-formatted output to the command line, should you need to see additional output. Of course, you could remove | tap-spec for the raw TAP output.

additional notes

The 2>&1, which combines stderr and stdout, is needed, eg, to catch syntax errors which will not be listed as TAP failures, but which you probably want to consider "red" in your TDD flow.

recommended formatter

tap-spec is the recommended formatter, since it handles syntax error output gracefully, displaying it along with the formatted TAP output. Some other TAP formatters will swallow up errors.

About

Growl notifications for TDD

Resources

License

Stars

Watchers

Forks

Packages

No packages published