mirror of
https://github.com/samuelclay/NewsBlur.git
synced 2025-08-05 16:58:59 +00:00
80 lines
2.4 KiB
Markdown
80 lines
2.4 KiB
Markdown
|
# node-supervisor
|
||
|
|
|
||
|
|
A little supervisor script for nodejs. It runs your program, and
|
||
|
|
watches for code changes, so you can have hot-code reloading-ish
|
||
|
|
behavior, without worrying about memory leaks and making sure you
|
||
|
|
clean up all the inter-module references, and without a whole new
|
||
|
|
`require` system.
|
||
|
|
|
||
|
|
## node-supervisor -?
|
||
|
|
|
||
|
|
|
||
|
|
Node Supervisor is used to restart programs when they crash.
|
||
|
|
It can also be used to restart programs when a *.js file changes.
|
||
|
|
|
||
|
|
Usage:
|
||
|
|
supervisor [options] <program>
|
||
|
|
|
||
|
|
Required:
|
||
|
|
<program>
|
||
|
|
The program to run.
|
||
|
|
|
||
|
|
Options:
|
||
|
|
-w|--watch <watchItems>
|
||
|
|
A comma-delimited list of folders or js files to watch for changes.
|
||
|
|
When a change to a js file occurs, reload the program
|
||
|
|
Default is '.'
|
||
|
|
|
||
|
|
-e|--extensions <extensions>
|
||
|
|
Specific file extensions to watch in addition to defaults.
|
||
|
|
Used when --watch option includes folders
|
||
|
|
Default is 'node|js'
|
||
|
|
|
||
|
|
-x|--exec <executable>
|
||
|
|
The executable that runs the specified program.
|
||
|
|
Default is 'node'
|
||
|
|
|
||
|
|
-h|--help|-?
|
||
|
|
Display these usage instructions.
|
||
|
|
|
||
|
|
Examples:
|
||
|
|
supervisor myapp.js
|
||
|
|
supervisor myapp.coffee
|
||
|
|
supervisor -w scripts -e myext -x myrunner myapp
|
||
|
|
supervisor -w lib -w server.js -w config.js server.js
|
||
|
|
|
||
|
|
|
||
|
|
## Simple Install
|
||
|
|
|
||
|
|
Install npm, and then do this:
|
||
|
|
|
||
|
|
npm install supervisor -g
|
||
|
|
|
||
|
|
You don't even need to download or fork this repo at all.
|
||
|
|
|
||
|
|
## Fancy Install
|
||
|
|
|
||
|
|
Get this code, install npm, and then do this:
|
||
|
|
|
||
|
|
npm link
|
||
|
|
|
||
|
|
## todo
|
||
|
|
|
||
|
|
1. Re-attach to a process by pid. If the supervisor is
|
||
|
|
backgrounded, and then disowned, the child will keep running. At
|
||
|
|
that point, the supervisor may be killed, but the child will keep
|
||
|
|
on running. It'd be nice to have two supervisors that kept each
|
||
|
|
other up, and could also perhaps run a child program.
|
||
|
|
2. Run more types of programs than just "node blargh.js".
|
||
|
|
3. Be able to run more than one program, so that you can have two
|
||
|
|
supervisors supervise each other, and then also keep some child
|
||
|
|
server up.
|
||
|
|
4. When watching, it'd be good to perhaps bring up a new child
|
||
|
|
and then kill the old one gently, rather than just crashing the
|
||
|
|
child abruptly.
|
||
|
|
5. Keep the pid in a safe place, so another supervisor can pull
|
||
|
|
it out if told to supervise the same program.
|
||
|
|
6. It'd be pretty cool if this program could be run just like
|
||
|
|
doing `node blah.js`, but could somehow "know" which files had
|
||
|
|
been loaded, and restart whenever a touched file changes.
|