RubyGems - webpacker - Versions diffs - 6.0.0.beta.2 → 6.0.0.beta.7 - Mend

webpacker 6.0.0.beta.2 → 6.0.0.beta.7

Files changed (53) hide show

checksums.yaml +4 -4
data/.github/workflows/jest.yml +1 -1
data/.github/workflows/js-lint.yml +1 -1
data/.github/workflows/ruby.yml +9 -6
data/.rubocop.yml +105 -0
data/CHANGELOG.md +6 -4
data/CONTRIBUTING.md +1 -1
data/Gemfile.lock +93 -90
data/README.md +133 -58
data/config/README.md +3 -0
data/config/webpacker.yml +1 -0
data/docs/deployment.md +128 -0
data/docs/troubleshooting.md +160 -0
data/docs/v6_upgrade.md +86 -0
data/lib/install/config/webpacker.yml +5 -3
data/lib/install/{javascript/packs → packs/entrypoints}/application.js +1 -1
data/lib/install/template.rb +16 -9
data/lib/tasks/webpacker/binstubs.rake +2 -2
data/lib/tasks/webpacker/check_node.rake +1 -0
data/lib/tasks/webpacker/check_yarn.rake +1 -0
data/lib/tasks/webpacker/install.rake +2 -2
data/lib/webpacker/commands.rb +2 -1
data/lib/webpacker/compiler.rb +2 -2
data/lib/webpacker/configuration.rb +4 -4
data/lib/webpacker/dev_server_runner.rb +2 -0
data/lib/webpacker/helper.rb +13 -43
data/lib/webpacker/manifest.rb +1 -1
data/lib/webpacker/version.rb +1 -1
data/lib/webpacker/webpack_runner.rb +1 -0
data/package.json +1 -1
data/package/__tests__/development.js +2 -1
data/package/__tests__/index.js +9 -0
data/package/environments/__tests__/base.js +4 -4
data/package/environments/base.js +3 -8
data/package/environments/development.js +1 -0
data/package/environments/production.js +1 -1
data/package/index.js +3 -3
data/package/rules/babel.js +1 -1
data/package/rules/stylus.js +1 -1
data/package/utils/helpers.js +4 -2
data/test/configuration_test.rb +2 -2
data/test/dev_server_runner_test.rb +10 -2
data/test/helper_test.rb +33 -39
data/test/manifest_test.rb +8 -0
data/test/mounted_app/test/dummy/config/webpacker.yml +3 -3
data/test/test_app/app/{javascript/packs → packs/entrypoints}/application.js +1 -1
data/test/test_app/app/{javascript/packs → packs/entrypoints}/multi_entry.css +0 -0
data/test/test_app/app/{javascript/packs → packs/entrypoints}/multi_entry.js +0 -0
data/test/test_app/config/webpacker.yml +3 -3
data/test/test_app/public/packs/manifest.json +7 -0
metadata +18 -14
data/6_0_upgrade.md +0 -43
data/lib/install/javascript/packs/application.css +0 -9

data/README.md CHANGED Viewed

@@ -9,7 +9,7 @@
 [![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 5.x.x+](https://webpack.js.org/)
+[Webpack v5](https://webpack.js.org/)
 to manage application-like JavaScript in Rails. It coexists with the asset pipeline,
 as the primary purpose for webpack is app-like JavaScript, not images, CSS, or
 even JavaScript Sprinkles (that all continues to live in app/assets).
@@ -36,7 +36,6 @@ in which case you may not even need the asset pipeline. This is mostly relevant
   - [Resolved](#resolved)
   - [Watched](#watched)
 - [Deployment](#deployment)
-- [Docs](#docs)
 - [Contributing](#contributing)
 - [License](#license)
@@ -47,11 +46,11 @@ in which case you may not even need the asset pipeline. This is mostly relevant
 - Ruby 2.4+
 - Rails 5.2+
 - Node.js 10.22.1+ || 12+ || 14+
-- Yarn 1.x+
+- Yarn 1.x+ || 2.x+
 ## Features
-- [webpack 5.x.x](https://webpack.js.org/)
+- [Webpack v5](https://webpack.js.org/)
 - ES6 with [babel](https://babeljs.io/)
 - Automatic code splitting using multiple entry points
 - Asset compression, source-maps, and minification
@@ -59,13 +58,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
@@ -116,9 +115,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 +128,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_pack_tag`:
 ```erb
-<%= javascript_packs_with_chunks_tag 'application' %>
-<%= stylesheet_packs_with_chunks_tag 'application' %>
+<%= javascript_pack_tag 'application' %>
+<%= stylesheet_pack_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 +183,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 +209,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 +248,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 +292,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 +328,7 @@ Add tsconfig.json
     "moduleResolution": "node",
     "baseUrl": ".",
     "paths": {
-      "*": ["node_modules/*", "app/javascript/*"]
+      "*": ["node_modules/*", "app/packs/*"]
     },
     "sourceMap": true,
     "target": "es5",
@@ -300,15 +339,33 @@ Add tsconfig.json
 }
 ```
-#### CSS
+Babel won’t perform any type-checking on TypeScript code. To optionally use type-checking run:
+```bash
+yarn add fork-ts-checker-webpack-plugin
+```
+Then modify the webpack config to use it as a plugin:
-To enable CSS support in your application, add following packages,
+```js
+// config/webpack/base.js
+const { webpackConfig, merge } = require("@rails/webpacker");
+const ForkTSCheckerWebpackPlugin = require("fork-ts-checker-webpack-plugin");
+module.exports = merge(webpackConfig, {
+  plugins: [new ForkTSCheckerWebpackPlugin()],
+});
 ```
+#### CSS
+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,25 +384,25 @@ then add the relevant pre-processors:
 #### Postcss
-```
+```bash
 yarn add postcss-loader
 ```
 #### Sass
-```
+```bash
 yarn add sass sass-loader
 ```
 #### Less
-```
+```bash
 yarn add less less-loader
 ```
-#### Less
+#### Stylus
-```
+```bash
 yarn add stylus stylus-loader
 ```
@@ -353,7 +410,7 @@ yarn add stylus stylus-loader
 React is supported and you just need to add relevant packages,
-```
+```bash
 yarn add react react-dom @babel/preset-react
 ```
@@ -378,16 +435,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')
@@ -403,7 +463,9 @@ module.exports = {
   },
   plugins: [new VueLoaderPlugin()]
 }
+```
+```js
 // config/webpack/base.js
 const { webpackConfig, merge } = require('@rails/webpacker')
 const vueConfig = require('./rules/vue')
@@ -451,11 +513,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
 ```
@@ -465,8 +527,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
@@ -474,6 +540,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
@@ -481,19 +549,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
 ```
@@ -507,7 +574,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
@@ -515,10 +584,10 @@ If you are adding Webpacker to an existing app that has most of the assets insid
 `app/assets` or inside an engine, and you want to share that
 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:
+add additional paths that webpack should look up 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:
@@ -539,6 +608,12 @@ 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.
+If you are using a CDN setup, webpacker will use the configured [asset host](https://guides.rubyonrails.org/configuring.html#rails-general-configuration) value to prefix URLs for images or font icons which are included inside JS code or CSS. It is possible to override this value during asset compilation by setting the `WEBPACKER_ASSET_HOST` environment variable.
+## 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)

data/config/README.md ADDED Viewed

@@ -0,0 +1,3 @@
+# Note
+This directory exists for Jest specs that execute code expecting the Rails config directory at this path.

data/config/webpacker.yml ADDED Viewed

	@@ -0,0 +1 @@
1	+ config/lib/install/config/webpacker.yml

data/docs/deployment.md ADDED Viewed

@@ -0,0 +1,128 @@
+# 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`. Remember to set `NODE_ENV` environment variable to production during deployment or when running the rake task.
+The `javascript_pack_tag` and `stylesheet_pack_tag` helper method will automatically insert the correct HTML tag for compiled pack. Just like the asset pipeline does it.
+By default the output will look like this in different environments:
+```html
+<!-- In development mode with webpack-dev-server -->
+<script src="http://localhost:8080/calendar-0bd141f6d9360cf4a7f5.js"></script>
+<link rel="stylesheet" media="screen" href="http://localhost:8080/calendar-dc02976b5f94b507e3b6.css">
+<!-- In production or development mode -->
+<script src="/packs/js/calendar-0bd141f6d9360cf4a7f5.js"></script>
+<link rel="stylesheet" media="screen" href="/packs/css/calendar-dc02976b5f94b507e3b6.css">
+```
+## Heroku
+In order for your Webpacker app to run on Heroku, you'll need to do a bit of configuration before hand.
+```bash
+heroku create my-webpacker-heroku-app
+heroku addons:create heroku-postgresql:hobby-dev
+heroku buildpacks:add heroku/nodejs
+heroku buildpacks:add heroku/ruby
+git push heroku master
+```
+We're essentially doing the following here:
+* Creating an app on Heroku
+* Creating a Postgres database for the app (this is assuming that you're using Heroku Postgres for your app)
+* Adding the Heroku NodeJS and Ruby buildpacks for your app. This allows the `npm` or `yarn` executables to properly function when compiling your app - as well as Ruby.
+* Pushing our code to Heroku and kicking off the deployment
+## Nginx
+Webpacker doesn't serve anything in production. You’re expected to configure your web server to serve files in public/ directly.
+Some servers support sending precompressed versions of files when they're available. For example, nginx offers a `gzip_static` directive that serves files with the `.gz` extension to supported clients. With an optional module, nginx can also serve Brotli compressed files with the `.br` extension (see below for installation and configuration instructions).
+Here's a sample nginx site config for a Rails app using Webpacker:
+```nginx
+upstream app {
+  # server unix:///path/to/app/tmp/puma.sock;
+}
+server {
+  listen 80;
+  server_name www.example.com;
+  root /path/to/app/public;
+  location @app {
+    proxy_pass http://app;
+    proxy_redirect off;
+    proxy_set_header Host $host;
+    proxy_set_header X-Real-IP $remote_addr;
+    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+    proxy_set_header X-Forwarded-Proto $scheme;
+  }
+  location / {
+    try_files $uri @app;
+  }
+  location = /favicon.ico { access_log off; log_not_found off; }
+  location = /robots.txt  { access_log off; log_not_found off; }
+  location ~ /\.(?!well-known).* {
+    deny all;
+  }
+  location ~ ^/(assets|packs)/ {
+    gzip_static on;
+    brotli_static on; # Optional, see below
+    expires max;
+    add_header Cache-Control public;
+  }
+}
+```
+### Installing the ngx_brotli module
+If you want to serve Brotli compressed files with nginx, you will need to install the `nginx_brotli` module. Installation instructions from source can be found in the official [google/ngx_brotli](https://github.com/google/ngx_brotli) git repository. Alternatively, depending on your platform, the module might be available via a pre-compiled package.
+Once installed, you need to load the module. As we want to serve the pre-compressed files, we only need the static module. Add the following line to your `nginx.conf` file and reload nginx:
+```
+load_module modules/ngx_http_brotli_static_module.so;
+```
+Now, you can set `brotli_static on;` in your nginx site config, as per the config in the last section above.
+## CDN
+Webpacker out-of-the-box provides CDN support using your Rails app `config.action_controller.asset_host` setting. If you already have [CDN](http://guides.rubyonrails.org/asset_pipeline.html#cdns) added in your Rails app
+you don't need to do anything extra for Webpacker, it just works.
+## Capistrano
+### Assets compiling on every deployment even if JavaScript and CSS files are not changed
+Make sure you have `public/packs` and `node_modules` in `:linked_dirs`
+```ruby
+append :linked_dirs, "log", "tmp/pids", "tmp/cache", "tmp/sockets", "public/packs", ".bundle", "node_modules"
+```
+If you have `node_modules` added to `:linked_dirs` you'll need to run yarn install before `deploy:assets:precompile`, so you can add this code snippet at the bottom deploy.rb
+```ruby
+before "deploy:assets:precompile", "deploy:yarn_install"
+namespace :deploy do
+  desc "Run rake yarn install"
+  task :yarn_install do
+    on roles(:web) do
+      within release_path do
+        execute("cd #{release_path} && yarn install --silent --no-progress --no-audit --no-optional")
+      end
+    end
+  end
+end
+```