Using Webpack with Ruby on Rails

Webpack, although a little hard to configure, remains the leading edge build tool for modern web development. This post/video guides you through adding Webpack to an older Ruby on Rails 5.2 project as well as the latest Ruby on Rails 6 beta release.

The demos here are meant to be a high-level overview of how Webpack can be used inside Ruby on Rails no matter the version.

We'll leverage the webpacker gem (now part of Rails 6 by default) to incorporate more modern JavaScript into an already seasoned framework. The point of adding webpack is to add new technologies that are so new that they need to be compiled down into more legacy code. Doing this is no easy feat but the gem will take all the hard configurations out of the picture and ultimately just work.

With Webpacker you gain these features and more:

• webpack 4.x.x
• ES6 with babel
• Automatic code splitting using multiple entry points
• Stylesheets - Sass and CSS
• Images and fonts
• PostCSS - Auto-Prefixer
• Asset compression, source-maps, and minification
• CDN support
• React, Angular, Elm and Vue support out-of-the-box
• Rails view helpers

A lot of these things Rails already takes care of with the asset pipeline. You can optionally choose to use the asset pipeline for images, fonts, css, and more leaning on webpacker for JavaScript. This will be the new Rails 6 default.

Common questions

Why do I need webpack with Rails if the asset pipeline is already present?

Realistically, in most cases, you don't but it does make it easier to reach for modern front-end frameworks like Vue.js or React.js with minimal setup time. The asset pipeline still works as it should alongside the new webpack workflow. All assets associated with webpack now live inside an app/javascript directory.

Does webpack depend on the asset pipeline? Do they conflict?

The webpacker gem doesn't depend on the asset pipeline directly though it does hook into a few rake commands bundled with each Rails installation rails assets:precompile for instance will fire off both the asset pipeline compilation and the webpack command to compile down all assets in a given project utilizing both. They only conflict if your code does. It's a good practice to separate concerns. I tend to author all javascript in app/javascript and then reach for the asset pipeline app/assets/ for any css, images, or other assets the project I'm working on might require.

Do I even need the asset pipeline with the webpack addition?

Realistically, no but the asset pipeline has a bunch of handy features for rendering assets in views you or your team may be accustomed to. Luckily you can do the same with assets inside app/javascript. Rendering images, assets, CSS, JavaScript and more is very possible.

Shameless plug time

I have a new course called Hello Rails. Hello Rails is modern course designed to help you start using and understanding Ruby on Rails fast. If you're a novice when it comes to Ruby or Ruby on Rails I invite you to check out the site. The course will be much like these builds but a super more in-depth version with more realistic goals and deliverables. View the course!

Follow @hello_rails and myself @justalever on Twitter.