npm install shipit-npmA set of tasks for Shipit used for npm specific tasks on deploy.
Inspired by the capistrano/composer extension.
Features:
- Triggered on the updated or fetched event from shipit-deploy
- Has a direct pass though task to npm cli
- Works via shipit-cli and grunt-shipit
```
npm install shipit-npm
Just simply run: (This triggers the npm task on the deploy updated or fetched event. No additional config necessary.)
`
shipit staging deploy
`
Or you can run the tasks separatly :
`
shipit staging npm:init npm:install
shipit staging npm:run --cmd "update"
`
Type: Booleantrue
Default:
A Boolean to determine whether to run the task in local workspace or on the remote.
Type: Array or String
Default: []
An array or string specifying npm args passed to the npm install cmd.
Type: Array or String
Default: []
An array or string specifying npm flags passed to the npm install cmd.
Type: String,Booleanupdated
Default: or fetched (depending on npm.remote value)
An event name that triggers npm:install. Can be set to false to prevent the npm:install task from listening to any events.
`js
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 Args npm.installArgs or Flags npm.installFlags defined in options)
- Emit event "npm_installed"
- npm:run
- Runs npm command.
##### Event flow:
- on Event "deploy" (shipit-deploy initialized)
- Runs npm:init
- on Event "npm_inited"
- Runs npm:install (Triggered on the updated or fetched event from shipit-deploy or by a custom npm.triggerEvent` as mentioned above.)
MIT