webpacker 6.0.0.beta → 6.0.0.beta.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19faa9561fccec8279b1d8031c2a386c44554ba0f24acc048ec4856853900fc5
-  data.tar.gz: a10901426f6b8ff524c243ddc21392ada8cf189fd85d63d3a6b558cd71b4237f
+  metadata.gz: eee103ac302f31dfd3aab8246c08b6f38409be2bb226c9980b2f3ab55d8222bf
+  data.tar.gz: 6bd2f9be419e82dbbcc2a3142bd1f2f9c0ff7ea80373143f0eb60dd1fc118a7c
 SHA512:
-  metadata.gz: cda09944b075aa8da83a0c568f656d63b040b4c110b5a87f1e5962b60c24e63d70020a4648c1133674611a64178f048ad081128ea891df1950f82957e7a2a5da
-  data.tar.gz: aa72ec1ac73614d32405ca4dfbfbd05e910167599b30e9ed91b3360bdbc0ba12db577fb55096942f6e1a468e21e1e05ccf8bfc5b80596fb3f68e187a73fe1a63
+  metadata.gz: 98cb1515161e7787a62a2c53cc617a5ae7b754a8d47bbecd32bf55f5707c5238437ef5df64fbe9798183825e1b209ed918095ed0bcf59566ab9a55fbcfdfdd27
+  data.tar.gz: c1cde3f92061eb6f1fe1c23506c0f2299b7a4c0c7d1b046a168630fd15e7c217ab4dbdfdabef8acb39e743058b41b1912eb3ede1320b07aa945ea4e7ea59a319

data/.github/workflows/jest.yml

@@ -8,7 +8,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest]
-        node: [10.x, 12.x, 14.x]
+        node: [10.x, 12.x, 14.x, 15.x]
 
     runs-on: ${{ matrix.os }}
 

data/.github/workflows/js-lint.yml

@@ -9,7 +9,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest]
-        node: [12.x]
+        node: [14.x]
 
     runs-on: ${{ matrix.os }}
 

data/.github/workflows/ruby.yml

@@ -18,7 +18,8 @@ jobs:
           2.4,
           2.5,
           2.6,
-          2.7
+          2.7,
+          3.0
         ]
         gemfile: [
           "gemfiles/Gemfile-rails.5.2.x",
@@ -27,13 +28,11 @@ jobs:
         exclude:
           - ruby: "2.4"
             gemfile: gemfiles/Gemfile-rails.6.0.x
+          - ruby: "3.0"
+            gemfile: gemfiles/Gemfile-rails.5.2.x
         experimental: [false]
         include:
-          - ruby: head
-            os: ubuntu-latest
-            gemfile: gemfiles/Gemfile-rails.6.0.x
-            experimental: true
-          - ruby: head
+          - ruby: 2.5
             os: ubuntu-latest
             gemfile: gemfiles/Gemfile-rails-edge
             experimental: true
@@ -45,6 +44,10 @@ jobs:
             os: ubuntu-latest
             gemfile: gemfiles/Gemfile-rails-edge
             experimental: true
+          - ruby: 3.0
+            os: ubuntu-latest
+            gemfile: gemfiles/Gemfile-rails-edge
+            experimental: true
 
     steps:
       - uses: actions/checkout@v2

data/6_0_upgrade.md

@@ -6,17 +6,20 @@ straightforward.
 
 ## Preparation
 
-- Rename `config/webpack` to `config/webpack_old`
-- Rename `config/webpacker.yml` to `config/webpacker_old.yml`
-- Upgrade webpacker
+1. If your `source_path` is `app/javascript`, rename it to `app/packs`
+2. If your `source_entry_path` is `app/javascript/packs`, rename it to `app/packs/entrypoints`
+3. Rename `config/webpack` to `config/webpack_old`
+4. Rename `config/webpacker.yml` to `config/webpacker_old.yml`
+5. Uninstall the current version of `webpack-dev-server`: `yarn remove webpack-dev-server`
+6. Upgrade webpacker
 
   ```ruby
   # Gemfile
-  gem 'webpacker', '~> 6.x'
+  gem 'webpacker', '~> 6.0.0.pre.2'
   ```
 
-  ```
-  bundle
+  ```bash
+  bundle install
   ```
 
   ```bash
@@ -27,12 +30,15 @@ straightforward.
   bundle exec rails webpacker:install
   ```
 
-- Change `javascript_pack_tag` and `stylesheet_pack_tag` to `javascript_packs_with_chunks_tag` and
-  `stylesheet_packs_with_chunks_tag`
+- Change `javascript_packs_with_chunks_tag` and `stylesheet_packs_with_chunks_tag` to `javascript_pack_tag` and
+  `stylesheet_pack_tag`.
 
-- If you are using any integrations like css, react or typescript. Please see https://github.com/rails/webpacker#integrations section on how they work in v6.0
+7. If you are using any integrations like `css`, `React` or `TypeScript`. Please see https://github.com/rails/webpacker#integrations section on how they work in v6.0.
 
-- Copy over any custom webpack config from `config/webpack_old`
+8. Copy over any custom webpack config from `config/webpack_old`
+
+- Common code previously called 'environment' changed to 'base' 
+- import `environment` changed name to `webpackConfig`.
 
   ```js
   // config/webpack/base.js
@@ -41,3 +47,16 @@ straightforward.
 
   module.exports = merge(webpackConfig, customConfig)
   ```
+
+9. Copy over custom browserlist config from `.browserlistrc` if it exists into the `"browserlist"` key in `package.json` and remove `.browserslistrc`.
+
+10. `extensions` was removed from the webpacker.yml file. Move custom extensions to
+  your configuration by by merging an object like this. For more details, see docs for 
+  [Webpack Configuration](https://github.com/rails/webpacker/blob/master/README.md#webpack-configuration)
+```js
+{
+  resolve: {
+      extensions: ['.ts', '.tsx']
+  }
+}
+```

data/CHANGELOG.md

@@ -17,6 +17,8 @@ environment.loaders.append('nodeModules', nodeModules)
 - Changes `@babel/preset-env` modules option to `'auto'` per recommendation in the Babel docs [#2709](https://github.com/rails/webpacker/pull/2709)
 - Adds experimental Yarn 2 support. Note you must manually set `nodeLinker: node-modules` in your `.yarnrc.yml`.
 
+- Fixes dev server issues [#2898](https://github.com/rails/webpacker/pull/2898)
+
 ### Breaking changes
 
 - Simple webpack config

data/CONTRIBUTING.md

@@ -9,7 +9,7 @@ yarn
 ```
 
 ## Making sure your changes pass all tests
-There are a number of automated checks which run on Github Actions when a pull request is created.
+There are a number of automated checks which run on GitHub Actions when a pull request is created.
 You can run those checks on your own locally to make sure that your changes would not break the CI build.
 
 ### 1. Check the code for JavaScript style violations

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    webpacker (6.0.0.beta)
+    webpacker (6.0.0.beta.5)
       activesupport (>= 5.2)
       rack-proxy (>= 0.6.1)
       railties (>= 5.2)
@@ -85,14 +85,16 @@ GEM
     method_source (1.0.0)
     mimemagic (0.3.5)
     mini_mime (1.0.2)
-    mini_portile2 (2.4.0)
-    minitest (5.14.1)
+    mini_portile2 (2.5.0)
+    minitest (5.14.3)
     nio4r (2.5.2)
-    nokogiri (1.10.10)
-      mini_portile2 (~> 2.4.0)
+    nokogiri (1.11.1)
+      mini_portile2 (~> 2.5.0)
+      racc (~> 1.4)
     parallel (1.19.2)
     parser (2.7.2.0)
       ast (~> 2.4.1)
+    racc (1.5.2)
     rack (2.2.3)
     rack-proxy (0.6.5)
       rack

data/README.md

@@ -59,13 +59,13 @@ in which case you may not even need the asset pipeline. This is mostly relevant
 - Rails view helpers
 - Extensible and configurable
 
-  ### Optional support\*
+### Optional support
 
   _requires extra packages to be installed_
 
-  - Stylesheets - SASS, LESS and CSS, PostCSS
-  - Coffeescript
-  - Typescript
+  - Stylesheets - Sass, Less, Stylus and Css, PostCSS
+  - CoffeeScript
+  - TypeScript
   - React
 
 ## Installation
@@ -108,7 +108,8 @@ 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
+# default for `yarn` is to install
+yarn
 ```
 
 ### Usage
@@ -116,9 +117,9 @@ yarn install
 Once installed, you can start writing modern ES6-flavored JavaScript apps right away:
 
 ```yml
-app/javascript:
-  ├── packs:
-  │   # only webpack entry files here
+app/packs:
+  ├── entrypoints:
+  │   # Only webpack entry files here
   │   └── application.js
   │   └── application.css
   └── src:
@@ -129,23 +130,50 @@ app/javascript:
       └── logo.svg
 ```
 
-You can then link the JavaScript pack in Rails views using the `javascript_packs_with_chunks_tag` helper. If you have styles imported in your pack file, you can link them by using `stylesheet_packs_with_chunks_tag`:
+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_packs_with_chunks_tag`:
 
 ```erb
-<%= javascript_packs_with_chunks_tag 'application' %>
+<%= javascript_pack_tag 'application' %>
 <%= stylesheet_packs_with_chunks_tag 'application' %>
 ```
 
-If you want to link a static asset for `<link rel="prefetch">` or `<img />` tag, you
-can use the `asset_pack_path` helper:
-
+If you want to link a static asset for `<img />` tag, you can use the `asset_pack_path` helper:
 ```erb
-<link rel="prefetch" href="<%= asset_pack_path 'application.css' %>" />
 <img src="<%= asset_pack_path 'images/logo.svg' %>" />
 ```
 
+Or use the dedicated helper:
+```erb
+<%= image_pack_tag 'application.png', size: '16x10', alt: 'Edit Entry' %>
+<%= image_pack_tag 'picture.png', srcset: { 'picture-2x.png' => '2x' } %>
+```
+
+If you want to create a favicon:
+```erb
+<%= favicon_pack_tag 'mb-icon.png', rel: 'apple-touch-icon', type: 'image/png' %>
+```
+
+If you want to preload a static asset in your `<head>`, you can use the `preload_pack_asset` helper:
+```erb
+<%= preload_pack_asset 'fonts/fa-regular-400.woff2' %>
+```
+
+If you want to use images in your stylesheets:
+
+```css
+.foo {
+  background-image: url('../images/logo.svg')
+}
+```
+
+Note, if you are using server-side rendering of JavaScript with dynamic code-spliting, 
+as is often done with extensions to Webpacker, like [React on Rails](https://github.com/shakacode/react_on_rails)
+your JavaScript should create the link prefetch HTML tags that you will use, so you won't
+need to use to `asset_pack_path` in those circumstances.
+
 **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.
+you would need to link them in your "pack" or entry file. Otherwise, Webpack won't know
+to package up those files.
 
 ### Development
 
@@ -157,11 +185,20 @@ are loaded based on your environment.
 In development, Webpacker compiles on demand rather than upfront by default. This
 happens when you refer to any of the pack assets using the Webpacker helper methods.
 This means that you don't have to run any separate processes. Compilation errors are logged
-to the standard Rails log.
+to the standard Rails log. However, this auto-compilation happens when a web request
+is made that requires an updated webpack build, not when files change. Thus, that can
+be painfully slow for front-end development in this default way. Instead, you should either
+run the `bin/webpack --watch` or run `./bin/webpack-dev-server`
+
+If you want to use live code reloading, or you have enough JavaScript that on-demand compilation is too slow, you'll need to run `./bin/webpack-dev-server` or `ruby ./bin/webpack-dev-server`.
+Windows users will need to run these commands in a terminal separate from `bundle exec rails s`. 
+This process will watch for changes in the `app/packs/entrypoints/*.js` files and automatically
+reload the browser to match. This feature is also known as
+[Hot Module Replacement](https://webpack.js.org/concepts/hot-module-replacement/).
 
-If you want to use live code reloading, or you have enough JavaScript that on-demand compilation is too slow, you'll need to run `./bin/webpack-dev-server` or `ruby ./bin/webpack-dev-server`. Windows users will need to run these commands
-in a terminal separate from `bundle exec rails s`. This process will watch for changes
-in the `app/javascript/packs/*.js` files and automatically reload the browser to match.
+HMR is only the first step to running "Fast Refresh" with React. For more information
+on how to configure rails/webpacker for Fast Refresh with React, see article
+[HMR and React Hot Reloading](https://github.com/shakacode/react_on_rails/blob/master/docs/rails-webpacker-react-integration-options.md#hmr-and-react-hot-reloading).
 
 ```bash
 # webpack dev server
@@ -174,9 +211,10 @@ in the `app/javascript/packs/*.js` files and automatically reload the browser to
 ./bin/webpack
 ```
 
-Once you start this development server, Webpacker will automatically start proxying all
-webpack asset requests to this server. When you stop the server, it'll revert back to
-on-demand compilation.
+Once you start this webpack development server, Webpacker will automatically start proxying all
+webpack asset requests to this server. When you stop this server, Rails will detect
+that it's not running and Rails will revert back to on-demand compilation _if_ you have
+the `compile` option set to true in your `config/webpacker.yml`
 
 You can use environment variables as options supported by
 [webpack-dev-server](https://webpack.js.org/configuration/dev-server/) in the
@@ -212,7 +250,7 @@ WEBPACKER_DEV_SERVER_HOST=0.0.0.0 ./bin/webpack-dev-server
 Webpacker gives you a default set of configuration files for test, development and
 production environments in `config/webpack/*.js`. You can configure each individual
 environment in their respective files or configure them all in the base
-`config/webpack/environment.js` file.
+`config/webpack/base.js` file.
 
 By default, you don't need to make any changes to `config/webpack/*.js`
 files since it's all standard production-ready configuration. However,
@@ -256,23 +294,26 @@ const { webpackConfig } = require('@rails/webpacker')
 
 console.log(webpackConfig.output_path)
 console.log(webpackConfig.source_path)
+
+// Or to print out your whole webpack configuration
+console.log(JSON.stringify(webpackConfig, undefined, 2))
 ```
 
 ### Integrations
 
 Webpacker out of the box supports JS and static assets (fonts, images etc.)
-compilation. To enable support for Coffeescript or Typescript install
-relevant packages,
+compilation. To enable support for CoffeeScript or TypeScript install
+relevant packages:
 
-**Coffeescript**
+#### CoffeeScript
 
-```
+```bash
 yarn add coffeescript coffee-loader
 ```
 
-**Typescript**
+#### TypeScript
 
-```
+```bash
 yarn add typescript @babel/preset-typescript
 ```
 
@@ -289,7 +330,7 @@ Add tsconfig.json
     "moduleResolution": "node",
     "baseUrl": ".",
     "paths": {
-      "*": ["node_modules/*", "app/javascript/*"]
+      "*": ["node_modules/*", "app/packs/*"]
     },
     "sourceMap": true,
     "target": "es5",
@@ -302,13 +343,13 @@ Add tsconfig.json
 
 #### CSS
 
-To enable CSS support in your application, add following packages,
+To enable CSS support in your application, add following packages:
 
-```
+```bash
 yarn add css-loader mini-css-extract-plugin css-minimizer-webpack-plugin
 ```
 
-optionally, add css extension to webpack config for easy resolution
+optionally, add the css extension to webpack config for easy resolution.
 
 ```js
 // config/webpack/base.js
@@ -327,27 +368,33 @@ then add the relevant pre-processors:
 
 #### Postcss
 
-```
+```bash
 yarn add postcss-loader
 ```
 
 #### Sass
 
-```
-yarn add sass-loader
+```bash
+yarn add sass sass-loader
 ```
 
 #### Less
 
+```bash
+yarn add less less-loader
 ```
-yarn add less-loader
+
+#### Stylus
+
+```bash
+yarn add stylus stylus-loader
 ```
 
 #### React
 
 React is supported and you just need to add relevant packages,
 
-```
+```bash
 yarn add react react-dom @babel/preset-react
 ```
 
@@ -372,16 +419,19 @@ if you are using typescript, update your `tsconfig.json`
 }
 ```
 
+For more information on React props hydration and Server-Side Rendering (SSR), see the article
+[Rails/Webpacker React Integration Options](https://github.com/shakacode/react_on_rails/blob/master/docs/rails-webpacker-react-integration-options.md) 
+in the [ShakaCode/react_on_rails](https://github.com/shakacode/react_on_rails) repo.
+
 #### Other frameworks
 
 Please follow webpack integration guide for relevant framework or library,
 
-1. Svelte - https://github.com/sveltejs/svelte-loader#install
-2. Angular - https://v2.angular.io/docs/ts/latest/guide/webpack.html#!#configure-webpack
-3. Vue - https://vue-loader.vuejs.org/guide/
-
-For example to add Vue support,
+1. [Svelte](https://github.com/sveltejs/svelte-loader#install)
+2. [Angular](https://v2.angular.io/docs/ts/latest/guide/webpack.html#!#configure-webpack)
+3. [Vue](https://vue-loader.vuejs.org/guide/)
 
+For example to add Vue support:
 ```js
 // config/webpack/rules/vue.js
 const VueLoaderPlugin = require('vue-loader/lib/plugin')
@@ -397,7 +447,9 @@ module.exports = {
   },
   plugins: [new VueLoaderPlugin()]
 }
+```
 
+```js
 // config/webpack/base.js
 const { webpackConfig, merge } = require('@rails/webpacker')
 const vueConfig = require('./rules/vue')
@@ -445,11 +497,11 @@ Please note, binstubs compiles in development mode however rake tasks
 compiles in production mode.
 
 ```bash
-# Compiles in development mode unless NODE_ENV is specified
+# Compiles in development mode unless NODE_ENV is specified, per the binstub source
 ./bin/webpack
 ./bin/webpack-dev-server
 
-# compiles in production mode by default unless NODE_ENV is specified
+# Compiles in production mode by default unless NODE_ENV is specified, per `lib/tasks/webpacker/compile.rake`
 bundle exec rails assets:precompile
 bundle exec rails webpacker:compile
 ```
@@ -459,8 +511,12 @@ bundle exec rails webpacker:compile
 You can run following commands to upgrade Webpacker to the latest stable version. This process involves upgrading the gem and related JavaScript packages:
 
 ```bash
+# check your Gemfile for version restrictions
 bundle update webpacker
+
+# overwrite your changes to the default install files and revert any unwanted changes from the install
 rails webpacker:install
+
 yarn upgrade @rails/webpacker --latest
 yarn upgrade webpack-dev-server --latest
 
@@ -468,6 +524,8 @@ yarn upgrade webpack-dev-server --latest
 yarn add @rails/webpacker@next
 ```
 
+Also, consult the [CHANGELOG](./CHANGELOG.md) for additional upgrade links.
+
 ## Paths
 
 By default, Webpacker ships with simple conventions for where the JavaScript
@@ -475,19 +533,18 @@ app files and compiled webpack bundles will go in your Rails app.
 All these options are configurable from `config/webpacker.yml` file.
 
 The configuration for what webpack is supposed to compile by default rests
-on the convention that every file in `app/javascript/packs/*`**(default)**
+on the convention that every file in `app/packs/entrypoints/*`**(default)**
 or whatever path you set for `source_entry_path` in the `webpacker.yml` configuration
 is turned into their own output files (or entry points, as webpack calls it). Therefore you don't want to put anything inside `packs` directory that you do not want to be
 an entry file. As a rule of thumb, put all files you want to link in your views inside
-"packs" directory and keep everything else under `app/javascript`.
+"packs" directory and keep everything else under `app/packs`.
 
-Suppose you want to change the source directory from `app/javascript`
+Suppose you want to change the source directory from `app/packs`
 to `frontend` and output to `assets/packs`. This is how you would do it:
 
 ```yml
 # config/webpacker.yml
-source_path: frontend
-source_entry_path: packs
+source_path: frontend # packs are in frontend/packs
 public_output_path: assets/packs # outputs to => public/assets/packs
 ```
 
@@ -501,7 +558,9 @@ development:
     port: 3035
 ```
 
-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.
+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.
 
 ### Additional paths
 
@@ -512,7 +571,7 @@ option available in `config/webpacker.yml`. This lets you
 add additional paths that webpack should lookup when resolving modules:
 
 ```yml
-additional_paths: ['app/assets/**/*', 'vendor/assets/**/*.css', 'Gemfile']
+additional_paths: ['app/assets', 'vendor/assets']
 ```
 
 You can then import these items inside your modules like so:
@@ -533,6 +592,10 @@ Webpacker hooks up a new `webpacker:compile` task to `assets:precompile`, which
 
 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.
 
+## Troubleshooting
+
+See the doc page for [Troubleshooting](./docs/troubleshooting.md).
+
 ## Contributing
 
 [![Code Helpers](https://www.codetriage.com/rails/webpacker/badges/users.svg)](https://www.codetriage.com/rails/webpacker)