Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/endenwer/npm-rails
NPM support for Rails with Bundler-like DSL
https://github.com/endenwer/npm-rails
browserify npm rails
Last synced: 4 days ago
JSON representation
NPM support for Rails with Bundler-like DSL
- Host: GitHub
- URL: https://github.com/endenwer/npm-rails
- Owner: endenwer
- License: mit
- Created: 2016-01-05T11:16:38.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2016-06-09T15:14:50.000Z (over 8 years ago)
- Last Synced: 2024-12-10T02:10:35.997Z (13 days ago)
- Topics: browserify, npm, rails
- Language: Ruby
- Homepage:
- Size: 29.3 KB
- Stars: 83
- Watchers: 8
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# npm-rails
[](https://badge.fury.io/rb/npm-rails)
[](https://codeclimate.com/github/endenwer/npm-rails)
[](https://gemnasium.com/endenwer/npm-rails)
[](https://travis-ci.org/endenwer/npm-rails)
[](https://coveralls.io/github/endenwer/npm-rails?branch=master)
NPM support for Rails projects. It let you use Bundler-like DSL and rake tasks
for including npm packages. This gem based on Browserify for bundling packages
and resolve dependencies.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'npm-rails'
```
Then run:
rails g npm_rails:initialize
And require `npm-dependencies.js`:
//=require npm-dependencies
## Usage
1. Add a package to `npm_packages` file
2. Run `rake npm:install`
3. Use the package in your javascript code by calling the camelize name
or `build_name` if you set it
**Example `npm_packages` file**
```ruby
# call 'React' in your js code to use it
npm 'react'
# Set version
npm 'redux', '3.3.1'
# Set build_name to a package.
# Call '_' to get Underscore
npm 'underscore', build_name: '_'
# You can add a package for development
npm 'jasmine', development: true
# Or in block
development do
npm 'jasmine'
end
# Install a package but do not require it
npm 'browserify', require: false
```
## Configuration Options
The following options are available for configuration in your application or environment-level
config files (`config/application.rb`, `config/environments/development.rb`, etc.):
| Configuration Option | Description |
|-------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------- |
| `config.npm.package_file` | Specificies a package file. Default value: `npm_packages` |
| `config.npm.output_file` | Specifies a file where to bundle npm packages. Default value for production: `vendor/assets/javascripts/npm-rails/production/npm-dependencies.js`. Default value for other environments: `vendor/assets/javascripts/npm-rails/development/npm-dependencies.js` |
| `config.npm.browserify_options` | Sets options for browserify command. See all available options in [Browserify documentation](https://github.com/substack/node-browserify#usage) |
| `config.npm.run_before_assets_precompile` | If set to `true` then run `rake npm:install` before assets precompilation. Default value: `false` |
## How it works
The generator creates `npm_packages` file. This file contains a list of packages. Rake uses NPM to install the packages and Browserify to bundle them. Browserify output the bundled results to `output_file`(see configuration options), which are then loaded by sprockets. All packages attached to `window` by `build_name`, which by default is the camelize package name.