Webpacker and JavaScript bundling in Ruby on Rails - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is Webpacker in Ruby on Rails?

Webpacker is a gem that integrates Webpack with Rails. It helps manage and bundle JavaScript, CSS, and other assets in a Rails app using modern JavaScript tools.

beginner

Why do we use JavaScript bundling in Rails apps?

Bundling combines many JavaScript files into a few files to reduce browser requests, improve load speed, and manage dependencies easily.

beginner

Where do you place your JavaScript files when using Webpacker?

You put JavaScript files inside the app/javascript folder. Webpacker looks here to bundle your scripts.

intermediate

How does Webpacker handle different environments like development and production?

Webpacker uses different configurations for development and production. Development enables fast rebuilds and debugging, while production optimizes and minifies files for speed.

beginner

What command do you run to compile JavaScript assets with Webpacker?

You run `bin/webpack` or `bin/webpack-dev-server` to compile and bundle JavaScript assets.

What is the main purpose of Webpacker in Rails?

A To handle user authentication

B To manage database migrations

C To style HTML pages

D To bundle JavaScript and other assets using Webpack

Webpacker integrates Webpack to bundle JavaScript and other assets in Rails.

Where should you place your JavaScript files when using Webpacker?

A public/javascripts

B app/javascript

C app/assets/javascripts

D lib/javascript

Webpacker expects JavaScript files inside app/javascript for bundling.

Which command starts a development server that watches for JavaScript changes with Webpacker?

A bin/webpack-dev-server

B rails server

C bin/rails assets:precompile

D bin/webpack-prod

bin/webpack-dev-server runs a watcher that recompiles assets on changes during development.

What benefit does bundling JavaScript provide?

A Removes CSS styles

B Increases file size

C Reduces number of browser requests

D Disables JavaScript

Bundling reduces browser requests by combining files, improving load speed.

In production, Webpacker usually does what to JavaScript files?

A Minifies and optimizes them

B Leaves them unmodified

C Deletes them

D Converts them to CSS

Production builds minify and optimize JavaScript for faster loading.

Explain how Webpacker helps manage JavaScript in a Rails application.

Think about how Rails handles modern JavaScript with Webpacker.

Describe the benefits of JavaScript bundling in web applications.

Consider what happens when many small files are combined into fewer files.

Practice

1. What is the main purpose of Webpacker in a Rails application?

easy

A. To style HTML elements with CSS

B. To bundle JavaScript files so they load efficiently in the browser

C. To manage database migrations automatically

D. To handle user authentication

Solution

1. Step 1: Understand Webpacker's role

   Webpacker is designed to bundle JavaScript files for Rails apps.

2. Step 2: Identify its main function

   Bundling means combining files to load faster and more efficiently in browsers.

3. Final Answer:

   To bundle JavaScript files so they load efficiently in the browser -> Option B

4. Quick Check:

   Webpacker bundles JS = C [OK]

Hint: Webpacker bundles JS files for faster loading [OK]

Common Mistakes:

• Confusing Webpacker with database tools
• Thinking Webpacker styles HTML
• Assuming Webpacker manages user login

2. Which of the following is the correct way to include a Webpacker JavaScript pack in a Rails view?

easy

A. <%= javascript_pack_tag 'application' %>

B. <%= stylesheet_pack_tag 'application' %>

C. <%= javascript_include_tag 'application.js' %>

D. <%= image_pack_tag 'application' %>

Solution

1. Step 1: Identify the helper for JS packs

   Webpacker uses javascript_pack_tag to include JS bundles.

2. Step 2: Confirm correct syntax

   The syntax is <%= javascript_pack_tag 'pack_name' %>, so <%= javascript_pack_tag 'application' %> matches.

3. Final Answer:

   <%= javascript_pack_tag 'application' %> -> Option A

4. Quick Check:

   Use javascript_pack_tag for JS packs = A [OK]

Hint: Use javascript_pack_tag to load JS bundles in views [OK]

Common Mistakes:

• Using stylesheet_pack_tag for JavaScript
• Using javascript_include_tag instead of javascript_pack_tag
• Confusing image_pack_tag with JS inclusion

3. Given the following JavaScript pack file app/javascript/packs/hello.js with content:

import { greet } from '../utils/greet'
console.log(greet('Rails'))

and app/javascript/utils/greet.js contains:

export function greet(name) {
  return `Hello, ${name}!`
}

What will be printed in the browser console when the pack is loaded?

medium

A. SyntaxError: Unexpected token

B. greet is not defined

C. Hello, undefined!

D. Hello, Rails!

Solution

1. Step 1: Understand the import and export

   The greet function is exported from utils/greet.js and imported correctly in hello.js.

2. Step 2: Analyze the console.log output

   Calling greet('Rails') returns the string Hello, Rails!, which is logged.

3. Final Answer:

   Hello, Rails! -> Option D

4. Quick Check:

   Correct import/export logs greeting = D [OK]

Hint: Check import/export paths and function calls for output [OK]

Common Mistakes:

• Forgetting to export the function
• Using wrong import path
• Expecting undefined instead of correct string

4. You added a new JavaScript file app/javascript/packs/custom.js but when you include it with <%= javascript_pack_tag 'custom' %>, the browser console shows a 404 error. What is the most likely cause?

medium

A. You forgot to restart the Rails server after adding the pack

B. The file is not saved in the correct directory

C. The javascript_pack_tag helper is deprecated and should not be used

D. The file has syntax errors preventing compilation

Solution

1. Step 1: Check file location

   The file is correctly placed in app/javascript/packs/, so location is likely correct.

2. Step 2: Consider server restart

   Webpacker requires the Rails server or webpack-dev-server to restart to detect new packs.

3. Final Answer:

   You forgot to restart the Rails server after adding the pack -> Option A

4. Quick Check:

   Restart server to load new packs = A [OK]

Hint: Restart server after adding new JS packs [OK]

Common Mistakes:

• Assuming helper is deprecated
• Ignoring server restart requirement
• Blaming syntax errors without checking logs

5. You want to organize your JavaScript code by creating a module app/javascript/modules/calc.js exporting a function add(a, b). How should you import and use this function in your pack file app/javascript/packs/main.js to log the sum of 5 and 7?

hard

A. import add from '../modules/calc.js'
console.log(add(5, 7))

B. require('../modules/calc')
console.log(add(5, 7))

C. import { add } from '../modules/calc'
console.log(add(5, 7))

D. import * as calc from '../modules/calc'
console.log(calc.add(5, 7))

Solution

1. Step 1: Understand ES module import syntax

   If add is a named export, import it with curly braces: import { add } from 'path'.

2. Step 2: Use the function correctly

   Call add(5, 7) and log the result with console.log.

3. Final Answer:

   import { add } from '../modules/calc' console.log(add(5, 7)) -> Option C

4. Quick Check:

   Named export import uses braces = B [OK]

Hint: Use curly braces to import named exports [OK]

Common Mistakes:

• Using default import syntax for named exports
• Using require instead of import in Webpacker
• Forgetting to call function from imported module