node-dev-env

Restarts your app when files are modified

npm install node-dev-env
2 downloads in the last week
5 downloads in the last month

Build Status

node-dev-env

Node-dev-env is a development tool for Node.js that automatically restarts the node process when a script is modified.

It's an alternative to tools like supervisor or nodemon that doesn't require any configuration. Just run node-dev foo.js as you would normally run node and it will automatically figure out which files need to be watched.

You may also use node-dev with CoffeeScript or LiveScript apps. Just run node-dev app.coffee or node-dev-env app.ls. You may also register additional language flavors by adding them to the extensions list in your .node-dev.json config file.

Note: this is a fork from fgnass/node-dev because I needed the ability to set env vars in the config file and could not wait for the changes to be merged

Desktop Notifications

Status and error messages can be displayed as desktop notification using either Growl or libnotify.

Screenshot

Screenshot

Installation

Node-dev can be installed via npm:

npm install -g node-dev-env

In order to use Growl notifications growlnotify must be installed on your system.

To use OSX's built in notifications:

sudo gem install terminal-notifier

Settings

Upon startup node-dev looks for a .node-dev.json file in the user's HOME directory. It will also look for a .node-dev.json file in the current directory which – if present – overwrites the global settings.

  • vm – Whether to watch files loaded via Node's VM module. Default: true
  • fork – Whether to hook into child_process.fork() which is required for clustered programs. Default: true
  • notify – Whether to display desktop notifications. Default: true
  • timestamp – The timestamp format to use for logging restarts. Default: "HH:MM:ss"
  • clear – Whether to clear the screen upon restarts. Default: false
  • extensions – Modules to load based bad on extension of the main script. Default: { coffee: "coffee-script", ls: "LiveScript" }
  • env – Environment key-value pairs to run the script with. Default: {}

The MIT License (MIT)

Copyright (c) 2013 Felix Gnass

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

npm loves you