Repository files navigation

A set of tasks forShipit used fornpm specific tasks on deploy.

Inspired by thecapistrano/composer extension.

Features:

• Triggered on theupdated orfetched event fromshipit-deploy
• Has a direct pass though task tonpm cli
• Works viashipit-cli andgrunt-shipit

npm install shipit-npm

Just simply run: (This triggers thenpm task on the deployupdated orfetched event. No additional config necessary.)

shipit staging deploy

Or you can run the tasks separatly :

shipit staging npm:init npm:installshipit staging npm:run --cmd "update"

Type:BooleanDefault:true

A Boolean to determine whether to run the task in local workspace or on the remote.

Type:Array orStringDefault: []

An array or string specifying npm args passed to thenpm install cmd.

Type:Array orStringDefault: []

An array or string specifying npm flags passed to thenpm install cmd.

Type:String,BooleanDefault:updated orfetched (depending onnpm.remote value)

An event name that triggersnpm:install. Can be set to false to prevent thenpm:install task from listening to any events.

module.exports=function(shipit){require('shipit-deploy')(shipit);require('shipit-npm')(shipit);shipit.initConfig({default:{npm:{remote:false,installArgs:['gulp'],installFlags:['-g']}}});};

• npm
  • npm:init
    • Emit event "npm_inited".
  • npm:install
    • Runs npm install (with any Argsnpm.installArgs or Flagsnpm.installFlags defined in options)
    • Emit event "npm_installed"
  • npm:run
    • Runs npm command.

• on Event "deploy" (shipit-deploy initialized)
  • Runsnpm:init
  • on Event "npm_inited"
    • Runsnpm:install (Triggered on theupdated orfetched event fromshipit-deploy or by a customnpm.triggerEvent as mentioned above.)

MIT