Skip to content

A nodemon wrapper for Gulp that keeps your "watch, edit, restart" routine contained to one process.

Notifications You must be signed in to change notification settings

zelphir/gulp-nodemon

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

47 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

gulp-nodemon

A nodemon wrapper for Gulp that keeps your "watch, edit, restart" routine contained to one process.

Best .js dev system ever? ya

Usage

nodemon([options])

You can pass an object to gulp-nodemon with options specified in nodemon config.

Example below will start server.js in development mode and watch for changes, as well as watch all .html and .js files in the directory.

{
  script: 'server.js'
, ext: 'js html'
, env: { 'NODE_ENV': 'development' }
}

gulp-nodemon returns a stream just like any other NodeJS stream, except for the on method, which conveniently takes gulp task names to execute.

.on([event], [tasks])

  1. [event] is an event name as a string. See nodemon events. (gulp-nodemon also provides a new event, 'change', which fires before the server restarts so that you can run your compile tasks all within the same gulp process.)
  2. [tasks] A gulp task name, array of gulp task names, or a function to execute.

--debug

You can also pass the debug flag to node through the nodeArgs option

Example below will start server.js in development with --debug flag.

{ 
  script: 'app.js', 
  ext: 'js html', 
  env: { 'NODE_ENV': 'development' } , 
  ignore: ['./build/**'], 
  nodeArgs: ['--debug'] 
}

You can also specify a custom debug port:

nodeArgs: ['--debug=9999']

Example

The following example will run your code with nodemon, lint it when you change it, then log a message when nodemon runs it again.

// Gulpfile.js
var gulp = require('gulp')
  , nodemon = require('gulp-nodemon')
  , jshint = require('gulp-jshint')

gulp.task('lint', function () {
  gulp.src('./**/*.js')
    .pipe(jshint())
})

gulp.task('develop', function () {
  nodemon({ script: 'server.js', ext: 'html js', ignore: ['ignored.js'] })
    .on('change', ['lint'])
    .on('restart', function () {
      console.log('restarted!')
    })
})

About

A nodemon wrapper for Gulp that keeps your "watch, edit, restart" routine contained to one process.

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 99.1%
  • CoffeeScript 0.9%