shakapacker 7.1.0 → 7.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b52fbe18d6cc69e790f1432b93a8badee45c64229b7e0b5ad9bf6e7645c1c28c
-  data.tar.gz: 94ba2b7a48537e4b3ece200e2983975b444a340edff45b9af3544b1709375c38
+  metadata.gz: ae742f19f77532f469332730b57bb1e381c6f238ace6cd5eb113a95f607bde68
+  data.tar.gz: 246d1e8dba39d501d219d1e37f4665c8b9f1ab401825173f22cbe270bf95a933
 SHA512:
-  metadata.gz: ade899e22f00c9863302d2a9aa7e58549d057b07be50d34d853751cabf59a9d318a637240734854059b352110b20245361ec7d427488166b4e481639b90cb380
-  data.tar.gz: 6364f8d109c008da994d01f7ad553472a90d5392511b796ba7286502d5f3b6969ad225cbd8e3364fb86da6f2dc5b19524631399eebae982b43558444cb886a0e
+  metadata.gz: d57fc47ab68b52626fa66d643d5d62ceeb62fd27b707844c5b187c5ef4e29a15cbb8296a3bbb9204740ecd3769371c05c1ea6046ac2deffc7771bbf2b0839484
+  data.tar.gz: 5af5dc61cf4d3f01b17eaca403a8f09ae8a63fe3d2adffdb3dd91969c0e71684118ae0365a893a27690ed4275c03fb1d46a20b30fcb56f8821fdae44110b212e

data/.github/workflows/dummy.yml

@@ -10,6 +10,9 @@ jobs:
       - uses: actions/checkout@v4
         with:
           persist-credentials: false
+      - uses: actions/setup-node@v3
+        with:
+          node-version: '16'
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: '3.1.2'

data/.github/workflows/generator.yml

@@ -10,6 +10,7 @@ jobs:
       matrix:
         os: [ubuntu-latest]
         ruby: ['2.6', '2.7', '3.0']
+        use_package_json_gem: ['true', 'false']
         gemfile:
           - gemfiles/Gemfile-rails.6.0.x
           - gemfiles/Gemfile-rails.6.1.x
@@ -37,3 +38,5 @@ jobs:
       - name: Install dependencies
         run: bundle install
       - run: bundle exec rake run_spec:generator
+        env:
+          SHAKAPACKER_USE_PACKAGE_JSON_GEM: ${{ matrix.use_package_json_gem }}

data/.github/workflows/ruby-backward-compatibility.yml

@@ -39,3 +39,9 @@ jobs:
 
       - name: Ruby specs - Backward compatibility
         run: bundle exec rake run_spec:gem_bc
+        env:
+          SHAKAPACKER_USE_PACKAGE_JSON_GEM: "false"
+      - name: Ruby specs - Backward compatibility
+        run: bundle exec rake run_spec:gem_bc
+        env:
+          SHAKAPACKER_USE_PACKAGE_JSON_GEM: "true"

data/.github/workflows/ruby.yml

@@ -39,3 +39,10 @@ jobs:
 
       - name: Ruby specs
         run: bundle exec rake run_spec:gem
+        env:
+          SHAKAPACKER_USE_PACKAGE_JSON_GEM: "false"
+
+      - name: Ruby specs
+        run: bundle exec rake run_spec:gem
+        env:
+          SHAKAPACKER_USE_PACKAGE_JSON_GEM: "true"

data/CHANGELOG.md

@@ -5,20 +5,36 @@
 
 ## Versions
 ## [Unreleased]
-Changes since last non-beta release.
+Changes since the last non-beta release.
 
 _Please add entries here for your pull requests that are not yet released._
 
 ### Added
-- Support passing custom webpack config directly to `generateWebpackConfig` for merging [PR 343](https://github.com/shakacode/shakapacker/pull/343) by [G-Rath](https://github.com/g-rath)
+- Experimental support for other JS package managers using `package_json` gem [PR 349](https://github.com/shakacode/shakapacker/pull/349) by [G-Rath](https://github.com/g-rath).
+- Support `hmr: only` configuration [PR 378](https://github.com/shakacode/shakapacker/pull/378) by [SimenB](https://github.com/SimenB).
+- Use `config/shakapacker.yml` as the secondary source for `asset_host` and `relative_url_root` configurations [PR 376](https://github.com/shakacode/shakapacker/pull/376) by [ahangarha](https://github.com/ahangarha).
 
 ### Fixed
-- Use `NODE_OPTIONS` to enable Node-specific debugging flags [PR 350](https://github.com/shakacode/shakapacker/pull/350)
-- Add the boilplate `application.js` into `packs/` [PR 363](https://github.com/shakacode/shakapacker/pull/363)
+- Recommend `server` option instead of deprecated `https` option when `--https` is provided [PR 380](https://github.com/shakacode/shakapacker/pull/380) by [G-Rath](https://github.com/g-rath)
+- Recompile assets on asset host change [PR 364](https://github.com/shakacode/shakapacker/pull/364) by [ahangarha](https://github.com/ahangarha).
+- Add deprecation warning for `https` option in `shakapacker.yml` (use `server: 'https'` instead) [PR 382](https://github.com/shakacode/shakapacker/pull/382) by [G-Rath](https://github.com/g-rath).
+- Disable Hot Module Replacement in `webpack-dev-server` when `hmr: false` [PR 392](https://github.com/shakacode/shakapacker/pull/392) by [thedanbob](https://github.com/thedanbob).
+
+### Deprecated
+- The usage of relative_url_root is deprecated in Shakapacker and will be removed in v8. [PR 376](https://github.com/shakacode/shakapacker/pull/376) by [ahangarha](https://github.com/ahangarha).
+
+## [v7.1.0] - September 30, 2023
+
+### Added
+- Support passing custom webpack config directly to `generateWebpackConfig` for merging [PR 343](https://github.com/shakacode/shakapacker/pull/343) by [G-Rath](https://github.com/g-rath).
+
+### Fixed
+- Use `NODE_OPTIONS` to enable Node-specific debugging flags [PR 350](https://github.com/shakacode/shakapacker/pull/350).
+- Add the boilerplate `application.js` into `packs/` [PR 363](https://github.com/shakacode/shakapacker/pull/363).
 
 ## [v7.0.3] - July 7, 2023
 ### Fixed
-- Fixed commands execution for projects with space in absolute path [PR 322](https://github.com/shakacode/shakapacker/pull/322) by [kukicola](https://github.com/kukicola).
+- Fixed commands execution for projects with space in the absolute path [PR 322](https://github.com/shakacode/shakapacker/pull/322) by [kukicola](https://github.com/kukicola).
 
 ## [v7.0.2] - July 3, 2023
 ### Fixed
@@ -274,7 +290,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/v7.0.3...master
+[Unreleased]: https://github.com/shakacode/shakapacker/compare/v7.1.0...master
+[v7.1.0]: https://github.com/shakacode/shakapacker/compare/v7.0.3...v7.1.0
 [v7.0.3]: https://github.com/shakacode/shakapacker/compare/v7.0.2...v7.0.3
 [v7.0.2]: https://github.com/shakacode/shakapacker/compare/v7.0.1...v7.0.2
 [v7.0.1]: https://github.com/shakacode/shakapacker/compare/v7.0.0...v7.0.1

data/README.md

@@ -51,6 +51,7 @@ Read the [full review here](https://clutch.co/profile/shakacode#reviews?sort_by=
     - [Optional support](#optional-support)
   - [Installation](#installation)
     - [Rails v6+](#rails-v6)
+    - [Using alternative package managers](#using-alternative-package-managers)
     - [Note for Yarn v2 usage](#note-for-yarn-v2-usage)
   - [Concepts](#concepts)
   - [Usage](#usage)
@@ -163,9 +164,21 @@ yarn add @babel/core @babel/plugin-transform-runtime @babel/preset-env @babel/ru
 Previously, these "webpack" and "babel" packages were direct dependencies for `shakapacker`. By
 making these peer dependencies, you have control over the versions used in your webpack and babel configs.
 
+### Using alternative package managers
+
+There is experimental support for using package managers besides Yarn classic for managing JavaScript dependencies using the [`package_json`](https://github.com/G-Rath/package_json) gem.
+
+This can be enabled by setting the environment variable `SHAKAPACKER_USE_PACKAGE_JSON_GEM` to `true`; Shakapacker will then use the `package_json` gem which in turn will look for the [`packageManager`](https://nodejs.org/api/packages.html#packagemanager) property in the `package.json` or otherwise the `PACKAGE_JSON_FALLBACK_MANAGER` environment variable to determine which manager to use, defaulting to `npm` if neither are found.
+
+See [here](https://github.com/G-Rath/package_json#specifying-a-package-manager) for a list of the supported package managers and more information; note that `package_json` does not handle ensuring the manager is installed.
+
+> **Note**
+> 
+> The rest of the documentation assumes that `package_json` is not being used, and so always references `yarn` - you should instead use the package manager of your choice for these commands.  
+
 ### Note for Yarn v2 usage
 
-If you are using Yarn v2 (berry), please note that PnP modules are not supported.
+If you are using Yarn v2 (berry), please note that PnP modules are not supported unless you're using `SHAKAPACKER_USE_PACKAGE_JSON_GEM`.
 
 To use Shakapacker with Yarn v2, make sure you set `nodeLinker: node-modules` in your `.yarnrc.yml` file as per the [Yarn docs](https://yarnpkg.com/getting-started/migration#step-by-step) to opt out of Plug'n'Play behavior.
 
@@ -272,7 +285,11 @@ Note, the default of "defer" for the `javascript_pack_tag`. You can override tha
 <%= javascript_pack_tag 'calendar' %>
 <%= javascript_pack_tag 'map' %>
 ```
-While this also generally applies to `stylesheet_pack_tag`, you may use multiple calls to stylesheet_pack_tag if, say, you require multiple <style> tags for different output media:
+
+While this also generally applies to `stylesheet_pack_tag`,
+you may use multiple calls to stylesheet_pack_tag if,
+say,
+you require multiple `<style>` tags for different output media:
 
 ``` erb
 <%= stylesheet_pack_tag 'application', media: 'screen' %>
@@ -417,7 +434,16 @@ In production or CI environments, the `digest` strategy is more suitable, unless
 
 You can control what strategy is used by the `compiler_strategy` option in `shakapacker.yml` config file. By default `mtime` strategy is used in development environment, `digest` is used elsewhere.
 
-**Note:** If you are not using the `shakapacker-dev-server`, your packs will be served by the Rails public file server. If you've enabled caching (Rails application `config.action_controller.perform_caching` setting), your changes will likely not be picked up due to `Cache-Control` header being set and assets being cached in the browser memory. For more details see [issue](https://github.com/shakacode/shakapacker/issues/88)[ #88](https://github.com/shakacode/shakapacker/issues/88)](https://github.com/shakacode/shakapacker/issues/88).
+**Note:**
+If you are not using the `shakapacker-dev-server`,
+your packs will be served by the Rails public file server.
+If you've enabled caching
+(Rails application `config.action_controller.perform_caching` setting),
+your changes will likely not be picked up due to `Cache-Control` header being set
+and
+assets being cached in the browser memory.
+For more details see
+[issue 88: Caching issues in Development since migrating to Shakapacker](https://github.com/shakacode/shakapacker/issues/88).
 
 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/shakapacker-dev-server`. This process will watch for changes in the relevant files, defined by `shakapacker.yml` configuration settings for `source_path`, `source_entry_path`, and `additional_paths`, and it will then automatically reload the browser to match. This feature is also known as [Hot Module Replacement](https://webpack.js.org/concepts/hot-module-replacement/).
 

data/docs/v6_upgrade.md

@@ -101,7 +101,7 @@ _If you're on webpacker v5, follow [how to upgrade to webpacker v6.0.0.rc.6 from
 
 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`.
+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`.
 
 1. If you are using any integrations like `css`, `postcss`, `React` or `TypeScript`. Please see https://github.com/shakacode/shakapacker#integrations section on how they work in v6.
 
@@ -168,5 +168,5 @@ _If you're on webpacker v5, follow [how to upgrade to webpacker v6.0.0.rc.6 from
 
 ## Examples of v5 to v6
 
-1. [React on Rails Project with HMR and SSR](https://github.com/shakacode/react_on_rails_tutorial_with_ssr_and_hmr_fast_refresh/compare/webpacker-5.x...master)
+1. [React on Rails Project with HMR and SSR](https://github.com/shakacode/react_on_rails_tutorial_with_ssr_and_hmr_fast_refresh/compare/webpacker-5.x...61e897f2c604085f45b9ab5e23642501e430fb28)
 2. [Vue and Sass Example](https://github.com/guillaumebriday/upgrade-webpacker-5-to-6)

data/lib/install/config/shakapacker.yml

@@ -50,6 +50,11 @@ default: &default
   # https://webpack.js.org/guides/build-performance/#avoid-production-specific-tooling
   useContentHash: false
 
+  # Setting the asset host here will override Rails.application.config.asset_host.
+  # Here, you can set different asset_host per environment. Note that
+  # SHAKAPACKER_ASSET_HOST will override both configurations.
+  # asset_host: custom-path
+
 development:
   <<: *default
   compile: true
@@ -59,8 +64,6 @@ development:
   # Keys not described there are documented inline and in https://github.com/shakacode/shakapacker/
   dev_server:
     # For running dev server with https, set `server: https`.
-    # You may use `https: true` instead but notice that it is deprecated in favor of `server: https`
-    # Ensure only one of these entries is set.
     # server: https
 
     host: localhost

data/lib/install/template.rb

@@ -1,3 +1,4 @@
+require "shakapacker/utils/misc"
 require "shakapacker/utils/version_syntax_converter"
 
 # Install Shakapacker
@@ -41,12 +42,28 @@ else
   say %(        Add <%= javascript_pack_tag "application" %> within the <head> tag in your custom layout.)
 end
 
+def package_json
+  if @package_json.nil?
+    Shakapacker::Utils::Misc.require_package_json_gem
+
+    @package_json = PackageJson.read
+  end
+
+  @package_json
+end
+
 # Ensure there is `system!("bin/yarn")` command in `./bin/setup` file
 if (setup_path = Rails.root.join("bin/setup")).exist?
-  say "Run bin/yarn during bin/setup"
+  def native_install_command
+    return "bin/yarn" unless Shakapacker::Utils::Misc.use_package_json_gem
+
+    package_json.manager.native_install_command.join(" ")
+  end
+
+  say "Run #{native_install_command} during bin/setup"
 
   if File.read(setup_path).match? Regexp.escape("  # system('bin/yarn')\n")
-    gsub_file(setup_path, "# system('bin/yarn')", "system!('bin/yarn')")
+    gsub_file(setup_path, "# system('bin/yarn')", "system!('#{native_install_command}')")
   else
     # Due to the inconsistency of quotation usage in Rails 7 compared to
     # earlier versions, we check both single and double quotations here.
@@ -55,30 +72,58 @@ if (setup_path = Rails.root.join("bin/setup")).exist?
     string_to_add = <<-RUBY
 
   # Install JavaScript dependencies
-  system!("bin/yarn")
-RUBY
+  system!("#{native_install_command}")
+    RUBY
 
     if File.read(setup_path).match? pattern
       insert_into_file(setup_path, string_to_add, after: pattern)
     else
       say <<~MSG, :red
         It seems your `bin/setup` file doesn't have the expected content.
-        Please review the file and manually add `system!("bin/yarn")` before any
+        Please review the file and manually add `system!("#{native_install_command}")` before any
         other command that requires JavaScript dependencies being already installed.
       MSG
     end
   end
 end
 
-results = []
+def add_dependencies(dependencies, type)
+  return package_json.manager.add!(dependencies, type: type) if Shakapacker::Utils::Misc.use_package_json_gem
+
+  # TODO: check that run actually errors
+  run("yarn add #{dependencies.join(" ")}") if type == :production
+  run("yarn add --dev #{dependencies.join(" ")}") if type == :dev
+rescue PackageJson::Error
+  say "Shakapacker installation failed 😭 See above for details.", :red
+  exit 1
+end
+
+def fetch_peer_dependencies
+  if Shakapacker::Utils::Misc.use_package_json_gem
+    return PackageJson.read("#{__dir__}/../../").fetch("peerDependencies")
+  end
+
+  package_json = File.read("#{__dir__}/../../package.json")
+  JSON.parse(package_json)["peerDependencies"]
+end
 
 Dir.chdir(Rails.root) do
   npm_version = Shakapacker::Utils::VersionSyntaxConverter.new.rubygem_to_npm(Shakapacker::VERSION)
   say "Installing shakapacker@#{npm_version}"
-  results << run("yarn add shakapacker@#{npm_version} --exact")
+  add_dependencies(["shakapacker@#{npm_version}"], :production)
+
+  if Shakapacker::Utils::Misc.use_package_json_gem
+    package_json.merge! do |pj|
+      {
+        "dependencies" => pj["dependencies"].merge({
+          # TODO: workaround for test suite - long-run need to actually account for diff pkg manager behaviour
+          "shakapacker" => pj["dependencies"]["shakapacker"].delete_prefix("^")
+        })
+      }
+    end
+  end
 
-  package_json = File.read("#{__dir__}/../../package.json")
-  peers = JSON.parse(package_json)["peerDependencies"]
+  peers = fetch_peer_dependencies
   dev_dependency_packages = ["webpack-dev-server"]
 
   dependencies_to_add = []
@@ -96,13 +141,8 @@ Dir.chdir(Rails.root) do
   end
 
   say "Adding shakapacker peerDependencies"
-  results << run("yarn add #{dependencies_to_add.join(' ')}")
+  add_dependencies(dependencies_to_add, :production)
 
   say "Installing webpack-dev-server for live reloading as a development dependency"
-  results << run("yarn add --dev #{dev_dependencies_to_add.join(' ')}")
-end
-
-unless results.all?
-  say "Shakapacker installation failed 😭 See above for details.", :red
-  exit 1
+  add_dependencies(dev_dependencies_to_add, :dev)
 end

data/lib/shakapacker/compiler.rb

@@ -106,9 +106,11 @@ class Shakapacker::Compiler
 
       Shakapacker.set_shakapacker_env_variables_for_backward_compatibility
 
-      env.merge("SHAKAPACKER_ASSET_HOST"        => ENV.fetch("SHAKAPACKER_ASSET_HOST", ActionController::Base.helpers.compute_asset_host),
-                "SHAKAPACKER_RELATIVE_URL_ROOT" => ENV.fetch("SHAKAPACKER_RELATIVE_URL_ROOT", ActionController::Base.relative_url_root),
-                "SHAKAPACKER_CONFIG" => instance.config_path.to_s)
+      env.merge(
+        "SHAKAPACKER_ASSET_HOST"        => instance.config.asset_host,
+        "SHAKAPACKER_RELATIVE_URL_ROOT" => instance.config.relative_url_root,
+        "SHAKAPACKER_CONFIG"            => instance.config_path.to_s
+      )
     end
 
     def bin_shakapacker_path

data/lib/shakapacker/configuration.rb

@@ -116,6 +116,22 @@ class Shakapacker::Configuration
     data.fetch(key, defaults[:shakapacker_precompile])
   end
 
+  def asset_host
+    ENV.fetch(
+      "SHAKAPACKER_ASSET_HOST",
+      fetch(:asset_host) || ActionController::Base.helpers.compute_asset_host
+    )
+  end
+
+  def relative_url_root
+    Shakapacker.puts_deprecation_message "The usage of relative_url_root is deprecated in Shakapacker and will be removed in v8."
+
+    ENV.fetch(
+      "SHAKAPACKER_RELATIVE_URL_ROOT",
+      fetch(:relative_url_root) || ActionController::Base.relative_url_root
+    )
+  end
+
   private
     def data
       @data ||= load

data/lib/shakapacker/dev_server.rb

@@ -31,7 +31,13 @@ class Shakapacker::DevServer
   end
 
   def https?
-    case fetch(:https)
+    value = fetch(:https)
+
+    unless value.nil?
+      puts "WARNING: `https: true` has been deprecated in favor of `server: 'https'`"
+    end
+
+    case value
     when true, "true", Hash
       true
     else

data/lib/shakapacker/dev_server_runner.rb

@@ -48,7 +48,7 @@ module Shakapacker
         end
 
         if @argv.include?("--https") && !@https
-          $stdout.puts "Please set https: true in shakapacker.yml to use the --https command line flag."
+          $stdout.puts "--https requires that 'server' in shakapacker.yml is set to 'https'"
           exit!
         end
       end
@@ -68,11 +68,7 @@ module Shakapacker
         env["WEBPACK_SERVE"] = "true"
         env["NODE_OPTIONS"] = ENV["NODE_OPTIONS"] || ""
 
-        cmd = if node_modules_bin_exist?
-          ["#{@node_modules_bin_path}/webpack", "serve"]
-        else
-          ["yarn", "webpack", "serve"]
-        end
+        cmd = build_cmd
 
         if @argv.include?("--debug-webpacker")
           Shakapacker.puts_deprecation_message(
@@ -90,7 +86,10 @@ module Shakapacker
         cmd += ["--config", @webpack_config]
         cmd += ["--progress", "--color"] if @pretty
 
-        cmd += ["--hot"] if @hot
+        # Default behavior of webpack-dev-server is @hot = true
+        cmd += ["--hot", "only"] if @hot == "only"
+        cmd += ["--no-hot"] if !@hot
+
         cmd += @argv
 
         Dir.chdir(@app_path) do
@@ -98,6 +97,16 @@ module Shakapacker
         end
       end
 
+      def build_cmd
+        if Shakapacker::Utils::Misc.use_package_json_gem
+          return package_json.manager.native_exec_command("webpack", ["serve"])
+        end
+
+        return ["#{@node_modules_bin_path}/webpack", "serve"] if node_modules_bin_exist?
+
+        ["yarn", "webpack", "serve"]
+      end
+
       def node_modules_bin_exist?
         File.exist?("#{@node_modules_bin_path}/webpack-dev-server")
       end

data/lib/shakapacker/digest_strategy.rb

@@ -44,7 +44,9 @@ module Shakapacker
         end
         files = Dir[*expanded_paths].reject { |f| File.directory?(f) }
         file_ids = files.sort.map { |f| "#{File.basename(f)}/#{Digest::SHA1.file(f).hexdigest}" }
-        Digest::SHA1.hexdigest(file_ids.join("/"))
+
+        asset_host = Shakapacker.config.asset_host.to_s
+        Digest::SHA1.hexdigest(file_ids.join("/").concat(asset_host))
       end
 
       def record_compilation_digest

data/lib/shakapacker/runner.rb

@@ -1,3 +1,5 @@
+require "shakapacker/utils/misc"
+
 module Shakapacker
   class Runner
     def self.run(argv)
@@ -14,7 +16,7 @@ module Shakapacker
 
       Shakapacker.set_shakapacker_env_variables_for_backward_compatibility
 
-      @node_modules_bin_path = ENV["SHAKAPACKER_NODE_MODULES_BIN_PATH"] || `yarn bin`.chomp
+      @node_modules_bin_path = fetch_node_modules_bin_path
       @shakapacker_config    = ENV["SHAKAPACKER_CONFIG"] || File.join(@app_path, "config/shakapacker.yml")
 
       @shakapacker_config = Shakapacker.get_config_file_path_with_backward_compatibility(@shakapacker_config)
@@ -24,5 +26,21 @@ module Shakapacker
         exit!
       end
     end
+
+    def fetch_node_modules_bin_path
+      return nil if Shakapacker::Utils::Misc.use_package_json_gem
+
+      ENV["SHAKAPACKER_NODE_MODULES_BIN_PATH"] || `yarn bin`.chomp
+    end
+
+    def package_json
+      if @package_json.nil?
+        Shakapacker::Utils::Misc.require_package_json_gem
+
+        @package_json = PackageJson.read(@app_path)
+      end
+
+      @package_json
+    end
   end
 end

data/lib/shakapacker/utils/misc.rb

@@ -8,6 +8,18 @@ module Shakapacker
     class Misc
       extend FileUtils
 
+      def self.use_package_json_gem
+        ENV.fetch("SHAKAPACKER_USE_PACKAGE_JSON_GEM", "false").casecmp("true").zero?
+      end
+
+      def self.require_package_json_gem
+        unless use_package_json_gem
+          raise "PackageJson should not be used unless SHAKAPACKER_USE_PACKAGE_JSON_GEM is true"
+        end
+
+        require "package_json"
+      end
+
       def self.uncommitted_changes?(message_handler)
         return false if ENV["COVERAGE"] == "true"
 

data/lib/shakapacker/version.rb

@@ -1,4 +1,4 @@
 module Shakapacker
   # Change the version in package.json too, please!
-  VERSION = "7.1.0".freeze
+  VERSION = "7.2.0".freeze
 end

data/lib/shakapacker/webpack_runner.rb

@@ -21,11 +21,7 @@ module Shakapacker
       env["SHAKAPACKER_CONFIG"] = @shakapacker_config
       env["NODE_OPTIONS"] = ENV["NODE_OPTIONS"] || ""
 
-      cmd = if node_modules_bin_exist?
-        ["#{@node_modules_bin_path}/webpack"]
-      else
-        ["yarn", "webpack"]
-      end
+      cmd = build_cmd
 
       if @argv.include?("--debug-webpacker")
         Shakapacker.puts_deprecation_message(
@@ -61,6 +57,17 @@ module Shakapacker
     end
 
     private
+
+      def build_cmd
+        if Shakapacker::Utils::Misc.use_package_json_gem
+          return package_json.manager.native_exec_command("webpack")
+        end
+
+        return ["#{@node_modules_bin_path}/webpack"] if node_modules_bin_exist?
+
+        ["yarn", "webpack"]
+      end
+
       def node_modules_bin_exist?
         File.exist?("#{@node_modules_bin_path}/webpack")
       end

data/lib/tasks/shakapacker/binstubs.rake

@@ -3,7 +3,7 @@ bin_path = ENV["BUNDLE_BIN"] || Rails.root.join("bin")
 
 namespace :shakapacker do
   desc "Installs Shakapacker binstubs in this application"
-  task binstubs: [:check_node, :check_yarn] do |task|
+  task binstubs: [:check_node, :check_manager] do |task|
     prefix = task.name.split(/#|shakapacker:binstubs/).first
 
     if Rails::VERSION::MAJOR >= 5

data/lib/tasks/shakapacker/check_manager.rake

@@ -0,0 +1,27 @@
+require "shakapacker/utils/misc"
+
+namespace :shakapacker do
+  desc "Verifies if the expected JS package manager is installed"
+  task :check_manager do |task|
+    unless Shakapacker::Utils::Misc.use_package_json_gem
+      prefix = task.name.split(/#|shakapacker:/).first
+      Rake::Task["#{prefix}shakapacker:check_manager"].invoke
+      next
+    end
+
+    require "package_json"
+
+    package_json = PackageJson.read
+    pm = package_json.manager.binary
+
+    begin
+      version = package_json.manager.version
+
+      $stdout.puts "using #{pm}@#{version} to manage dependencies and scripts in package.json"
+    rescue PackageJson::Error
+      $stderr.puts "#{pm} not installed - please ensure it is installed before trying again"
+      $stderr.puts "Exiting!"
+      exit!
+    end
+  end
+end

data/lib/tasks/shakapacker/check_yarn.rake

@@ -1,7 +1,8 @@
-require "semantic_range"
 namespace :shakapacker do
   desc "Verifies if Yarn is installed"
   task :check_yarn do
+    require "semantic_range"
+
     begin
       which_command = Gem.win_platform? ? "where" : "which"
       raise Errno::ENOENT if `#{which_command} yarn`.strip.empty?

data/lib/tasks/shakapacker/info.rake

@@ -1,4 +1,5 @@
 require "shakapacker/version"
+require "shakapacker/utils/misc"
 
 namespace :shakapacker do
   desc "Provide information on Shakapacker's environment"
@@ -8,14 +9,30 @@ namespace :shakapacker do
       $stdout.puts "Rails: #{Rails.version}"
       $stdout.puts "Shakapacker: #{Shakapacker::VERSION}"
       $stdout.puts "Node: #{`node --version`}"
-      $stdout.puts "Yarn: #{`yarn --version`}"
+      if Shakapacker::Utils::Misc.use_package_json_gem
+        require "package_json"
+
+        pj_manager = PackageJson.read.manager
+
+        $stdout.puts "#{pj_manager.binary}: #{pj_manager.version}"
+      else
+        $stdout.puts "Yarn: #{`yarn --version`}"
+      end
+
+      if Shakapacker::Utils::Misc.use_package_json_gem
+        node_package_version = Shakapacker::VersionChecker.build.node_package_version.raw
+      else
+        node_package_version = `npm list shakapacker version`
+      end
 
       $stdout.puts "\n"
-      $stdout.puts "shakapacker: \n#{`npm list shakapacker version`}"
+      $stdout.puts "shakapacker: #{node_package_version}"
 
       $stdout.puts "Is bin/shakapacker present?: #{File.exist? 'bin/shakapacker'}"
       $stdout.puts "Is bin/shakapacker-dev-server present?: #{File.exist? 'bin/shakapacker-dev-server'}"
-      $stdout.puts "Is bin/yarn present?: #{File.exist? 'bin/yarn'}"
+      unless Shakapacker::Utils::Misc.use_package_json_gem
+        $stdout.puts "Is bin/yarn present?: #{File.exist? 'bin/yarn'}"
+      end
     end
   end
 end

data/lib/tasks/shakapacker/install.rake

@@ -3,7 +3,7 @@ bin_path = ENV["BUNDLE_BIN"] || Rails.root.join("bin")
 
 namespace :shakapacker do
   desc "Install Shakapacker in this application"
-  task install: [:check_node, :check_yarn] do |task|
+  task install: [:check_node] do |task|
     Shakapacker::Configuration.installing = true
 
     prefix = task.name.split(/#|shakapacker:install/).first