webpacker 4.0.2 → 5.4.3

data/README.md

@@ -1,8 +1,8 @@
 # Webpacker
 
-![travis-ci status](https://api.travis-ci.org/rails/webpacker.svg?branch=master)
-[![node.js](https://img.shields.io/badge/node-%3E%3D%206.14.0-brightgreen.svg)](https://nodejs.org/en/)
-[![Gem](https://img.shields.io/gem/v/webpacker.svg)](https://github.com/rails/webpacker)
+[![Build Status](https://travis-ci.org/rails/webpacker.svg?branch=master)](https://travis-ci.org/rails/webpacker)
+[![node.js](https://img.shields.io/badge/node-%3E%3D%2010.17.0-brightgreen.svg)](https://www.npmjs.com/package/@rails/webpacker)
+[![Gem](https://img.shields.io/gem/v/webpacker.svg)](https://rubygems.org/gems/webpacker)
 
 Webpacker makes it easy to use the JavaScript pre-processor and bundler
 [webpack 4.x.x+](https://webpack.js.org/)
@@ -13,10 +13,11 @@ even JavaScript Sprinkles (that all continues to live in app/assets).
 However, it is possible to use Webpacker for CSS, images and fonts assets as well,
 in which case you may not even need the asset pipeline. This is mostly relevant when exclusively using component-based JavaScript frameworks.
 
-**NOTE:** The master branch now hosts the code for v4.x.x. Please refer to [3-x-stable](https://github.com/rails/webpacker/tree/3-x-stable) branch for 3.x documentation. See the [v4-upgrade guide](docs/v4-upgrade.md) for an overview of the changes.
+**NOTE:** The master branch now hosts the code for v5.x.x. Please refer to [4-x-stable](https://github.com/rails/webpacker/tree/4-x-stable) branch for 4.x documentation.
 
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+
 ## Table of Contents
 
 - [Prerequisites](#prerequisites)
@@ -27,15 +28,16 @@ in which case you may not even need the asset pipeline. This is mostly relevant
   - [Webpack Configuration](#webpack-configuration)
   - [Custom Rails environments](#custom-rails-environments)
   - [Upgrading](#upgrading)
-  - [Yarn Integrity](#yarn-integrity)
 - [Integrations](#integrations)
-  - [React](#react)
-  - [Angular with TypeScript](#angular-with-typescript)
-  - [Vue](#vue)
-  - [Elm](#elm)
-  - [Stimulus](#stimulus)
-  - [Coffeescript](#coffeescript)
-  - [Erb](#erb)
+  - [React](./docs/integrations.md#react)
+  - [Angular with TypeScript](./docs/integrations.md#angular-with-typescript)
+  - [Vue](./docs/integrations.md#vue)
+  - [Elm](./docs/integrations.md#elm)
+  - [Stimulus](./docs/integrations.md#stimulus)
+  - [Svelte](./docs/integrations.md#svelte)
+  - [Typescript](./docs/typescript.md)
+  - [CoffeeScript](./docs/integrations.md#coffeescript)
+  - [Erb](./docs/integrations.md#erb)
 - [Paths](#paths)
   - [Resolved](#resolved)
   - [Watched](#watched)
@@ -46,29 +48,26 @@ in which case you may not even need the asset pipeline. This is mostly relevant
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 
-
 ## Prerequisites
 
-* Ruby 2.2+
-* Rails 4.2+
-* Node.js 6.14.4+
-* Yarn 1.x+
-
+- Ruby 2.4+
+- Rails 5.2+
+- Node.js 10.17.0+
+- Yarn 1.x+
 
 ## Features
 
-* [webpack 4.x.x](https://webpack.js.org/)
-* ES6 with [babel](https://babeljs.io/)
-* 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
-* Extensible and configurable
-
+- [webpack 4.x.x](https://webpack.js.org/)
+- ES6 with [babel](https://babeljs.io/)
+- 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
+- Extensible and configurable
 
 ## Installation
 
@@ -84,15 +83,12 @@ Or add it to your `Gemfile`:
 
 ```ruby
 # Gemfile
-gem 'webpacker', '~> 3.5'
+gem 'webpacker', '~> 5.x'
 
 # OR if you prefer to use master
 gem 'webpacker', git: 'https://github.com/rails/webpacker.git'
 yarn add https://github.com/rails/webpacker.git
-
-# OR to try out 4.x pre-release
-gem 'webpacker', '>= 4.0.x'
-yarn add @rails/webpacker@next
+yarn add core-js regenerator-runtime
 ```
 
 Finally, run the following to install Webpacker:
@@ -111,6 +107,12 @@ Optional: To fix ["unmet peer dependency" warnings](https://github.com/rails/web
 yarn upgrade
 ```
 
+When `package.json` and/or `yarn.lock` changes, such as when pulling down changes to your local environment in a team settings, be sure to keep your NPM packages up-to-date:
+
+```bash
+yarn install
+```
+
 ### Usage
 
 Once installed, you can start writing modern ES6-flavored JavaScript apps right away:
@@ -120,12 +122,22 @@ app/javascript:
   ├── packs:
   │   # only webpack entry files here
   │   └── application.js
-  └── src:
   │   └── application.css
+  └── src:
+  │   └── my_component.js
+  └── stylesheets:
+  │   └── my_styles.css
   └── images:
       └── logo.svg
 ```
 
+In `/packs/application.js`, include this at the top of the file:
+
+```js
+import 'core-js/stable'
+import 'regenerator-runtime/runtime'
+```
+
 You can then link the JavaScript pack in Rails views using the `javascript_pack_tag` helper.
 If you have styles imported in your pack file, you can link them by using `stylesheet_pack_tag`:
 
@@ -170,7 +182,6 @@ helper otherwise you will get duplicated chunks on the page.
 **Note:** In order for your styles or static assets files to be available in your view,
 you would need to link them in your "pack" or entry file.
 
-
 ### Development
 
 Webpacker ships with two binstubs: `./bin/webpack` and `./bin/webpack-dev-server`.
@@ -235,7 +246,6 @@ WEBPACKER_DEV_SERVER_HOST=0.0.0.0 ./bin/webpack-dev-server
 
 See [docs/webpack](docs/webpack.md) for modifying webpack configuration and loaders.
 
-
 ### Custom Rails environments
 
 Out of the box Webpacker ships with - development, test and production environments in `config/webpacker.yml` however, in most production apps extra environments are needed as part of deployment workflow. Webpacker supports this out of the box from version 3.4.0+ onwards.
@@ -285,7 +295,6 @@ bundle exec rails assets:precompile
 bundle exec rails webpacker:compile
 ```
 
-
 ### Upgrading
 
 You can run following commands to upgrade Webpacker to the latest stable version. This process involves upgrading the gem and related JavaScript packages:
@@ -294,173 +303,29 @@ You can run following commands to upgrade Webpacker to the latest stable version
 bundle update webpacker
 rails webpacker:binstubs
 yarn upgrade @rails/webpacker --latest
-yarn add webpack-dev-server@^3.1.14
+yarn upgrade webpack-dev-server --latest
 
-# Or to install a latest release (including pre-releases)
+# Or to install the latest release (including pre-releases)
 yarn add @rails/webpacker@next
 ```
 
-### Yarn Integrity
-
-By default, in development, webpacker runs a yarn integrity check to ensure that all local JavaScript packages are up-to-date. This is similar to what bundler does currently in Rails, but for JavaScript packages. If your system is out of date, then Rails will not initialize. You will be asked to upgrade your local JavaScript packages by running `yarn install`.
-
-To turn off this option, you will need to change the default setting in `config/webpacker.yml`:
-
-```yaml
-# config/webpacker.yml
-development:
-  ...
-  # Verifies that versions and hashed value of the package contents in the project's package.json
-  check_yarn_integrity: false
-```
-
-You may also turn on this feature by adding the config option for any Rails environment in `config/webpacker.yml`:
-
-```yaml
-  check_yarn_integrity: true
-```
-
 ## Integrations
 
-Webpacker ships with basic out-of-the-box integration for React, Angular, Vue and Elm.
-You can see a list of available commands/tasks by running `bundle exec rails webpacker`:
-
-### React
-
-To use Webpacker with [React](https://facebook.github.io/react/), create a
-new Rails 5.1+ app using `--webpack=react` option:
-
-```bash
-# Rails 5.1+
-rails new myapp --webpack=react
-```
-
-(or run `bundle exec rails webpacker:install:react` in a existing Rails app already
-setup with Webpacker).
-
-The installer will add all relevant dependencies using Yarn, changes
-to the configuration files, and an example React component to your
-project in `app/javascript/packs` so that you can experiment with React right away.
-
-
-### Angular with TypeScript
-
-To use Webpacker with [Angular](https://angular.io/), create a
-new Rails 5.1+ app using `--webpack=angular` option:
-
-```bash
-# Rails 5.1+
-rails new myapp --webpack=angular
-```
-
-(or run `bundle exec rails webpacker:install:angular` on a Rails app already
-setup with Webpacker).
-
-The installer will add the TypeScript and Angular core libraries using Yarn alongside
-a few changes to the configuration files. An example component written in
-TypeScript will also be added to your project in `app/javascript` so that
-you can experiment with Angular right away.
-
-By default, Angular uses a JIT compiler for development environment. This
-compiler is not compatible with restrictive CSP (Content Security
-Policy) environments like Rails 5.2+. You can use Angular AOT compiler
-in development with the [@ngtools/webpack](https://www.npmjs.com/package/@ngtools/webpack#usage) plugin.
-
-Alternatively if you're using Rails 5.2+ you can enable `unsafe-eval` rule for your
-development environment. This can be done in the `config/initializers/content_security_policy.rb`
-with the following code:
+Webpacker ships with basic out-of-the-box integration. You can see a list of available commands/tasks by running `bundle exec rails webpacker`.
 
-```ruby
-Rails.application.config.content_security_policy do |policy|
-  if Rails.env.development?
-    policy.script_src :self, :https, :unsafe_eval
-  else
-    policy.script_src :self, :https
-  end
-end
-```
-
-
-### Vue
-
-To use Webpacker with [Vue](https://vuejs.org/), create a
-new Rails 5.1+ app using `--webpack=vue` option:
-
-```bash
-# Rails 5.1+
-rails new myapp --webpack=vue
-```
-(or run `bundle exec rails webpacker:install:vue` on a Rails app already setup with Webpacker).
-
-The installer will add Vue and its required libraries using Yarn alongside
-automatically applying changes needed to the configuration files. An example component will
-be added to your project in `app/javascript` so that you can experiment with Vue right away.
-
-If you're using Rails 5.2+ you'll need to enable `unsafe-eval` rule for your development environment.
-This can be done in the `config/initializers/content_security_policy.rb` with the following
-configuration:
-
-```ruby
-Rails.application.config.content_security_policy do |policy|
-  if Rails.env.development?
-    policy.script_src :self, :https, :unsafe_eval
-  else
-    policy.script_src :self, :https
-  end
-end
-```
-You can read more about this in the [Vue docs](https://vuejs.org/v2/guide/installation.html#CSP-environments).
-
-
-### Elm
-
-To use Webpacker with [Elm](http://elm-lang.org), create a
-new Rails 5.1+ app using `--webpack=elm` option:
-
-```
-# Rails 5.1+
-rails new myapp --webpack=elm
-```
-
-(or run `bundle exec rails webpacker:install:elm` on a Rails app already setup with Webpacker).
-
-The Elm library and its core packages will be added via Yarn and Elm.
-An example `Main.elm` app will also be added to your project in `app/javascript`
-so that you can experiment with Elm right away.
+Included install integrations:
 
-### Stimulus
-
-To use Webpacker with [Stimulus](http://stimulusjs.org), create a
-new Rails 5.1+ app using `--webpack=stimulus` option:
-
-```
-# Rails 5.1+
-rails new myapp --webpack=stimulus
-```
-
-(or run `bundle exec rails webpacker:install:stimulus` on a Rails app already setup with Webpacker).
-
-Please read [The Stimulus Handbook](https://stimulusjs.org/handbook/introduction) or learn more about its source code at https://github.com/stimulusjs/stimulus
-
-### Coffeescript
-
-To add [Coffeescript](http://coffeescript.org/) support,
-run `bundle exec rails webpacker:install:coffee` on a Rails app already
-setup with Webpacker.
-
-An example `hello_coffee.coffee` file will also be added to your project
-in `app/javascript/packs` so that you can experiment with Coffeescript right away.
-
-### Erb
-
-To add [Erb](https://apidock.com/ruby/ERB) support in your JS templates,
-run `bundle exec rails webpacker:install:erb` on a Rails app already
-setup with Webpacker.
-
-An example `hello_erb.js.erb` file will also be added to your project
-in `app/javascript/packs` so that you can experiment with Erb-flavoured
-javascript right away.
+- [React](./docs/integrations.md#React)
+- [Angular with TypeScript](./docs/integrations.md#Angular-with-TypeScript)
+- [Vue](./docs/integrations.md#Vue)
+- [Elm](./docs/integrations.md#Elm)
+- [Svelte](./docs/integrations.md#Svelte)
+- [Stimulus](./docs/integrations.md#Stimulus)
+- [CoffeeScript](./docs/integrations.md#CoffeeScript)
+- [Typescript](./docs/typescript.md)
+- [Erb](./docs/integrations.md#Erb)
 
+See [Integrations](./docs/integrations.md) for further details.
 
 ## Paths
 
@@ -497,17 +362,16 @@ development:
 
 If you have `hmr` turned to true, then the `stylesheet_pack_tag` generates no output, as you will want to configure your styles to be inlined in your JavaScript for hot reloading. During production and testing, the `stylesheet_pack_tag` will create the appropriate HTML tags.
 
-
 ### Resolved
 
 If you are adding Webpacker to an existing app that has most of the assets inside
 `app/assets` or inside an engine, and you want to share that
-with webpack modules, you can use the `resolved_paths`
+with webpack modules, you can use the `additional_paths`
 option available in `config/webpacker.yml`. This lets you
 add additional paths that webpack should lookup when resolving modules:
 
 ```yml
-resolved_paths: ['app/assets']
+additional_paths: ['app/assets']
 ```
 
 You can then import these items inside your modules like so:
@@ -522,35 +386,38 @@ import 'images/rails.png'
 will make the compilation slow, consider adding specific paths instead of
 whole parent directory if you just need to reference one or two modules
 
-
-### Watched
-
-By default, the lazy compilation is cached until a file is changed under your
-tracked paths. You can configure which paths are tracked
-by adding new paths to `watched_paths` array. This is much like Rails' `autoload_paths`:
-
-```rb
-# config/initializers/webpacker.rb
-# or config/application.rb
-Webpacker::Compiler.watched_paths << 'bower_components'
-```
-
-
 ## Deployment
 
 Webpacker hooks up a new `webpacker:compile` task to `assets:precompile`, which gets run whenever you run `assets:precompile`. If you are not using Sprockets, `webpacker:compile` is automatically aliased to `assets:precompile`. Similar to sprockets both rake tasks will compile packs in production mode but will use `RAILS_ENV` to load configuration from `config/webpacker.yml` (if available).
 
+When compiling assets for production on a remote server, such as a continuous integration environment, it's recommended to use `yarn install --frozen-lockfile` to install NPM packages on the remote host to ensure that the installed packages match the `yarn.lock` file.
 
 ## Docs
 
-You can find more detailed guides under [docs](./docs).
-
+- [Development](https://github.com/rails/webpacker#development)
+  - [Webpack](./docs/webpack.md)
+  - [Webpack-dev-server](./docs/webpack-dev-server.md)
+  - [Environment Variables](./docs/env.md)
+  - [Folder Structure](./docs/folder-structure.md)
+  - [Assets](./docs/assets.md) - [CSS, Sass and SCSS](./docs/css.md) - [ES6](./docs/es6.md), [Target browsers](./docs/target.md)
+    - [Props](./docs/props.md)
+    - [Typescript](./docs/typescript.md)
+  - [Yarn](./docs/yarn.md)
+  - [Misc](./docs/misc.md)
+- [Deployment](./docs/deployment.md)
+  - [Docker](./docs/docker.md)
+  - [Using in Rails engines](./docs/engines.md)
+  - [Webpacker on Cloud9](./docs/cloud9.md)
+- [Testing](./docs/testing.md)
+- [Troubleshooting](./docs/troubleshooting.md)
+- [v3 to v4 Upgrade Guide](./docs/v4-upgrade.md)
 
 ## Contributing
+
 [![Code Helpers](https://www.codetriage.com/rails/webpacker/badges/users.svg)](https://www.codetriage.com/rails/webpacker)
 
 We encourage you to contribute to Webpacker! See [CONTRIBUTING](CONTRIBUTING.md) for guidelines about how to proceed.
 
-
 ## License
+
 Webpacker is released under the [MIT License](https://opensource.org/licenses/MIT).

data/docs/assets.md

@@ -84,26 +84,36 @@ import 'assets/stylesheets/bar'
 ## Link in your Rails views
 
 You can also link `js/images/styles/fonts` used within your js app in views using
-`asset_pack_path` helper. This helper is useful in cases where you just want to
+`asset_pack_path` and `image_pack_tag` helpers. These helpers are useful in cases where you just want to
 create a `<link rel="prefetch">` or `<img />` for an asset.
 
 ```yml
 app/javascript:
   - packs
-    - hello_react.js
-  - styles
-    - hello_react.css
+    - app.js
   - images
     - calendar.png
 ```
 
+```js
+// app/javascript/packs/app.js (or any of your packs)
+
+// import all image files in a folder:
+require.context('../images', true)
+```
+
 ```erb
-<%= asset_pack_path 'hello_react.css' %>
-<%# => "/packs/hello_react.css" %>
+<%# Rails view, for example app/views/layouts/application.html.erb %>
+
+<img src="<%= asset_pack_path 'media/images/calendar.png' %>" />
+<% # => <img src="/packs/media/images/calendar-k344a6d59eef8632c9d1.png" /> %>
 
-<img src="<%= asset_pack_path 'images/calendar.png' %>" />
-<% # => <img src="/packs/images/calendar.png" /> %>
+<%= image_pack_tag 'media/images/calendar.png' %>
+<% # => <img src="/packs/media/images/calendar-k344a6d59eef8632c9d1.png" /> %>
 
-<%= image_pack_tag 'images/calendar.png' %>
-<% # => <img src="/packs/images/calendar.png" /> %>
+<%# no path resolves to default 'images' folder: %>
+<%= image_pack_tag 'calendar.png' %>
+<% # => <img src="/packs/media/images/calendar-k344a6d59eef8632c9d1.png" /> %>
 ```
+
+Note you need to add a `media/` prefix (not `/media/`) to any subfolder structure you might have in `app/javascript`. See more examples in the [tests](https://github.com/rails/webpacker/blob/0b86cadb5ed921e2c1538382e72a236ec30a5d97/test/helper_test.rb#L37).

data/docs/css.md

@@ -3,9 +3,66 @@
 
 Webpacker supports importing CSS, Sass and SCSS files directly into your JavaScript files.
 
+Importing and loading styles is a two step process:
+
+1. You need to tell webpack which file(s) it has to compile and know how to load
+
+   When you do `import '../scss/application.scss'`, you're telling webpack to include `application.scss` in the build. This does not mean it's going to be compiled into your javascript, only that webpack now compiles and knows how to load this file. (How that file compilation is handled is depending on how your loaders (`css-loader`, `sass-loader`, `file-loader`, etc.) are configured.)
+
+2. You need to load those files in your views
+
+   In order to have styles load in production, you need to include `stylesheet_pack_tag` with the same name as the javascript file that imports the styles.
+
+   When you do `<%= stylesheet_pack_tag 'application' %>`, that's a run-time inclusion from Rails, where Rails gets the correct "asset path" to that file from webpack.
+
 
 ## Import global styles into your JS app
 
+### Importing CSS as a multi-file pack (Webpacker v5)
+
+When you add a CSS/SCSS/SASS file to `app/javascript/packs/` directory, make sure to use the same pack name as its complementary JavaScript pack, e.g. `application.js` and `application.css`. By Webpacker convention (as of Webpacker v5), this will bundle `application.js` and `application.scss` as part of the same entry point (also described as [a multi-file entry point in the webpack docs](https://webpack.js.org/concepts/entry-points/#single-entry-shorthand-syntax)). With this approach, you can avoid importing CSS from JS, if desired.
+
+```
+app/
+  javascript/
+    packs/
+      application.js
+      application.scss
+```
+
+### Importing CSS from CSS
+
+You can import additional CSS/SCSS/SASS files from within a CSS file:
+
+```
+app/
+  javascript/
+    stylesheets/
+      application.scss
+      posts.scss
+      comments.scss
+```
+
+```css
+/* app/javascript/stylesheets/application.scss */
+
+@import './posts';
+@import './comments';
+```
+
+### Importing CSS provided by an NPM package from SCSS/CSS
+
+Given your application installs an NPM package that provides CSS, such as `flatpickr`, you can import the CSS file(s) by path from the package directory within `node_modules/`:
+
+```js
+/* app/javascript/stylesheets/application.scss */
+
+@import "flatpickr/dist/flatpickr.css"
+```
+
+
+### Importing CSS from JS
+
 ```sass
 // app/javascript/hello_react/styles/hello-react.sass
 
@@ -30,9 +87,19 @@ const Hello = props => (
 )
 ```
 
+### Importing CSS provided by an NPM package from JS
+
+Given your application installs an NPM package that provides CSS, such as `flatpickr`, you can import the CSS file(s) by path from the package directory within `node_modules/`. This is an alternative to importing from within a CSS file, as above:
+
+```js
+// app/javascript/packs/application.js
+
+import "flatpickr/dist/flatpickr.css"
+```
+
 ## Import scoped styles into your JS app
 
-Stylesheets end with `.module.*` is treated as [CSS Modules](https://github.com/css-modules/css-modules).
+Stylesheets that end with `.module.*` are treated as [CSS Modules](https://github.com/css-modules/css-modules).
 
 ```sass
 // app/javascript/hello_react/styles/hello-react.module.sass
@@ -60,6 +127,59 @@ const Hello = props => (
 
 **Note:** Declared class is referenced as object property in JavaScript.
 
+## Import scoped styles into your TypeScript app
+
+Using CSS modules with a TypeScript application requires a few differences from a JavaScript app. The CSS / Sass files are the same:
+
+```sass
+// app/javascript/hello_react/styles/hello-react.module.sass
+
+.helloReact
+  padding: 20px
+  font-size: 12px
+```
+
+There must also be a type definition file for these styles:
+
+```typescript
+export const helloReact: string;
+```
+
+You can then import the styles like this:
+
+```typescript
+// React component example
+// app/javascripts/packs/hello_react.tsx
+
+import React from 'react'
+import helloIcon from '../hello_react/images/icon.png'
+import * as styles from '../hello_react/styles/hello-react.module.sass'
+
+const Hello = props => (
+  <div className={styles.helloReact}>
+    <img src={helloIcon} alt="hello-icon" />
+    <p>Hello {props.name}!</p>
+  </div>
+)
+```
+
+You can automatically generate type definitions for the styles by installing the `typed-scss-modules` as a development dependency:
+
+```
+yarn add typed-scss-modules --dev
+```
+
+Then by adding these lines to your `package.json`:
+
+```
+"scripts": {
+  "gen-typings": "yarn run tsm app/javascript/**/*.sass",
+  "watch-typings": "yarn run tsm app/javascript/**/*.sass -w"
+},
+```
+
+You can generate the typings for the stylesheet by running the command `yarn gen-typings` when you've finished writing CSS, or run `yarn watch-typings` to have it automatically generate them as you go.
+
 
 ## Link styles from your Rails views
 
@@ -82,14 +202,14 @@ You can use Yarn to add bootstrap or any other modules available on npm:
 yarn add bootstrap
 ```
 
-Import Bootstrap and theme (optional) CSS in your app/javascript/packs/app.js file:
+Import Bootstrap and theme (optional) CSS in your app/javascript/packs/application.js file:
 
 ```js
 import 'bootstrap/dist/css/bootstrap'
 import 'bootstrap/dist/css/bootstrap-theme'
 ```
 
-Or in your app/javascript/app.sass file:
+Or in your app/javascript/packs/application.sass file:
 
 ```sass
 // ~ to tell that this is not a relative import
@@ -148,11 +268,10 @@ const { environment } = require('@rails/webpacker')
 
 // resolve-url-loader must be used before sass-loader
 environment.loaders.get('sass').use.splice(-1, 0, {
-  loader: 'resolve-url-loader',
-  options: {
-    attempts: 1
-  }
+  loader: 'resolve-url-loader'
 });
+
+module.exports = environment
 ```
 
 ## Working with TypeScript