devnode

devnode

Node binary wrapper providing the combined features of modemon and npm link.

As known from similar wrapper like nodemon it will start a script and restart it on code changes in order to facilitate development.

The unique feature of this wrapper is that it will also watch any script dependency found in the same working directory, allowing the same benefit as with npm link for parallel package development.

Installation

npm install -g devnode

Usage

devnode path/to/script

Node "require" Wrapper

A wrapper for the native Node.js Module.prototype.require method. This wrapper has been inspired by Gleb Bahmutov excellent article Hacking Node require and the resulting package really-need

When started with devnode the script package root will be found and each dependency packages will be loaded from the workplace directory (if found) or as usual from the node_modules.

This is also true for any deep dependency found in the process (dependency from dependency).

Example:

Running one of the following commands

$ WORKPLACE/YourProject: devnode index.js
$ WORKPLACE:             devnode YourProject/index.js
$ WORKPLACE/somewhere:   devnode ../YourProject/index.js

Will start YourProject loading dependencies as follows

   WORKPLACE
      |_ YourProject
      |    |_ someLib.js                    (watched)
      |    |_ otherLib.js                   (watched)
      |    |_ index.js                      (started and watched)
      |    |_ node_modules
      |         |_ dependency.1             (loaded from WORKPLACE)
      |         |_ dependency.2             (loaded here)
      |         |_ dependency.3             (loaded from WORKPLACE)
      |
      |_ dependency.1                       (loaded)
      |    |_ data.json                     (watched)
      |    |_ index.js                      (watched)
      |
      |_ dependency.3                       (loaded)
      |    |_ data.json                     (watched)
      |    |_ index.js                      (watched)
      |    |_ node_modules
      |         |_ dependency.5             (loaded here)
      |              |_ node_modules
      |                   |_ dependency.n   (loaded from WORKPLACE)
      |
      |_ dependency.4                       (ignored)
      |
      |_ dependency.n                       (loaded)
           |_ index.js                      (watched)

Troubleshooting

Error: watch ... ENOSPC

This might be because of your system reach out of user can watch files. you can use the following command line in Debian, Debian based (Ubuntu, Mint) and CentOS

echo fs.inotify.max_user_watches=524288 | sudo tee -a /etc/sysctl.conf && sudo sysctl -p

---

Copyright (c) 2015-2016 Luscus ([e-mail])

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.