node package manager

sentry

Watch files (using a path, wildcards, or a regex) and execute a function or shell command.

Sentry

Sentry is a simple node tool to watch for file changes (using a path, wildcards, or regexes) and execute a function or shell command. It's like a watchr or guard for node.

Installation

$ npm install sentry

Example

sentry = require 'sentry'
 
# Watch changes in file.js 
sentry.watch 'file.js'(file) -> console.log "A change has been made in #{file}"
 
# Watch changes on any file ending in .coffee one directory deep 
sentry.watch 'fld/*.coffee'->
 
# Watch changes recursively on any files  
sentry.watch 'fld/**/*'->
 
# Watch files recursively that match a regex 
sentry.watchRegExp 'fld/'/regex/->
 
# If you pass a string instead of a function it'll execute that child process 
sentry.watch 'file.coffee''coffee -c'

API

Sentry comes with two methods watch and watchRegExp.

sentry.watch(filePath, [task], callback)

Optionally you may pass a task which will send (err, stdout, stderr) as the arguments to the callback

sentry.watch 'file.js''coffee -c'(err, stdout, stderr) ->

Or simply just a callback and Sentry will pass the filename to the callback

sentry.watch 'file.js'(filename) ->

Feel free to use wildcards with extensions

 
# Find all files one directory deep 
sentry.watch '/folder/*'->
 
# Find all files one directory deep ending in .coffee 
sentry.watch '/folder/*.coffee'->
 
# Find all files recursively 
sentry.watch '/folder/**/*'->
 
# Find all files recursively ending in .txt 
sentry.watch '/folder/**/*.txt'->

sentry.watchRegExp(root, regex, [task], callback)

Just like sentry.watch but instead you must pass a root directory and regular expression to match files against.

 
# Find all files in this folder that end in .coffee 
sentry.watchRegExp ''/\.coffee$/->
 
# Find all files in the adjacent 'test' folder that begin with test and end in .coffee 
sentry.watchRegExp '../tests/'/^test_,.coffee$/->

To run tests

Sentry uses Jasmine-node for testing. Simply run the jasmine-node command with the coffeescript flag

jasmine-node spec --coffee