Gathering detailed insights and metrics for webpack-sprockets-rails-manifest-plugin
Gathering detailed insights and metrics for webpack-sprockets-rails-manifest-plugin
Allow Sprockets to load files from a Webpack build
Installations
npm install webpack-sprockets-rails-manifest-pluginDeveloper Guide
BETA
Typescript
No
Module System
CommonJS
Node Version
6.9.2
NPM Version
4.1.1
Releases
Unable to fetch releases
Languages
1
JavaScript
JavaScript (100%)
Developer
rupurt
Download Statistics
Total Downloads
0
Last Day
0
Last Week
0
Last Month
0
Last Year
0
GitHub Statistics
MIT License
11 Stars
25 Commits
6 Forks
3 Watchers
1 Branches
3 Contributors
Updated on Dec 10, 2020
Maintainers
1
Package Meta Information
Latest Version
0.0.4
Package Id
webpack-sprockets-rails-manifest-plugin@0.0.4
Size
4.22 kB
NPM Version
4.1.1
Node Version
6.9.2
Published on
Feb 28, 2017
Total Downloads
Cumulative downloads
Total Downloads
NaN
Last Day
0%
NaN
Compared to previous day
Last Week
0%
NaN
Compared to previous week
Last Month
0%
NaN
Compared to previous month
Last Year
0%
NaN
Compared to previous year
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
1
Webpack Sprockets Rails Manifest Plugin
A Webpack plugin that allows sprockets-rails
to find static assets from a Webpack build without requiring them in sprockets directives.
We can leverage standard Rails view helpers (i.e. javascript_include_tag, stylesheet_link_tag)
to load artifacts supporting finger printing and prepended host urls.
Install
1npm install webpack-sprockets-rails-manifest-plugin --save
Usage
1# config/initializers/assets.rb 2# Avoid creating the manifest file in public/assets as it can be downloaded by anyone 3Rails.configuration.assets.manifest = Rails.root.join("config", "sprockets-manifest.json")
1# config/environments/development.rb 2config.assets.debug = false
1<% # app/views/layouts/application.html.erb %> 2<% # Use rails helpers in the same way you normally would with sprockets %> 3<!DOCTYPE html> 4<html lang="en"> 5 <head></head> 6 <body> 7 <%= javascript_include_tag "webpack-application-bundle" %> 8 </body> 9</html>
1// client/bundles/webpack-application.js 2alert("Howdy, Webpack is working!");
1// client/webpack.config.js 2var path = require("path"); 3var WebpackSprocketsRailsManifestPlugin = require("webpack-sprockets-rails-manifest-plugin"); 4 5var config = { 6 context: __dirname, 7 8 entry: { 9 "webpack-application-bundle": "./bundles/webpack-application" 10 }, 11 12 output: { 13 path: path.resolve(__dirname, "../public/assets"), 14 filename: "[name]-[chunkhash].js" 15 }, 16 17 // Other config ... 18 19 plugins: [ 20 new WebpackSprocketsRailsManifestPlugin( 21 // [optional] this is the default location relative to the output directory 22 // that the assets will be built. e.g `public/assets` 23 manifestFile: "../../config/sprockets-manifest.json" 24 ) 25 ] 26}; 27 28module.exports = config;
Heroku
Follow the instructions to install the ruby and node multi-buildpack.
Create a package.json file in the root of the rails project.
1{ 2 "name": "MyProject", 3 "version": "1.0.0", 4 "description": "A description of MyProject", 5 "main": "index.js", 6 "engines": { 7 "node": "5.12.0", 8 "npm": "3.10.6" 9 }, 10 "cacheDirectories": [ 11 "client/node_modules" 12 ], 13 "scripts": { 14 "preinstall": "cd client && npm install", 15 "postinstall": "cd client && npm run build" 16 } 17}
Hot Module Replacement
Rails provides us with the ability prepend a host to our asset paths generated by
the Rails view helpers. This option is normally configured for production environments
but we can use it in development to load assets from webpack-dev-server instead of
public.
1export ASSET_HOST=http://localhost:8080
1# config/application.rb 2# ... 3 4if ENV["ASSET_HOST"].present? 5 Rails.application.config.action_controller.asset_host = proc { |source, _request| 6 ENV["ASSET_HOST"] 7 } 8end
Gradually Replacing the Asset Pipeline with Webpack
The Webpack ecosystem works best when it controls a whole subpath. For greenfield
projects this is easy to achieve. However if you're running a legacy Rails app, don't
fret! Webpack can copy build files into a location so that they can be required via
sprockets directives. We recommend using this technique when you're just getting started,
but the end goal should be to have Webpack completely control the build process
of your static assets. For more information and setup instructions check out the
separate plugin webpack-copy-after-build-plugin.
How Does It Work?
sprockets-rails provides two strategies to map logical paths (webpack-application.js)
to file system paths (webpack-application-8f88619b6ef3a358a7ad.js). By using the
manifest strategy we can load finger printed static assets via the existing
view helpers (i.e. javascript_include_tag, stylesheet_link_tag).
Environment
Searches the default sprockets directory for a file type manifest. By default
this is only enabled in the dev and test environments e.g.
1// app/assets/javascripts/application.js 2//= require_self 3alert("Hi, I'm a Javascript manifest in the default Sprockets Asset Pipeline");
Manifest
A json file which stores a mapping between a compiled asset and the original
logical path, along with meta information such as size, creation time and
integrity hash. webpack-sprockets-rails-manifest-plugin uses this manifest file
to make sprockets-rails aware of the files and meta information in the
webpack build. Since Rails 3.x sprockets-rails writes it's manifest file to
a dynamic location using a randomly generated filename (e.g. public/assets/.sprockets-manifest-b4b2e3829c91f2f867c051a855232bed.json).
To get sprockets-rails and webpack talking to each other we need to
configure sprockets-rails to write it's manifest file to a static location
that webpack knows about.
If Rails.configuration.assets.debug = false the asset pipeline will check the
manifest first, if an entry can't be found, it falls back and checks the file
system through the environment strategy.
Examples
Head over to https://github.com/rupurt/react_on_rails_simplified_configuration_examples for examples on how to configure:
- Greenfield Rails projects
- Legacy Rails projects
- Hot Module Replacement
TODO
- - support webpack-dev-server
- - gradual migration documentation
- - sample projects
- - tests
- -
scriptintegrity
License
No vulnerabilities found.
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
0 existing vulnerabilities detected
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
Found 2/23 approved changesets -- score normalized to 0
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'master'
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 4 are checked with a SAST tool
Score
3
/10
Last Scanned on 2025-07-07
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More