shakapacker 6.5.1 → 6.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9174a8c729f67ee442afd4db423a2c2f5e412ba448283c9d691dea1b565cf7e
-  data.tar.gz: 940e267827d81bf4febd2ab41748efb2d8862ac653e7d234ce5016448cca4026
+  metadata.gz: 7d1161db88c6d6b16130fe5b25915e4c3b6d556209006c52a67933c1b95e500d
+  data.tar.gz: 7f3dc703cb44cdf59ceabf0a97e7bfcbdf99ecf42faa6eda2b60ed91b5b06f12
 SHA512:
-  metadata.gz: 4553b937730995bf743ba9a3d11941096d0eda4e7cd37d69c9dc0fcb97b9f3d6f7e550e58e5d2106882686ff01c3a2ff0740e6758fd8759fed1221513eff66f2
-  data.tar.gz: 287b01999fcc9e13230a4ea90d2fd36cf9f71775435912283599f6db3630390a3f10e7c0810f92cb21ddb363cb80f3aa7f3f8e719a61afa7fc1c3fef6749e890
+  metadata.gz: f04fdd02eb9e9c10d284a35f9d47acfab440ac21f0d21650cb9c2de520d748e13c46bbb4ec70ff66b86e0821c6828afbc5ba87b0726c3d241b9c7b52635802d6
+  data.tar.gz: 275dade1375413e6a47d88a155b0aa1a6a416713063aff2f8a1528a04a9b2c515350a65131bed4a338c622359ff66970da5535af549c81270de7bd753abf3c65

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -11,7 +11,7 @@ A bug is a crash or incorrect behavior. If you have a debugging or troubleshooti
 
 Ruby version:
 Rails version:
-Webpacker version:
+Shakapacker version:
 
 Expected behavior:
 

data/.github/ISSUE_TEMPLATE/feature-request.md

@@ -11,7 +11,7 @@ A feature request describes a suggested improvement. If you have a debugging or
 
 Ruby version:
 Rails version:
-Webpacker version:
+Shakapacker version:
 
 Desired behavior:
 

data/CHANGELOG.md

@@ -1,6 +1,6 @@
 * For the changelog of versions prior to v6, see the [5.x stable branch of rails/webpacker](https://github.com/rails/webpacker/tree/5-x-stable).
 * Please see the [v6 Upgrade Guide](./docs/v6_upgrade.md) to go from versions prior to v6.
-* [ShakaCode](https://www.shakacode.com) offers support for upgrading from webpacker or using Shakapacker. If interested, contact Justin Gordon, [justin@shakacode.com](mailto:justin@shakacode.com).
+* [ShakaCode](https://www.shakacode.com) offers support for upgrading from Webpacker or using Shakapacker. If interested, contact Justin Gordon, [justin@shakacode.com](mailto:justin@shakacode.com).
 
 ## Versions
 ## [Unreleased]
@@ -8,7 +8,26 @@ Changes since last non-beta release.
 
 _Please add entries here for your pull requests that are not yet released._
 
-## [v6.5.1] - August 12, 2022
+## [v6.5.3] - November 1, 2022
+
+### Improved
+- Set RAILS_ENV and BUNDLE_GEMFILE env values before requiring `bundler/setup`, `webpacker`, and `webpacker/webpack_runner`. [PR 190](https://github.com/shakacode/shakapacker/pull/190) by [betmenslido](https://github.com/betmenslido).
+- The `mini-css-extract-plugin` may cause various warnings indicating CSS order conflicts when using a [File-System-based automated bundle generation feature](https://www.shakacode.com/react-on-rails/docs/guides/file-system-based-automated-bundle-generation/).
+CSS order warnings can be disabled in projects where CSS ordering has been mitigated by consistent use of scoping or naming conventions. Added `css_extract_ignore_order_warnings` flag to webpacker configuration to disable the order warnings by [pulkitkkr](https://github.com/shakacode/shakapacker/pull/185) in [PR 192](https://github.com/shakacode/shakapacker/pull/192).
+
+## [v6.5.2] - September 8, 2022
+
+### Upgrade
+Remove the setting of the NODE_ENV in your `bin/webpacker` and `bin/webpacker-dev-server` files per [PR 185](https://github.com/shakacode/shakapacker/pull/185).
+
+### Fixed
+- Changed NODE_ENV defaults to the following and moved from binstubs to the runner. [PR 185](https://github.com/shakacode/shakapacker/pull/185) by [mage1711](https://github.com/mage1711).
+
+```
+ENV["NODE_ENV"] ||= (ENV["RAILS_ENV"] == "production") ? "production" : "development"
+```
+
+## [v6.5.1] - August 15, 2022
 
 ### Improved
 - Resolve exact npm package version from lockfiles for constraint checking. [PR 170](https://github.com/shakacode/shakapacker/pull/170) by [G-Rath](https://github.com/G-Rath).
@@ -163,7 +182,9 @@ 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.1...master
+[Unreleased]: https://github.com/shakacode/shakapacker/compare/v6.5.3...master
+[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
 [v6.5.1]: https://github.com/shakacode/shakapacker/compare/v6.5.0...v6.5.1
 [v6.5.0]: https://github.com/shakacode/shakapacker/compare/v6.4.1...v6.5.0
 [v6.4.1]: https://github.com/shakacode/shakapacker/compare/v6.4.0...v6.4.1

data/README.md

@@ -351,6 +351,8 @@ Note, if you are using server-side rendering of JavaScript with dynamic code-spl
 
 Webpacker ships with two binstubs: `./bin/webpacker` and `./bin/webpacker-dev-server`. Both are thin wrappers around the standard `webpack.js` and `webpack-dev-server.js` executables to ensure that the right configuration files and environmental variables are loaded based on your environment.
 
+_Note: older Shakapacker installations had set a missing NODE_ENV in the binstubs. Please remove this for versions 6.5.2 and newer._
+
 #### Automatic Webpack Code Building
 
 Shakapacker can be configured to automatically compile on demand when needed using the `webpacker.yml` `compile` option. This happens when you refer to any of the pack assets using the Shakapacker helper methods. This means that you don't have to run any separate processes. Compilation errors are logged 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/webpacker --watch` or run `./bin/webpacker-dev-server` during development.
@@ -434,7 +436,7 @@ const options = {
 
 // Copy the object using merge b/c the baseClientWebpackConfig is a mutable global
 // If you want to use this object for client and server rendering configurations,
-// havaing a new object is essential.
+// having a new object is essential.
 module.exports = merge({}, baseWebpackConfig, options)
 ```
 
@@ -815,14 +817,34 @@ We encourage you to contribute to Shakapacker/Webpacker! See [CONTRIBUTING](CONT
 
 Webpacker is released under the [MIT License](https://opensource.org/licenses/MIT).
   
-# Supporters
-
-The following companies support this open source project, and ShakaCode uses their products! Justin writes React on Rails on [RubyMine](https://www.jetbrains.com/ruby/). We use [Scout](https://scoutapp.com/) to monitor the live performance of [HiChee.com](https://HiChee.com), [Rails AutoScale](https://railsautoscale.com) to scale the dynos of HiChee, and [HoneyBadger](https://www.honeybadger.io/) to monitor application errors. We love [BrowserStack](https://www.browserstack.com) to solve problems with oddball browsers.
-
-[![RubyMine](https://user-images.githubusercontent.com/1118459/114100597-3b0e3000-9860-11eb-9b12-73beb1a184b2.png)](https://www.jetbrains.com/ruby/)
-[![Scout](https://user-images.githubusercontent.com/1118459/171088197-81555b69-9ed0-4235-9acf-fcb37ecfb949.png)](https://scoutapp.com/)
-[![Rails AutoScale](https://user-images.githubusercontent.com/1118459/103197530-48dc0e80-488a-11eb-8b1b-a16664b30274.png)](https://railsautoscale.com/)
-[![BrowserStack](https://cloud.githubusercontent.com/assets/1118459/23203304/1261e468-f886-11e6-819e-93b1a3f17da4.png)](https://www.browserstack.com)
-[![HoneyBadger](https://user-images.githubusercontent.com/1118459/114100696-63962a00-9860-11eb-8ac1-75ca02856d8e.png)](https://www.honeybadger.io/)
-
-ShakaCode's favorite project tracking tool is [Shortcut](https://shortcut.com/). If you want to **try Shortcut and get 2 months free beyond the 14-day trial period**, click [here to use ShakaCode's referral code](http://r.clbh.se/mvfoNeH). We're participating in their awesome triple-sided referral program, which you can read about [here](https://shortcut.com/referral/). By using our [referral code](http://r.clbh.se/mvfoNeH) you'll be supporting ShakaCode and, thus, React on Rails!
+## Supporters
+
+<a href="https://www.jetbrains.com">
+  <img src="https://user-images.githubusercontent.com/4244251/184881139-42e4076b-024b-4b30-8c60-c3cd0e758c0a.png" alt="JetBrains" height="120px">
+</a>
+<a href="https://scoutapp.com">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/4244251/184881147-0d077438-3978-40da-ace9-4f650d2efe2e.png">
+    <source media="(prefers-color-scheme: light)" srcset="https://user-images.githubusercontent.com/4244251/184881152-9f2d8fba-88ac-4ba6-873b-22387f8711c5.png">
+    <img alt="ScoutAPM" src="https://user-images.githubusercontent.com/4244251/184881152-9f2d8fba-88ac-4ba6-873b-22387f8711c5.png" height="120px">
+  </picture>
+</a>
+<br />
+<a href="https://www.browserstack.com">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/4244251/184881122-407dcc29-df78-4b20-a9ad-f597b56f6cdb.png">
+    <source media="(prefers-color-scheme: light)" srcset="https://user-images.githubusercontent.com/4244251/184881129-e1edf4b7-3ae1-4ea8-9e6d-3595cf01609e.png">
+    <img alt="BrowserStack" src="https://user-images.githubusercontent.com/4244251/184881129-e1edf4b7-3ae1-4ea8-9e6d-3595cf01609e.png" height="55px">
+  </picture>
+</a>
+<a href="https://railsautoscale.com">
+  <img src="https://user-images.githubusercontent.com/4244251/184881144-95c2c25c-9879-4069-864d-4e67d6ed39d2.png" alt="Rails Autoscale" height="55px">
+</a>
+<a href="https://www.honeybadger.io">
+  <img src="https://user-images.githubusercontent.com/4244251/184881133-79ee9c3c-8165-4852-958e-31687b9536f4.png" alt="Honeybadger" height="55px">
+</a>
+
+<br />
+<br />
+
+The following companies support our open source projects, and ShakaCode uses their products!

data/docs/v6_upgrade.md

@@ -15,6 +15,9 @@ While you have to configure integration with frameworks yourself, [`webpack-merg
 ## webpacker v6.0.0.rc.6 to shakapacker v6.0.0
 See an example migration here: [PR 27](https://github.com/shakacode/react_on_rails_tutorial_with_ssr_and_hmr_fast_refresh/pull/27).
 
+### Update to v6.5.2
+1. Remove setting the NODE_ENV in your `bin/webpacker` and `bin/webpacker-dev-server` bin stubs as these are not set in the webpack runner file.
+
 ### Update Steps to v6.0.0 from v6.0.0.rc.6
 _If you're on webpacker v5, follow below steps to get to v6.0.0.rc.6 first._
 
@@ -53,7 +56,7 @@ _If you're on webpacker v5, follow below steps to get to v6.0.0.rc.6 first._
 
 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. (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/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.)
 
    Example going to a specific version:
 
@@ -92,7 +95,7 @@ _If you're on webpacker v5, follow below steps to get to v6.0.0.rc.6 first._
    source_path: app/javascript
    source_entry_path: /
    ```
-   If you prefer this configuratiom, then you will move your `app/javascript/packs/*` (including `application.js`) to `app/javascript/` and update the configuration file.
+   If you prefer this configuration, then you will move your `app/javascript/packs/*` (including `application.js`) to `app/javascript/` and update the configuration file.
 
    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`.
 

data/lib/install/bin/webpacker

@@ -1,14 +1,12 @@
 #!/usr/bin/env ruby
 
-require "pathname"
+ENV["RAILS_ENV"] ||= "development"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile", __FILE__)
+
 require "bundler/setup"
 require "webpacker"
 require "webpacker/webpack_runner"
 
-ENV["RAILS_ENV"] ||= "development"
-ENV["NODE_ENV"]  ||= ENV["RAILS_ENV"]
-ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile", Pathname.new(__FILE__).realpath)
-
 APP_ROOT = File.expand_path("..", __dir__)
 Dir.chdir(APP_ROOT) do
   Webpacker::WebpackRunner.run(ARGV)

data/lib/install/bin/webpacker-dev-server

@@ -1,14 +1,9 @@
 #!/usr/bin/env ruby
 
 ENV["RAILS_ENV"] ||= "development"
-ENV["NODE_ENV"]  ||= ENV["RAILS_ENV"]
-
-require "pathname"
-ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
-  Pathname.new(__FILE__).realpath)
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile", __FILE__)
 
 require "bundler/setup"
-
 require "webpacker"
 require "webpacker/dev_server_runner"
 

data/lib/install/config/webpacker.yml

@@ -11,6 +11,12 @@ default: &default
   # You cannot set this option to true if you set source_entry_path to '/'
   nested_entries: false
 
+  #  While using a File-System-based automated bundle generation feature, miscellaneous warnings suggesting css order
+  #  conflicts may arise due to the mini-css-extract-plugin. For projects where css ordering has been mitigated through
+  #  consistent use of scoping or naming conventions, the css order warnings can be disabled by setting
+  #  css_extract_ignore_order_warnings to true
+  css_extract_ignore_order_warnings: false
+
   public_root_path: public
   public_output_path: packs
   cache_path: tmp/webpacker

data/lib/webpacker/runner.rb

@@ -2,7 +2,7 @@ module Webpacker
   class Runner
     def self.run(argv)
       $stdout.sync = true
-
+      ENV["NODE_ENV"] ||= (ENV["RAILS_ENV"] == "production") ? "production" : "development"
       new(argv).run
     end
 

data/lib/webpacker/version.rb

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

data/package/environments/__tests__/base.js

@@ -24,6 +24,17 @@ describe('Base config', () => {
       )
     })
 
+    test('should return false for css_extract_ignore_order_warnings when using default config', () => {
+      expect(config.css_extract_ignore_order_warnings).toEqual(false)
+    })
+
+    test('should return true for css_extract_ignore_order_warnings when configured', () => {
+      process.env.WEBPACKER_CONFIG = 'config/webpacker_css_extract_ignore_order_warnings.yml'
+      const config = require("../../config");
+
+      expect(config.css_extract_ignore_order_warnings).toEqual(true)
+    })
+
     test('should return only 2 entry points with config.nested_entries == false', () => {
       expect(config.nested_entries).toEqual(false)
 

data/package/environments/base.js

@@ -73,7 +73,11 @@ const getPlugins = () => {
     plugins.push(
       new MiniCssExtractPlugin({
         filename: `css/[name]${hash}.css`,
-        chunkFilename: `css/[id]${hash}.css`
+        chunkFilename: `css/[id]${hash}.css`.split(),
+        // For projects where css ordering has been mitigated through consistent use of scoping or naming conventions,
+        // the css order warnings can be disabled by setting the ignoreOrder flag.
+        // Read: https://stackoverflow.com/questions/51971857/mini-css-extract-plugin-warning-in-chunk-chunkname-mini-css-extract-plugin-con
+        ignoreOrder: config.css_extract_ignore_order_warnings
       })
     )
   }

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "shakapacker",
-  "version": "6.5.1",
+  "version": "6.5.3",
   "description": "Use webpack to manage app-like JavaScript modules in Rails",
   "main": "package/index.js",
   "files": [

data/test/test_app/config/webpacker_css_extract_ignore_order_warnings.yml

@@ -0,0 +1,84 @@
+# Note: You must restart bin/webpacker-dev-server for changes to take effect
+
+default: &default
+  source_path: app/packs
+  source_entry_path: entrypoints
+  nested_entries: true
+  public_root_path: public
+  public_output_path: packs
+  cache_path: tmp/webpacker
+  webpack_compile_output: false
+  webpack_loader: babel
+  css_extract_ignore_order_warnings: true
+
+  # Location for manifest.json, defaults to {public_output_path}/manifest.json if unset
+  # manifest_path: public/packs/manifest.json
+
+  # Additional paths webpack should look up modules
+  # ['app/assets', 'engine/foo/app/assets']
+  additional_paths:
+    - app/assets
+    - /etc/yarn
+    - some.config.js
+    - app/elm
+
+  # Reload manifest.json on all requests so we reload latest compiled packs
+  cache_manifest: false
+
+  static_assets_extensions:
+    - .jpg
+    - .jpeg
+    - .png
+    - .gif
+    - .tiff
+    - .ico
+    - .svg
+
+  extensions:
+    - .mjs
+    - .js
+
+development:
+  <<: *default
+  compile: true
+  ensure_consistent_versioning: true
+
+  # Reference: https://webpack.js.org/configuration/dev-server/
+  dev_server:
+    https: false
+    host: localhost
+    port: 3035
+    public: localhost:3035
+    hmr: false
+    overlay: true
+    disable_host_check: true
+    use_local_ip: false
+    pretty: false
+
+test:
+  <<: *default
+  compile: true
+
+  # Compile test packs to a separate directory
+  public_output_path: packs-test
+
+production:
+  <<: *default
+
+  # Production depends on precompilation of packs prior to booting for performance.
+  compile: false
+
+  # Cache manifest.json for performance
+  cache_manifest: true
+
+staging:
+  <<: *default
+
+  # Production depends on precompilation of packs prior to booting for performance.
+  compile: false
+
+  # Cache manifest.json for performance
+  cache_manifest: true
+
+  # Compile staging packs to a separate directory
+  public_output_path: packs-staging

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shakapacker
 version: !ruby/object:Gem::Version
-  version: 6.5.1
+  version: 6.5.3
 platform: ruby
 authors:
 - David Heinemeier Hansson
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-15 00:00:00.000000000 Z
+date: 2022-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -316,6 +316,7 @@ files:
 - test/test_app/config/initializers/inspect_autoload_paths.rb
 - test/test_app/config/webpack/webpack.config.js
 - test/test_app/config/webpacker.yml
+- test/test_app/config/webpacker_css_extract_ignore_order_warnings.yml
 - test/test_app/config/webpacker_defaults_fallback.yml
 - test/test_app/config/webpacker_manifest_path.yml
 - test/test_app/config/webpacker_nested_entries.yml
@@ -336,7 +337,7 @@ homepage: https://github.com/shakacode/shakapacker
 licenses:
 - MIT
 metadata:
-  source_code_uri: https://github.com/shakacode/shakapacker/tree/v6.5.1
+  source_code_uri: https://github.com/shakacode/shakapacker/tree/v6.5.3
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -432,6 +433,7 @@ test_files:
 - test/test_app/config/initializers/inspect_autoload_paths.rb
 - test/test_app/config/webpack/webpack.config.js
 - test/test_app/config/webpacker.yml
+- test/test_app/config/webpacker_css_extract_ignore_order_warnings.yml
 - test/test_app/config/webpacker_defaults_fallback.yml
 - test/test_app/config/webpacker_manifest_path.yml
 - test/test_app/config/webpacker_nested_entries.yml