daniel / gulp-develop-server

Development assistant for node.js server by gulp

gulp-develop-server

run your node.js server and automatically restart with gulp.

gulp-develop-server is a development assistant for node.js server that runs the process and automatically restarts it when a file is modified.

installation

npm install gulp-develop-server --save-dev

usage

var gulp   = require( 'gulp' ),
    server = require( 'gulp-develop-server' );

// run server
gulp.task( 'server:start', function() {
    server.listen( { path: 'app.js' } );
});

// restart server if app.js changed
gulp.task( 'sever:restart', function() {
    gulp.watch( [ 'app.js' ], server.restart )
});

api

###server.listen( options[, callback] )

options {Object}

• path

  • type: {String}
  • exapmle: './your_app.js'
  • Application path. This option is required.

• env

  • type: {Object}
  • default: { NODE_ENV: 'development' }
  • example: { PORT: 3000, NODE_ENV: 'production' }
  • Environment settings of your server.

• execArgv

  • type: {Array}
  • example: [ '--harmony' ]
  • Run node process with this options.

• delay

  • type: {Number}
  • default: 600
  • If not receive an error from the server after options.delay seconds, regard the server listening success.
  • This option needs to adjust according to your application's initialize time.
  • If this option set 0, it will only check successMessage.

• successMessage

  • type: {RegExp}
  • default: /^server listening$/
  • If your application send a specific message by process.send method, regard the server listening success.

• killSignal

  • type: {String}
  • default: SIGTERM

callback( error )

###server.restart( [callback] ) / server.changed( [callback] )

callback( error )

###server()

Create a Transform stream. Restart the server at once when this stream gets files.

###server.kill( [signal, callback] )

Send kill signal to the server process.
signal {String}
callback( error )

###server.reset( [signal, callback] )

Send kill signal to the server process and reset the options to default.
signal {String}
callback( error )

more examples

####with gulp-livereload: (recommend)

var gulp       = require( 'gulp' ),
    server     = require( 'gulp-develop-server' ),
    livereload = require( 'gulp-livereload' );

gulp.task( 'server:start', function() {
    server.listen( { path: 'app.js' }, livereload.listen );
});

// If server scripts change, restart the server and then livereload.
gulp.task( 'server:restart', [ 'server:start' ], function() {
    function restart() {
        server.changed( function( error ) {
            if( ! error ) livereload.changed();
        });
    }
    gulp.watch( [ 'app.js', 'routes/**/*.js' ], restart );
});

####use as a stream:

var gulp       = require( 'gulp' ),
    server     = require( 'gulp-develop-server' ),
    livereload = require( 'gulp-livereload' );

// run server
gulp.task( 'server:start', function() {
    server.listen( { path: 'app.js', execArgv: [ '--harmony' ] } );
});

// restart server and then livereload
gulp.task( 'sever:restart', function() {
    gulp.src( 'app.js' )
        .pipe( server() )
        .pipe( livereload() ); 
});

// watching server scripts 
gulp.task( 'watch', [ 'server:start' ], function() {
     gulp.watch( [ 'app.js', 'routes/**/*.js' ], [ 'server:restart' ] );
});

thanks

@pronebird