RailsNodeModuleLinker

Helps expose selected node_modules into the public directory for use in Rails apps that have transitioned from Sprockets to Propshaft.

Install the gem and add to the application's Gemfile by executing:

bundle add rails_node_module_linker

If bundler is not being used to manage dependencies, install the gem by executing:

gem install rails_node_module_linker

# config/initializers/rails_node_module_linker.rb

Rails.application.config.to_prepare do
  RailsNodeModuleLinker.config.symlinked_node_modules_config = 'config/symlinked_node_modules.yml'
  RailsNodeModuleLinker.config.destination_path = 'public/node_modules'
  RailsNodeModuleLinker.config.force_link = false
  RailsNodeModuleLinker.config.use_emojis = true
end

# config/symlinked_node_modules.yml

---
packages:
- "@melloware/coloris"
- bootstrap
- flag-icons
- intl-tel-input
- mapbox-gl

Run the following command to link selected node_modules to the public directory:

rails rails_node_module_linker:link

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Bug reports and pull requests are welcome on GitHub. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

The gem is available as open source under the terms of the MIT License.

Everyone interacting in the RailsNodeModuleLinker project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.