shakapacker 6.5.4 → 6.5.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 57e24ac7fbe67a903f0a5f0d6725544b37b2c8a1bae324cd487642e69a525b8d
-  data.tar.gz: 704a88906fec3e37ec10b2b5cce8fd3ea8ad2c1a556e5badc89aef887d7c02cc
+  metadata.gz: 646fe9e24edc5f5db2658497319212b5185062398497652d0e30f0438bb26a58
+  data.tar.gz: e8664c72e8122fb658e33ba7018edbd5f6aad9ceb3ddda8fca0fa6f019f9ae6b
 SHA512:
-  metadata.gz: 918d57502a80582726426833b6a6a57848ab771c9d7acb1d2ab5748b3d5407a4ee44c6ece9849ee2db2879d3329761577678377aaccc1f67ce6a6fd72f3d5e38
-  data.tar.gz: ac9f9397b1922969a360d8c8963a3ba298eea656ae5eca1925ed419788fa40ae3d3f17d2cc8ddacb459c23cadfe2ba67cbf7827b8b9e499f52e59694cf59253f
+  metadata.gz: e41b38e5d64053e31e0077a31bca784b719601cee52da5237a0a310519d54121750b723cb7a35a4b826d2ecc781dabfa00652fd2fb6fe29e321373f0b0537cf4
+  data.tar.gz: eb96874304522ce04a1d1ba88162333336857606075f1cb00360f4016dfe09827eb421113b5d0c09b08f876d07b0815d4841bb8254895fe75297fe211bcbccc4

data/CHANGELOG.md

@@ -8,6 +8,13 @@ Changes since last non-beta release.
 
 _Please add entries here for your pull requests that are not yet released._
 
+## [v6.5.5] - December 23, 2022
+
+### Improved
+- Describe keys different from `webpack-dev-server` in generated `webpacker.yml`. [PR 194](https://github.com/shakacode/shakapacker/pull/194) by [alexeyr](https://github.com/alexeyr).
+- Allow webpack-cli v5 [PR 216](https://github.com/shakacode/shakapacker/pull/216) by [tagliala](https://github.com/tagliala).
+- Allow babel-loader v9 [PR 215](https://github.com/shakacode/shakapacker/pull/215) by [tagliala](https://github.com/tagliala).
+
 ## [v6.5.4] - November 4, 2022
 ### Fixed
 - Fixed regression caused by 6.5.3. PR #192 introduce extra split() call. [PR 202](https://github.com/shakacode/shakapacker/pull/202) by [Eric-Guo](https://github.com/Eric-Guo).
@@ -112,7 +119,7 @@ Note: [Rubygem is 6.3.0.pre.rc.1](https://rubygems.org/gems/shakapacker/versions
 - Make manifest_path configurable, to keep manifest.json private if desired. [PR 78](https://github.com/shakacode/shakapacker/pull/78) by [jdelStrother](https://github.com/jdelStrother).
 - Rewrite webpack module rules as regular expressions. Allows for easy iteration during config customization. [PR 60](https://github.com/shakacode/shakapacker/pull/60) by [blnoonan](https://github.com/blnoonan).
 - Initialization check to ensure shakapacker gem and NPM package version are consistent. Opt-in behaviour enabled by setting `ensure_consistent_versioning` configuration variable. [PR 51](https://github.com/shakacode/shakapacker/pull/51) by [tomdracz](https://github.com/tomdracz).
-- Add `dev_server.inline_css: bool` config option to allow for opting out of style-loader and into mini-extract-css-plugin for CSS HMR in development. [PR 69](https://github.com/shakacode/shakapacker/pull/69) by [cheald](https://github.com/cheald).
+- Add `dev_server.inline_css: bool` config option to allow for opting out of style-loader and into mini-css-extract-plugin for CSS HMR in development. [PR 69](https://github.com/shakacode/shakapacker/pull/69) by [cheald](https://github.com/cheald).
 
 ### Improved
 - Increase default connect timeout for dev server connections, establishing connections more reliably for busy machines. [PR 74](https://github.com/shakacode/shakapacker/pull/74) by [stevecrozz](https://github.com/stevecrozz).
@@ -186,7 +193,8 @@ Note: [Rubygem is 6.3.0.pre.rc.1](https://rubygems.org/gems/shakapacker/versions
 ## v5.4.3 and prior changes from rails/webpacker
 See [CHANGELOG.md in rails/webpacker (up to v5.4.3)](https://github.com/rails/webpacker/blob/master/CHANGELOG.md)
 
-[Unreleased]: https://github.com/shakacode/shakapacker/compare/v6.5.4...master
+[Unreleased]: https://github.com/shakacode/shakapacker/compare/v6.5.5...master
+[v6.5.5]: https://github.com/shakacode/shakapacker/compare/v6.5.4...v6.5.5
 [v6.5.4]: https://github.com/shakacode/shakapacker/compare/v6.5.3...v6.5.4
 [v6.5.3]: https://github.com/shakacode/shakapacker/compare/v6.5.2...v6.5.3
 [v6.5.2]: https://github.com/shakacode/shakapacker/compare/v6.5.1...v6.5.2

data/README.md

@@ -13,13 +13,13 @@ _Official, actively maintained successor to [rails/webpacker](https://github.com
 [![Gem](https://img.shields.io/gem/v/shakapacker.svg)](https://rubygems.org/gems/shakapacker)
 [![npm version](https://badge.fury.io/js/shakapacker.svg)](https://badge.fury.io/js/shakapacker)
 
-Webpacker makes it easy to use the JavaScript pre-processor and bundler [Webpack v5+](https://webpack.js.org/)
-to manage application-like JavaScript in Rails. It can coexist with the asset pipeline,
-leaving Webpack responsible solely for app-like JavaScript, or it can be used exclusively, making it also responsible for images, fonts, and CSS.
+Shakpacker makes it easy to use the JavaScript pre-processor and bundler [Webpack v5+](https://webpack.js.org/)
+to manage frontend JavaScript in Rails. It can coexist with the asset pipeline,
+leaving Webpack responsible solely for frontend JavaScript, or  can be used exclusively, making it also responsible for images, fonts, and CSS.
 
 Check out 6.1.1+ for [SWC](https://swc.rs/) and [esbuild-loader](https://github.com/privatenumber/esbuild-loader) support! They are faster than Babel!
 
-See a comparison of [webpacker with jsbundling-rails](https://github.com/rails/jsbundling-rails/blob/main/docs/comparison_with_webpacker.md).
+See a comparison of [Shakapacker with jsbundling-rails](https://github.com/rails/jsbundling-rails/blob/main/docs/comparison_with_webpacker.md).
 
 Discussion forum and Slack to discuss debugging and troubleshooting tips. Please open issues for bugs and feature requests:
 1. [Discussions tab](https://github.com/shakacode/shakapacker/discussions)

data/docs/style_loader_vs_mini_css.md

@@ -31,7 +31,7 @@ style-loader is how you are probably are used to serving CSS in development with
 * Adds an extra dependency
 * Divergence in delivery mechanism from production
 
-## Why would I pick mini-extract-css-plugin?
+## Why would I pick mini-css-extract-plugin?
 
 mini-css-extract-plugin's behavior is much more true to a production deployment's behavior, in that CSS is loaded via `link rel=stylsheet` tags, rather than injected by Javascript into `style` tags.
 

data/docs/v6_upgrade.md

@@ -50,19 +50,19 @@ _If you're on webpacker v5, follow below steps to get to v6.0.0.rc.6 first._
 ## How to upgrade to Webpacker v6.0.0.rc.6 from v5
 1. Ensure you have a clean working git branch. You will be overwriting all your files and reverting the changes that you don't want.
 
-1. **Ensure no nested directories in your `source_entry_path`. or set option `nested_entries: true`** Check if you had any entry point files in child directories of your `source_entry_path`.
+1. **Ensure no nested directories in your `source_entry_path`.** Check if you had any entry point files in child directories of your `source_entry_path`. Files for entry points in child directories are not supported by shakacode/shakapacker v6. Move those files to the top level, adjusting any imports in those files.
 
-   The new v6 configuration **defaults** to not allow nesting, so as to allow placing the entry points at in the root directory of JavaScript. You can find this change [here](https://github.com/rails/webpacker/commit/5de0fbc1e16d3db0c93202fb39f5b4d80582c682#diff-7af8667a3e36201db57c02b68dd8651883d7bfc00dc9653661be11cd31feeccdL19).
+   The v6 configuration does not allow nesting, so as to allow placing the entry points at in the root directory of JavaScript. You can find this change [here](https://github.com/rails/webpacker/commit/5de0fbc1e16d3db0c93202fb39f5b4d80582c682#diff-7af8667a3e36201db57c02b68dd8651883d7bfc00dc9653661be11cd31feeccdL19).
 
 1. Upgrade the Webpacker Ruby gem and the NPM package
 
-   Note: [Check the gem page to verify the latest version](https://rubygems.org/gems/shakapacker), and make sure to install identical version numbers of `shakapacker` gem and package, and remove the old `webpacker` gem from the Gemfile (Gems use a hyphen and packages use a dot between the main version number and the beta version.)
+   Note: [Check the gem page to verify the latest version](https://rubygems.org/gems/webpacker), and make sure to install identical version numbers of `webpacker` gem and package.
 
    Example going to a specific version:
 
    ```ruby
    # Gemfile
-   gem 'shakapacker', '6.0.0.rc.13'
+   gem 'webpacker', '6.0.0.rc.6'
    ```
 
    ```bash
@@ -70,7 +70,7 @@ _If you're on webpacker v5, follow below steps to get to v6.0.0.rc.6 first._
    ```
 
    ```bash
-   yarn add shakapacker@6.0.0-rc.13 --exact
+   yarn add @rails/webpacker@6.0.0-rc.6 --exact
    ```
 
    ```bash
@@ -99,10 +99,6 @@ _If you're on webpacker v5, follow below steps to get to v6.0.0.rc.6 first._
 
    Note, moving your files is optional, as you can stil keep your entries in a separate directory, called something like `packs`, or `entries`. This directory is defined with the `source_path`.
 
-1. **Ensure no nested directories in your `source_entry_path`.** Check if you had any entry point files in child directories of your `source_entry_path`. Files for entry points in child directories are not supported by shakacode/shakapacker v6. Move those files to the top level, adjusting any imports in those files.
-
-   The v6 configuration does not allow nesting, so as to allow placing the entry points at in the root directory of JavaScript. You can find this change [here](https://github.com/rails/webpacker/commit/5de0fbc1e16d3db0c93202fb39f5b4d80582c682#diff-7af8667a3e36201db57c02b68dd8651883d7bfc00dc9653661be11cd31feeccdL19).
-
 1. Update `webpack-dev-server` to the current version, greater than 4.2, updating `package.json`.
 
 1. 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` and **at most one call** to `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/javascript/application.js`, pass the option `defer: false` to your `javascript_pack_tag`.
@@ -142,7 +138,7 @@ _If you're on webpacker v5, follow below steps to get to v6.0.0.rc.6 first._
      ]
    }
    ```
-   See customization example the [Customizing Babel Config](./docs/customizing_babel_config.md) for React configuration.
+   See customization example the [Customizing Babel Config](./customizing_babel_config.md) for React configuration.
 
 1. `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/shakacode/shakapacker/blob/master/README.md#webpack-configuration)
 

data/lib/install/config/webpacker.yml

@@ -49,19 +49,21 @@ development:
   compiler_strategy: mtime
 
   # Reference: https://webpack.js.org/configuration/dev-server/
+  # Keys not described there are documented inline and in https://github.com/shakacode/shakapacker/
   dev_server:
     https: false
     host: localhost
     port: 3035
     # Hot Module Replacement updates modules while the application is running without a full reload
+    # Used instead of the `hot` key in https://webpack.js.org/configuration/dev-server/#devserverhot
     hmr: false
     # If HMR is on, CSS will by inlined by delivering it as part of the script payload via style-loader. Be sure
     # that you add style-loader to your project dependencies.
     #
-    # If you want to instead deliver CSS via <link> with the mini-extract-css-plugin, set inline_css to false.
+    # If you want to instead deliver CSS via <link> with the mini-css-extract-plugin, set inline_css to false.
     # In that case, style-loader is not needed as a dependency.
     #
-    # mini-extract-css-plugin is a required dependency in both cases.
+    # mini-css-extract-plugin is a required dependency in both cases.
     inline_css: true
     # Defaults to the inverse of hmr. Uncomment to manually set this.
     # live_reload: true
@@ -70,13 +72,14 @@ development:
       overlay: true
       # May also be a string
       # webSocketURL:
-      #  hostname: "0.0.0.0"
-      #  pathname: "/ws"
+      #  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
-    allowed_hosts: "all"
+    allowed_hosts: 'all'
+    # Shows progress and colorizes output of bin/webpacker[-dev-server]
     pretty: true
     headers:
       'Access-Control-Allow-Origin': '*'

data/lib/webpacker/version.rb

@@ -1,4 +1,4 @@
 module Webpacker
   # Change the version in package.json too, please!
-  VERSION = "6.5.4".freeze
+  VERSION = "6.5.5".freeze
 end

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "shakapacker",
-  "version": "6.5.4",
+  "version": "6.5.5",
   "description": "Use webpack to manage app-like JavaScript modules in Rails",
   "main": "package/index.js",
   "files": [
@@ -16,12 +16,12 @@
     "@babel/plugin-transform-runtime": "^7.17.0",
     "@babel/preset-env": "^7.16.11",
     "@babel/runtime": "^7.17.9",
-    "babel-loader": "^8.2.4",
+    "babel-loader": "^8.2.4 || ^9.0.0",
     "compression-webpack-plugin": "^9.0.0 || ^10.0.0",
     "terser-webpack-plugin": "^5.3.1",
     "webpack": "^5.72.0",
     "webpack-assets-manifest": "^5.0.6",
-    "webpack-cli": "^4.9.2",
+    "webpack-cli": "^4.9.2 || ^5.0.0",
     "webpack-dev-server": "^4.9.0",
     "webpack-merge": "^5.8.0"
   },

data/test/mounted_app/test/dummy/config/webpacker.yml

@@ -41,8 +41,14 @@ development:
     port: 3035
     public: localhost:3035
     hmr: false
-    # Inline should be set to true if using HMR
-    inline: true
+    # If HMR is on, CSS will by inlined by delivering it as part of the script payload via style-loader. Be sure
+    # that you add style-loader to your project dependencies.
+    #
+    # If you want to instead deliver CSS via <link> with the mini-extract-css-plugin, set inline_css to false.
+    # In that case, style-loader is not needed as a dependency.
+    #
+    # mini-extract-css-plugin is a required dependency in both cases.
+    inline_css: true
     overlay: true
     disable_host_check: true
     use_local_ip: false

data/test/test_app/config/webpacker_other_location.yml

@@ -43,8 +43,14 @@ development:
     port: 3035
     public: localhost:3035
     hmr: false
-    # Inline should be set to true if using HMR
-    inline: true
+    # If HMR is on, CSS will by inlined by delivering it as part of the script payload via style-loader. Be sure
+    # that you add style-loader to your project dependencies.
+    #
+    # If you want to instead deliver CSS via <link> with the mini-extract-css-plugin, set inline_css to false.
+    # In that case, style-loader is not needed as a dependency.
+    #
+    # mini-extract-css-plugin is a required dependency in both cases.
+    inline_css: true
     overlay: true
     disable_host_check: true
     use_local_ip: false

data/test/version_checker_test.rb

@@ -33,7 +33,7 @@ class VersionCheckerTest < Minitest::Test
   def test_message_printed_if_consistency_check_disabled_and_mismatch
     node_package_version = NodePackageVersionDouble.new(raw: "6.1.0", major_minor_patch: ["6", "1", "0"])
 
-    out, err = capture_io do
+    _out, err = capture_io do
       check_version(node_package_version, "6.0.0", false)
     end
 
@@ -45,7 +45,7 @@ class VersionCheckerTest < Minitest::Test
   def test_message_printed_if_consistency_check_disabled_and_semver
     node_package_version = NodePackageVersionDouble.new(raw: "^6.1.0", major_minor_patch: ["6", "1", "0"], semver_wildcard: true)
 
-    out, err = capture_io do
+    _out, err = capture_io do
       check_version(node_package_version, "6.1.0", false)
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shakapacker
 version: !ruby/object:Gem::Version
-  version: 6.5.4
+  version: 6.5.5
 platform: ruby
 authors:
 - David Heinemeier Hansson
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-04 00:00:00.000000000 Z
+date: 2022-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -337,7 +337,7 @@ homepage: https://github.com/shakacode/shakapacker
 licenses:
 - MIT
 metadata:
-  source_code_uri: https://github.com/shakacode/shakapacker/tree/v6.5.4
+  source_code_uri: https://github.com/shakacode/shakapacker/tree/v6.5.5
 post_install_message:
 rdoc_options: []
 require_paths: