shakapacker 9.3.4 → 9.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 20f8244a121f25f9c018754007b3588d99e4860677cc8ef4e2f8b55858edbd57
-  data.tar.gz: 4e5d80d804e55cfbce44d9139e70ea7f60d8709e92f1f07c95391e7e128a7e8e
+  metadata.gz: 4a0519c935e0e3d98204aeaeec6cc35b57fa13be1fe8a6f62e5e6cd5124d09c7
+  data.tar.gz: 7f6fe4134fd9b17de2dcd26b5c9e80f1f41d2019dfa0ed337092c1d23a9aa077
 SHA512:
-  metadata.gz: 02e7f011c8b6d839672e485146221a2e76f014926f4226a4394720837d56a9b646bd4d5732cbf48c0a3639b5067fcbc597c2fd44a3cc7bb2b77242a6d5ecaf41
-  data.tar.gz: f0510466924af335241216dc70e021ab26942012d3cdaf735fcd1bfa34d4b1ad615a4a9e7906ca5d348c519dde308a26fc46a34d0a54ebcdb9518ae3265ca209
+  metadata.gz: 8789ef5d5cf102254f27c0833b3a7bd8239b5b97d2dfa97ac79fb01827931397dc71dd35f82971a61354a1751f6dafd80d91a322e51b6390f83132f17a786626
+  data.tar.gz: 3a6cff63ba261b9cec55cdd683e7cfa96a24e52b753639643bf2f6874ed49c0f50a990a771a85c4265e9e6394a8fc7e8b4e3440ed5d62982f89b98cddadf9450

data/CHANGELOG.md

@@ -11,6 +11,10 @@
 
 Changes since the last non-beta release.
 
+### Added
+
+- **Added `SHAKAPACKER_SKIP_PRECOMPILE_HOOK` environment variable to skip precompile hook**. [PR #XXX](https://github.com/shakacode/shakapacker/pull/XXX) by [justin808](https://github.com/justin808). Set `SHAKAPACKER_SKIP_PRECOMPILE_HOOK=true` to skip the precompile hook during compilation. This is useful when using process managers like Foreman or Overmind to run the hook once before starting multiple webpack processes, preventing duplicate hook execution. **Migration tip:** If you have a custom `bin/dev` script that starts multiple webpack processes, you can now run the precompile hook once in the script and set this environment variable to prevent each webpack process from running the hook again. See the [precompile hook documentation](./docs/precompile_hook.md#skipping-the-hook) for implementation examples.
+
 ## [v9.3.4-beta.0] - November 17, 2025
 
 ### Fixed

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    shakapacker (9.3.4)
+    shakapacker (9.4.0)
       activesupport (>= 5.2)
       package_json
       rack-proxy (>= 0.6.1)

data/docs/precompile_hook.md

@@ -284,6 +284,104 @@ default:
 
 ## Advanced Usage
 
+### Skipping the Hook
+
+You can skip the precompile hook using the `SHAKAPACKER_SKIP_PRECOMPILE_HOOK` environment variable:
+
+```bash
+SHAKAPACKER_SKIP_PRECOMPILE_HOOK=true bin/shakapacker
+```
+
+**Important:** The environment variable must be set to the exact string `"true"` to skip the hook. Any other value (including `"false"`, `"1"`, or empty string) will run the hook normally.
+
+This is useful when:
+
+- Using `bin/dev` or Foreman to run the hook once before starting multiple webpack processes
+- Running the hook manually and then compiling multiple times
+- Debugging compilation issues without the hook
+
+**Note:** The examples below show how to implement this in your custom `bin/dev` script. If you're using React on Rails, the generated `bin/dev` script already implements this pattern automatically - it runs the precompile hook once before launching processes, then sets `SHAKAPACKER_SKIP_PRECOMPILE_HOOK=true` to prevent duplicate execution.
+
+**Recommended: Use Procfile env prefix**
+
+The cleanest approach is to set the environment variable per-process in your Procfile:
+
+```procfile
+# Procfile.dev
+web: env SHAKAPACKER_SKIP_PRECOMPILE_HOOK=true bin/rails server
+webpack-client: env SHAKAPACKER_SKIP_PRECOMPILE_HOOK=true bin/shakapacker --watch
+webpack-server: env SHAKAPACKER_SKIP_PRECOMPILE_HOOK=true bin/shakapacker --watch --config-name server
+```
+
+Then your `bin/dev` can run the hook once and launch the process manager:
+
+```bash
+#!/usr/bin/env bash
+# bin/dev
+
+# Run the hook once before launching all processes
+bundle exec ruby -r ./config/boot -e "
+  hook = Shakapacker.config.precompile_hook
+  if hook
+    puts \"Running precompile hook: #{hook}\"
+    system(hook) or exit(1)
+  end
+"
+
+exec foreman start -f Procfile.dev
+# or: exec overmind start -f Procfile.dev
+```
+
+**Alternative: Export environment variable**
+
+You can export the environment variable before starting your process manager:
+
+```bash
+#!/usr/bin/env bash
+# bin/dev
+
+# Run the hook once before launching all processes
+bundle exec ruby -r ./config/boot -e "
+  hook = Shakapacker.config.precompile_hook
+  if hook
+    puts \"Running precompile hook: #{hook}\"
+    system(hook) or exit(1)
+  end
+"
+
+# Export skip flag for all subprocesses
+export SHAKAPACKER_SKIP_PRECOMPILE_HOOK=true
+
+exec foreman start -f Procfile.dev
+# or: exec overmind start -f Procfile.dev
+```
+
+**Alternative: Use .env.local (not tracked by git)**
+
+For Foreman or Overmind, you can create a `.env.local` file (typically gitignored):
+
+```bash
+#!/usr/bin/env bash
+# bin/dev
+
+# Run the hook once before launching all processes
+bundle exec ruby -r ./config/boot -e "
+  hook = Shakapacker.config.precompile_hook
+  if hook
+    puts \"Running precompile hook: #{hook}\"
+    system(hook) or exit(1)
+  end
+"
+
+# Create .env.local for process manager subprocesses
+echo "SHAKAPACKER_SKIP_PRECOMPILE_HOOK=true" > .env.local
+
+exec foreman start -f Procfile.dev
+# or: exec overmind start -f Procfile.dev
+```
+
+This pattern ensures the hook runs once when development starts, not separately for each webpack process.
+
 ### Conditional Execution
 
 ```bash

data/lib/shakapacker/compiler.rb

@@ -27,7 +27,7 @@ class Shakapacker::Compiler
       true
     else
       acquire_ipc_lock do
-        run_precompile_hook if config.precompile_hook
+        run_precompile_hook if should_run_precompile_hook?
         run_webpack.tap do |success|
           after_compile_hook
         end
@@ -80,6 +80,13 @@ class Shakapacker::Compiler
       /ruby/.match?(first_line) ? RbConfig.ruby : ""
     end
 
+    def should_run_precompile_hook?
+      return false unless config.precompile_hook
+      return false if ENV["SHAKAPACKER_SKIP_PRECOMPILE_HOOK"] == "true"
+
+      true
+    end
+
     def run_precompile_hook
       hook_command = config.precompile_hook
       hook_spec = validate_precompile_hook(hook_command)

data/lib/shakapacker/version.rb

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

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "shakapacker",
-  "version": "9.3.4",
+  "version": "9.4.0",
   "description": "Use webpack to manage app-like JavaScript modules in Rails",
   "homepage": "https://github.com/shakacode/shakapacker",
   "bugs": {

data/sig/shakapacker/compiler.rbs

@@ -52,8 +52,12 @@ class Shakapacker::Compiler
 
   def bin_shakapacker_path: () -> Pathname
 
+  def should_run_precompile_hook?: () -> bool
+
   def run_precompile_hook: () -> void
 
+  def validate_precompile_hook: (String hook_command) -> Hash[Symbol, untyped]
+
   def run_webpack: () -> bool
 
   def webpack_env: () -> Hash[String, String]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shakapacker
 version: !ruby/object:Gem::Version
-  version: 9.3.4
+  version: 9.4.0
 platform: ruby
 authors:
 - David Heinemeier Hansson
@@ -413,7 +413,7 @@ homepage: https://github.com/shakacode/shakapacker
 licenses:
 - MIT
 metadata:
-  source_code_uri: https://github.com/shakacode/shakapacker/tree/v9.3.4
+  source_code_uri: https://github.com/shakacode/shakapacker/tree/v9.4.0
 rdoc_options: []
 require_paths:
 - lib