README.md

Capistrano::npm::Build

npm support for Capistrano 3.x

Installation

Add this line to your application's Gemfile:

gem 'capistrano', '~> 3.1.0'
gem 'capistrano-npm-build'

And then execute:

$ bundle

Or install it yourself as:

$ gem install capistrano-npm-build

Usage

Require in Capfile to use the default task:

require 'capistrano/npm_build'

The task will run before deploy:updated as part of Capistrano's default deploy, or can be run in isolation with cap production npm:install

Configurable options:

set :npm_target_path, -> { release_path.join('subdir') } # default not set
set :npm_flags, '--production --silent --no-progress'    # default
set :npm_roles, :all                                     # default
set :npm_env_variables, {}                               # default
set :build_command, 'npm run build'                      # default not set. Don't forget to set this.

Dependencies

npm allows for normal dependencies and devDependencies. By default this gem uses '--production --silent --no-progress' as the install flags which will only install dependencies and skip devDependencies. If you want your devDependencies installed as well, then remove --production.

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request