grunt-service

start/stop/restart service (foreground or background process), supports killing by pidfile.

Purpose

grunt-shell and grunt-shell-spawn have some obstacles in my experience.

I wanted to start/restart my server code for developemnt.

But, these plugins remove readability of debug message, and can't kill process in window (my development environment)

Features

• options pass to childprocess.spawn

• so, this supports full options of childprocess.spawn including stdio: ignore, stdio: inherit, stdio: ['ignore','pipe','pipe'] and stdio: [0, 1,2 ]

• kill process by PID file

• Generate PID file if process doesn't have a background option.

Getting Started

If you haven't used grunt before, be sure to check out the Getting Started guide, as it explains how to create a gruntfile as well as install and use grunt plugins. Once you're familiar with that process, install this plugin with this command:

$ npm install --save-dev grunt-service

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-service');

Tip: the load-grunt-tasks module makes it easier to load multiple grunt tasks.

Examples

As a Developement Sever

Support [debug][debug] module & PID File for restart [debug]: https://www.npmjs.org/package/debug

    
trim = (str)->
  str.replace /(^\s*)|(\s*$)/gm, ""
fromLines = (patterns)->
  return trim(patterns).split('\n').map (pattern)->
    trim(pattern)

watchDirIgnore = fromLines """ 
.git
.gitignore
tmp
test
public
node_modules 
""" 

clientMatch = fromLines """
browser/*.coffee
module/*/browser/*.coffee
""" 

serverMatch = fromLines """
*.coffee
!browser
!**/browser/**
!Gruntfile.coffee 
"""


  grunt.initConfig   
    fastWatch:   
      cwd:
        dir : '.'
        ignoreSubDir : watchDirIgnore 
        trigger:
          server:  
            care : serverMatch
            tasks: ["service:server:restart"]
          client: 
            care : clientMatch    
            tasks: ["service:server:restart"]
    service: 
      server: 
        shellCommand : 'set DEBUG=* && coffee app.coffee'
        pidFile : (process.env.TMPDIR || process.env.TEMP) + '/app.pid'  
        options :
          stdio : 'inherit'

  grunt.loadNpmTasks('grunt-spawn');
  grunt.loadNpmTasks('grunt-fast-watch'); 
  grunt.registerTask('default', ['service:server', 'fastWatch:cwd']);
  

Run server and show it [debug][debug] log without changes( inclulde coloring).

I make & use grunt-fast-watch instead grunt-watch several reason. see also grunt-fast-watch.

Create a folder named test.

grunt.initConfig({
	spawn: {
		makeDir: {
			shellCommand: 'mkdir test'
      option: {
        failOnError: false
      }
		}
	}
});

Making direcity. Even if mkdir fails (because of the directory already exists), no error occured.

Spwan direclty

grunt.initConfig({
  testDir: 'test3',
	spawn: {
		direct: {
      command: 'mkdir'
      args: ['<%= testDir %>']
		}
	}
});

Run command and display the output

Output a directory listing in your Terminal.

grunt.initConfig({
	shell: {
		dirListing: {
			command: 'ls'
		}
	}
});

options

options will pass to childprocess.spawn without changes

so, please refer Node.js API Document

• default value of stdio is 'pipe', it means grunt can read stdio.

And some added option are as follows:

failOnError

Default: false Type: Boolean

If false, current Service Status is ignored. it means try to start already running service, the task is considerd success. if true, trying to start running service or stop not running service make error, and grunt will stop all tasks.

pidFile

Type: File path

Path to pid file generated by the service (or by grunt-service if generatePID is set to true).

Note: This is a requried attribute if generatePID is set to true.

generatePID

Default: false Type: Boolean

If false, it's assumed that the service is blocking or goes into background and generates its own PID file. If false, a PID file is generated at provided pidFile location for the process.

Note: pidFile is a requried attribute if generatePID is set to true.

blocking

Default: false Type: Boolean

If true, Grunt task wait until command done(= process exit). If false, Spawn a process for given task and go next task.

License

(The MIT License)

Copyright (c) 2014 junsik <[email protected]@google.com>

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.