webpacker 6.0.0.beta.7 → 6.0.0.rc.5

data/config/webpacker.yml

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

data/docs/developing_webpacker.md

@@ -0,0 +1,29 @@
+# Developing Webpacker
+
+It's a little trickier for Rails developers to work on the JS code of a project like rails/webpacker. So here are some tips!
+
+## Use some test app
+For example, for React on Rails Changes, I'm using [shakacode/react_on_rails_tutorial_with_ssr_and_hmr_fast_refresh](https://github.com/shakacode/react_on_rails_tutorial_with_ssr_and_hmr_fast_refresh).
+This directory is the `TEST_APP_DIR`.
+
+## Fork rails/webpacker
+Let's call the rails/webpacker directory `WEBPACKER_DIR` which has rails/webpacker's `package.json`.
+
+## Changing the Package
+### Setup with Yalc
+Use [`yalc`](https://github.com/wclr/yalc) unless you like yak shaving weird errors.
+1. In `WEBPACKER_DIR`, run `yalc publish`
+2. In `TEST_APP_DIR`, run `yalc link @rails/webpacker`
+
+## Update the Package Code
+1. Make some JS change in WEBPACKER_DIR
+2. Run `yalc push` and your changes will be pushed to your `TEST_APP_DIR`'s node_modules.
+3. You may need to run `yarn` in `TEST_APP_DIR` if you added or removed dependencies of rails/webpacker.
+
+## Updating the Ruby Code
+
+For the Ruby part, just change the gem reference `TEST_APP_DIR`, like:
+
+```ruby
+gem "webpacker", path: "../../forks/webpacker"
+```

data/docs/troubleshooting.md

@@ -4,14 +4,17 @@
 
 1. Read the error message carefully. The error message will tell you the precise key value
    that is not matching what Webpack expects.
+
 2. Put a `debugger` statement in your Webpack configuration and run `bin/webpack --debug-webpacker`.
    If you have a node debugger installed, you'll see the Chrome debugger for your webpack
-   config. For example, install the Chrome extension 
+   config. For example, install the Chrome extension
    [NiM](https://chrome.google.com/webstore/detail/nodejs-v8-inspector-manag/gnhhdgbaldcilmgcpfddgdbkhjohddkj) and
    set the option for the dev tools to open automatically. Or put `chrome://inspect` in the URL bar.
    For more details on debugging, see the official
    [Webpack docs on debugging](https://webpack.js.org/contribute/debugging/#devtools)
+
 3. Any arguments that you add to bin/webpack get sent to webpack. For example, you can pass `--debug` to switch loaders to debug mode. See [webpack CLI debug options](https://webpack.js.org/api/cli/#debug-options) for more information on the available options.
+
 4. You can also pass additional options to the command to run the webpack-dev-server and start the webpack-dev-server with the option `--debug-webpacker`
 
 ## ENOENT: no such file or directory - node-sass
@@ -56,16 +59,15 @@ completed the compilation successfully before loading a view.
 * If you get this error while trying to use Elm, try rebuilding Elm. You can do
   so with a postinstall hook in your `package.json`:
 
-```
+```json
 "scripts": {
   "postinstall": "npm rebuild elm"
 }
 ```
 
-
 ## webpack or webpack-dev-server not found
 
-* This could happen if  `webpacker:install` step is skipped. Please run `bundle exec rails webpacker:install` to fix the issue.
+* This could happen if `webpacker:install` step is skipped. Please run `bundle exec rails webpacker:install` to fix the issue.
 
 * If you encounter the above error on heroku after upgrading from Rails 4.x to 5.1.x, then the problem might be related to missing `yarn` binstub. Please run following commands to update/add binstubs:
 
@@ -74,7 +76,6 @@ bundle config --delete bin
 ./bin/rails app:update:bin # or rails app:update:bin
 ```
 
-
 ## Running webpack on Windows
 
 If you are running webpack on Windows, your command shell may not be able to interpret the preferred interpreter
@@ -86,7 +87,6 @@ C:\path>ruby bin\webpack
 C:\path>ruby bin\webpack-dev-server
 ```
 
-
 ## Invalid configuration object. webpack has been initialised using a configuration object that does not match the API schema.
 
 If you receive this error when running `$ ./bin/webpack-dev-server` ensure your configuration is correct; most likely the path to your "packs" folder is incorrect if you modified from the original "source_path" defined in `config/webpacker.yml`.
@@ -101,6 +101,7 @@ Basic fix involves:
 
 ```bash
 # install sysconfcpus on CI
+
 git clone https://github.com/obmarg/libsysconfcpus.git $HOME/dependencies/libsysconfcpus
 cd libsysconfcpus
 .configure --prefix=$HOME/dependencies/sysconfcpus
@@ -113,41 +114,39 @@ chmod +x $HOME/your_rails_app/node_modules/.bin/elm-make
 ```
 
 ## Rake assets:precompile fails. ExecJS::RuntimeError
-This error occurs because you are trying to minify by terser a pack that's already been minified by Webpacker. To avoid this conflict and prevent appearing of ExecJS::RuntimeError error, you will need to disable uglifier from Rails config:
+This error occurs because you are trying to minify by `terser` a pack that's already been minified by Webpacker. To avoid this conflict and prevent appearing of `ExecJS::RuntimeError` error, you will need to disable uglifier from Rails config:
 
 ```ruby
-// production.rb
-# From
+# In production.rb
 
+# From
 Rails.application.config.assets.js_compressor = :uglifier
 
 # To
-
 Rails.application.config.assets.js_compressor = Uglifier.new(harmony: true)
-
 ```
 
 ### Angular: WARNING in ./node_modules/@angular/core/esm5/core.js, Critical dependency: the request of a dependency is an expression
 
-To silent these warnings, please update `config/webpack/environment.js`
-
+To silent these warnings, please update `config/webpack/base.js`:
 ```js
-// environment.js
 const webpack = require('webpack')
 const { resolve } = require('path')
-const { environment, config } = require('@rails/webpacker')
-
-environment.plugins.append('ContextReplacement',
-  new webpack.ContextReplacementPlugin(
-    /angular(\\|\/)core(\\|\/)(@angular|esm5)/,
-    resolve(config.source_path)
-  )
-)
+const { webpackConfig, merge } = require('@rails/webpacker')
+
+module.exports = merge(webpackConfig, {
+  plugins: [
+    new webpack.ContextReplacementPlugin(
+      /angular(\\|\/)core(\\|\/)(@angular|esm5)/,
+      resolve(config.source_path)
+    )
+  ]
+})
 ```
 
 ### Compilation Fails Silently
 
-If compiling is not producing output files and there are no error messages to help troubleshoot. Setting the webpack_compile_output configuration variable to 'true' in webpacker.yml may add some helpful error information to your log file (Rails log/development.log or log/production.log)
+If compiling is not producing output files and there are no error messages to help troubleshoot. Setting the `webpack_compile_output` configuration variable to `true` in webpacker.yml may add some helpful error information to your log file (Rails `log/development.log` or `log/production.log`)
 
 ```yml
 # webpacker.yml
@@ -158,3 +157,34 @@ default: &default
   public_output_path: complaints_packs
   webpack_compile_output: true
 ```
+
+### Using global variables for dependencies
+
+If you want to access any dependency without importing it everywhere or use it directly in your dev tools, please check: [https://webpack.js.org/plugins/provide-plugin/](https://webpack.js.org/plugins/provide-plugin/)
+
+**You don't need to assign dependencies on `window`.**
+
+For instance, with [jQuery](https://jquery.com/):
+```diff
+// app/packs/entrypoints/application.js
+
+- import jQuery from 'jquery'
+- window.jQuery = jQuery
+```
+
+Instead do:
+```js
+// config/webpack/base.js
+
+const webpack = require('webpack')
+const { webpackConfig, merge } = require('@rails/webpacker')
+
+module.exports = merge(webpackConfig, {
+  plugins: [
+    new webpack.ProvidePlugin({
+      $: 'jquery',
+      jQuery: 'jquery',
+    })
+  ],
+})
+```

data/docs/v6_upgrade.md

@@ -1,45 +1,32 @@
-# To Webpacker v6 from v5
+# Upgrading from Webpacker 5 to 6
 
-This guide aims to help you migrating to Webpacker 6. If you are using vanilla Webpacker install then hopefully, the upgrade should be really straightforward.
+There are several substantial changes in Webpacker 6 that you need to manually account for when coming from Webpacker 5. This guide will help you through it.
 
-## Main differences with v5
+## Webpacker has become a slimmer wrapper around Webpack
 
-The main goal for Webpacker v6 is to manage the JavaScript in your Rails application with Webpack. This will allows you, for example, to use JavaScript modules, automatic code splitting using multiple entry points, use PostCSS or use [Vue](https://vuejs.org/) or [React](https://reactjs.org/).
+By default, Webpacker 6 is focused on compiling and bundling JavaScript. This pairs with the existing asset pipeline in Rails that's setup to transpile CSS and static images using [Sprockets](https://github.com/rails/sprockets). For most developers, that's the recommended combination. But if you'd like to use Webpacker for CSS and static assets as well, please see [integrations](https://github.com/rails/webpacker#integrations) for more information.
 
-You probably don't want to install Webpacker and Webpack if you only need some JavaScript Sprinkles, Sass integration, images and fonts support.
+Webpacker used to configure Webpack indirectly, which lead to a [complicated secondary configuration process](https://github.com/rails/webpacker/blob/5-x-stable/docs/webpack.md). This was done in order to provide default configurations for the most popular frameworks, but ended up creating more complexity than it cured. So now Webpacker delegates all configuration directly to Webpack's default configuration setup.
 
-### Default integrations
+This means you have to configure integration with frameworks yourself, but webpack-merge helps with this. See this example for [Vue](https://github.com/rails/webpacker#other-frameworks).
 
-By default, Webpacker v6 out of the box supports JS and static assets (fonts, images etc.) compilation. Webpacker now detects automatically relevant packages to support more tools.
-
-See [Integrations](https://github.com/rails/webpacker#integrations) for more information.
-
-Why? Because most developers don't need to handle CSS, SASS or another tools with Webpack. [Sprockets](https://github.com/rails/sprockets) is probably enough and we don't want to make things harder.
-
-### Simpler API
-
-Webpacker is still a wrapper around [Webpack](https://webpack.js.org/) to simplify the integration in your Rails application.
-
-But we noticed that the [Webpacker v5 configuration](https://github.com/rails/webpacker/blob/5-x-stable/docs/webpack.md) was a bit confusing mostly because Webpack is a complicated beast to manage.
-
-There are so many different toolchains in JavaScript these days, it would be impossible to create te perfect configuration for everybody. That is also why defaults installers have been removed.
-
-In order to simplify even more the configuration, the custom API to manage the Webpack configuration has been removed.
-
-Now you have a straight access to the Webpack configuration and you can change it very easily with webpack-merge. So now, you can refer to the documentation of the tools you want to install it with Webpack. Here is an example with [Vue](https://github.com/rails/webpacker#other-frameworks).
-
-## How to upgrade to Webpacker v6
+## How to upgrade to Webpacker 6
 
 1. If your `source_path` is `app/javascript`, rename it to `app/packs`
 2. If your `source_entry_path` is `packs`, rename it to `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
+6. Remove .browserslistrc from the root of your Rails app
+7. Upgrade the Webpacker Ruby gem and NPM package
+
+Note: [Check the releases page to verify the latest version](https://github.com/rails/webpacker/releases), and make sure to install identical version numbers of webpacker gem and `@rails/webpacker` npm package. (Gems use a period and packages use a dot between the main version number and the beta version.)
+
+Example going to a specific version:
 
   ```ruby
   # Gemfile
-  gem 'webpacker', '~> 6.0.0.pre.2'
+  gem 'webpacker', '6.0.0.rc.5'
   ```
 
   ```bash
@@ -47,22 +34,16 @@ Now you have a straight access to the Webpack configuration and you can change i
   ```
 
   ```bash
-  yarn add @rails/webpacker@next
+  yarn add @rails/webpacker@6.0.0-rc.5 --exact
   ```
 
   ```bash
   bundle exec rails webpacker:install
   ```
 
-- Change `javascript_packs_with_chunks_tag` and `stylesheet_packs_with_chunks_tag` to `javascript_pack_tag` and
-  `stylesheet_pack_tag`.
-
-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.
-
-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`.
+7. Update API usage of the view helpers by changing `javascript_packs_with_chunks_tag` and `stylesheet_packs_with_chunks_tag` to `javascript_pack_tag` and `stylesheet_pack_tag`. Ensure that your layouts and views will only have **at most one call** to `javascript_pack_tag` or `stylesheet_pack_tag`. You can now pass multiple bundles to these view helper methods. If you fail to changes this, you may experience performance issues, and other bugs related to multiple copies of React, like [issue 2932](https://github.com/rails/webpacker/issues/2932).  If you expose jquery globally with `expose-loader,` by using `import $ from "expose-loader?exposes=$,jQuery!jquery"` in your `app/packs/entrypoints/application.js`, pass the option `defer: false` to your `javascript_pack_tag`.
+8. 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.
+9. Copy over any custom webpack config from `config/webpack_old`. Common code previously called 'environment' should be changed to 'base', and import `environment` changed to `webpackConfig`.
 
   ```js
   // config/webpack/base.js
@@ -72,15 +53,23 @@ Now you have a straight access to the Webpack configuration and you can change i
   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. Copy over custom browserlist config from `.browserslistrc` if it exists into the `"browserslist"` key in `package.json` and remove `.browserslistrc`.
+
+11. Remove `babel.config.js` if you never changed it. Be sure to have this config in your `package.json`:
+```json
+"babel": {
+  "presets": [
+    "./node_modules/@rails/webpacker/package/babel/preset.js"
+  ]
+}
+```
+12. Remove `postcss.config.js` if you don't use `PostCSS`.
+13. `extensions` was removed from the `webpacker.yml` file. Move custom extensions to your configuration 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)
 
-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']
+    extensions: ['.ts', '.tsx', '.vue', '.css']
   }
 }
 ```

data/gemfiles/Gemfile-rails-edge

@@ -4,7 +4,7 @@ git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 
 gemspec path: "../"
 
-gem "rails", github: "rails/rails"
+gem "rails", github: "rails/rails", branch: "main"
 gem "arel", github: "rails/arel"
 gem "rake", ">= 11.1"
 gem "rack-proxy", require: false

data/gemfiles/Gemfile-rails.6.1.x

@@ -0,0 +1,12 @@
+source "https://rubygems.org"
+
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+gemspec path: "../"
+
+gem "rails", '~>6.1.0'
+gem "arel", github: "rails/arel"
+gem "rake", ">= 11.1"
+gem "rack-proxy", require: false
+gem "minitest", "~> 5.0"
+gem "byebug"

data/lib/install/bin/yarn

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+APP_ROOT = File.expand_path("..", __dir__)
+Dir.chdir(APP_ROOT) do
+  yarn = ENV["PATH"].split(File::PATH_SEPARATOR).
+    select { |dir| File.expand_path(dir) != __dir__ }.
+    product(["yarn", "yarnpkg", "yarn.cmd", "yarn.ps1"]).
+    map { |dir, file| File.expand_path(file, dir) }.
+    find { |file| File.executable?(file) }
+
+  if yarn
+    exec yarn, *ARGV
+  else
+    $stderr.puts "Yarn executable was not detected in the system."
+    $stderr.puts "Download Yarn at https://yarnpkg.com/en/docs/install"
+    exit 1
+  end
+end

data/lib/install/config/webpacker.yml

@@ -5,7 +5,7 @@ default: &default
   source_entry_path: entrypoints
   public_root_path: public
   public_output_path: packs
-  cache_path: tmp/cache/webpacker
+  cache_path: tmp/webpacker
   webpack_compile_output: true
 
   # Additional paths webpack should look up modules
@@ -24,29 +24,26 @@ development:
     https: false
     host: localhost
     port: 3035
-    public: localhost:3035
-    # Inject browserside javascript that required by both HMR and Live(full) reload
-    inject_client: true
     # Hot Module Replacement updates modules while the application is running without a full reload
     hmr: false
-    # Inline should be set to true if using HMR; it inserts a script to take care of live reloading
-    inline: true
-    # Should we show a full-screen overlay in the browser when there are compiler errors or warnings?
-    overlay: true
+    client:
+      # Should we show a full-screen overlay in the browser when there are compiler errors or warnings?
+      overlay: true
+      # May also be a string
+      # webSocketURL:
+      #  hostname: "0.0.0.0"
+      #  pathname: "/ws"
+      #  port: 8080
     # Should we use gzip compression?
     compress: true
     # Note that apps that do not check the host are vulnerable to DNS rebinding attacks
-    disable_host_check: true
-    # This option lets the browser open with your local IP
-    use_local_ip: false
-    # When enabled, nothing except the initial startup information will be written to the console.
-    # This also means that errors or warnings from webpack are not visible.
-    quiet: false
-    pretty: false
+    allowed_hosts: "all"
+    pretty: true
     headers:
       'Access-Control-Allow-Origin': '*'
-    watch_options:
-      ignored: '**/node_modules/**'
+    static:
+      watch:
+        ignored: '**/node_modules/**'
 
 test:
   <<: *default

data/lib/install/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "app",
+  "private": true,
+  "dependencies": {
+    "@rails/activestorage": "latest",
+    "@rails/actioncable": "latest"
+  },
+  "version": "0.1.0",
+  "babel": {
+    "presets": [
+      "./node_modules/@rails/webpacker/package/babel/preset.js"
+    ]
+  },
+  "browserslist": [
+    "defaults"
+  ]
+}

data/lib/install/packs/entrypoints/application.js

@@ -14,7 +14,6 @@
 // const images = require.context('../images', true)
 // const imagePath = (name) => images(name, true)
 
-import 'core-js/stable'
-import 'regenerator-runtime/runtime'
-
-console.log('Hello World from Webpacker')
+// Activate Active Storage
+// import * as ActiveStorage from "@rails/activestorage"
+// ActiveStorage.start()

data/lib/install/template.rb

@@ -1,5 +1,6 @@
 # Install Webpacker
 copy_file "#{__dir__}/config/webpacker.yml", "config/webpacker.yml"
+copy_file "#{__dir__}/package.json", "package.json"
 
 say "Copying webpack core config"
 directory "#{__dir__}/config/webpack", "config/webpack"
@@ -26,6 +27,32 @@ if File.exists?(git_ignore_path)
   end
 end
 
+if (app_layout_path = Rails.root.join("app/views/layouts/application.html.erb")).exist?
+  say "Add JavaScript include tag in application layout"
+  insert_into_file app_layout_path.to_s, %(\n    <%= javascript_pack_tag "application" %>), before: /\s*<\/head>/
+else
+  say "Default application.html.erb is missing!", :red
+  say %(        Add <%= javascript_pack_tag "application" %> within the <head> tag in your custom layout.)
+end
+
+if (setup_path = Rails.root.join("bin/setup")).exist?
+  say "Run bin/yarn during bin/setup"
+  insert_into_file setup_path.to_s, <<-RUBY, after: %(  system("bundle check") || system!("bundle install")\n)
+
+  # Install JavaScript dependencies
+  system! "bin/yarn"
+RUBY
+end
+
+if (asset_config_path = Rails.root.join("config/initializers/assets.rb")).exist?
+  say "Add node_modules to the asset load path"
+  append_to_file asset_config_path, <<-RUBY
+
+# Add node_modules folder to the asset load path.
+Rails.application.config.assets.paths << Rails.root.join("node_modules")
+RUBY
+end
+
 results = []
 
 Dir.chdir(Rails.root) do
@@ -49,18 +76,6 @@ Dir.chdir(Rails.root) do
   results << run("yarn add --dev webpack-dev-server @webpack-cli/serve")
 end
 
-insert_into_file Rails.root.join("package.json").to_s, before: /\n}\n*$/ do
-  <<~JSON.chomp
-  ,
-    "babel": {
-      "presets": ["./node_modules/@rails/webpacker/package/babel/preset.js"]
-    },
-    "browserslist": [
-      "defaults"
-    ]
-  JSON
-end
-
 if Rails::VERSION::MAJOR == 5 && Rails::VERSION::MINOR > 1
   say "You need to allow webpack-dev-server host as allowed origin for connect-src.", :yellow
   say "This can be done in Rails 5.2+ for development environment in the CSP initializer", :yellow
@@ -68,9 +83,7 @@ if Rails::VERSION::MAJOR == 5 && Rails::VERSION::MINOR > 1
   say "policy.connect_src :self, :https, \"http://localhost:3035\", \"ws://localhost:3035\" if Rails.env.development?", :yellow
 end
 
-if results.all?
-  say "Webpacker successfully installed 🎉 🍰", :green
-else
+unless results.all?
   say "Webpacker installation failed 😭 See above for details.", :red
   exit 1
 end