shakapacker 8.0.2 → 9.2.0

data/lib/shakapacker/compiler.rb

@@ -1,7 +1,8 @@
 require "open3"
-require "shakapacker/compiler_strategy"
 require "fileutils"
 
+require_relative "compiler_strategy"
+
 class Shakapacker::Compiler
   # Additional environment variables that the compiler is being run with
   # Shakapacker::Compiler.env['FRONTEND_API_KEY'] = 'your_secret_key'

data/lib/shakapacker/compiler_strategy.rb

@@ -1,5 +1,5 @@
-require "shakapacker/mtime_strategy"
-require "shakapacker/digest_strategy"
+require_relative "mtime_strategy"
+require_relative "digest_strategy"
 
 module Shakapacker
   class CompilerStrategy

data/lib/shakapacker/configuration.rb

@@ -1,4 +1,5 @@
 require "yaml"
+require "json"
 require "active_support/core_ext/hash/keys"
 require "active_support/core_ext/hash/indifferent_access"
 
@@ -68,6 +69,13 @@ class Shakapacker::Configuration
     root_path.join(fetch(:public_root_path))
   end
 
+  def private_output_path
+    private_path = fetch(:private_output_path)
+    return nil unless private_path
+    validate_output_paths!
+    root_path.join(private_path)
+  end
+
   def public_output_path
     public_path.join(fetch(:public_output_path))
   end
@@ -88,6 +96,107 @@ class Shakapacker::Configuration
     fetch(:compiler_strategy)
   end
 
+  def assets_bundler
+    # Show deprecation warning if using old 'bundler' key
+    if data.has_key?(:bundler) && !data.has_key?(:assets_bundler)
+      $stderr.puts "⚠️  DEPRECATION WARNING: The 'bundler' configuration option is deprecated. Please use 'assets_bundler' instead to avoid confusion with Ruby's Bundler gem manager."
+    end
+    ENV["SHAKAPACKER_ASSETS_BUNDLER"] || fetch(:assets_bundler) || fetch(:bundler) || "webpack"
+  end
+
+  # Deprecated: Use assets_bundler instead
+  def bundler
+    assets_bundler
+  end
+
+  def rspack?
+    assets_bundler == "rspack"
+  end
+
+  def webpack?
+    assets_bundler == "webpack"
+  end
+
+  def javascript_transpiler
+    # Show deprecation warning if using old 'webpack_loader' key
+    if data.has_key?(:webpack_loader) && !data.has_key?(:javascript_transpiler)
+      $stderr.puts "⚠️  DEPRECATION WARNING: The 'webpack_loader' configuration option is deprecated. Please use 'javascript_transpiler' instead as it better reflects its purpose of configuring JavaScript transpilation regardless of the bundler used."
+    end
+
+    # Use explicit config if set, otherwise default based on bundler
+    transpiler = fetch(:javascript_transpiler) || fetch(:webpack_loader) || default_javascript_transpiler
+
+    # Validate transpiler configuration
+    validate_transpiler_configuration(transpiler) unless self.class.installing
+
+    transpiler
+  end
+
+  # Deprecated: Use javascript_transpiler instead
+  def webpack_loader
+    javascript_transpiler
+  end
+
+  private
+
+    def default_javascript_transpiler
+      # RSpack has built-in SWC support, use it by default
+      rspack? ? "swc" : "babel"
+    end
+
+    def validate_transpiler_configuration(transpiler)
+      return unless ENV["NODE_ENV"] != "test" # Skip validation in test environment
+
+      # Check if package.json exists
+      package_json_path = root_path.join("package.json")
+      return unless package_json_path.exist?
+
+      begin
+        package_json = JSON.parse(File.read(package_json_path))
+        all_deps = (package_json["dependencies"] || {}).merge(package_json["devDependencies"] || {})
+
+        # Check for transpiler mismatch
+        has_babel = all_deps.keys.any? { |pkg| pkg.start_with?("@babel/", "babel-") }
+        has_swc = all_deps.keys.any? { |pkg| pkg.include?("swc") }
+        has_esbuild = all_deps.keys.any? { |pkg| pkg.include?("esbuild") }
+
+        case transpiler
+        when "babel"
+          if !has_babel && has_swc
+            warn_transpiler_mismatch("Babel", "SWC packages found but Babel is configured")
+          end
+        when "swc"
+          if !has_swc && has_babel
+            warn_transpiler_mismatch("SWC", "Babel packages found but SWC is configured")
+          end
+        when "esbuild"
+          if !has_esbuild && (has_babel || has_swc)
+            other = has_babel ? "Babel" : "SWC"
+            warn_transpiler_mismatch("esbuild", "#{other} packages found but esbuild is configured")
+          end
+        end
+      rescue JSON::ParserError
+        # Ignore if package.json is malformed
+      end
+    end
+
+    def warn_transpiler_mismatch(configured, message)
+      $stderr.puts <<~WARNING
+        ⚠️  Transpiler Configuration Mismatch Detected:
+           #{message}
+           Configured transpiler: #{configured}
+        #{'   '}
+           This might cause unexpected behavior or build failures.
+        #{'   '}
+           To fix this:
+           1. Run 'rails shakapacker:migrate_to_swc' to migrate to SWC (recommended for 20x faster builds)
+           2. Or install the correct packages for #{configured}
+           3. Or update your shakapacker.yml to match your installed packages
+      WARNING
+    end
+
+  public
+
   def fetch(key)
     data.fetch(key, defaults[key])
   end
@@ -99,7 +208,43 @@ class Shakapacker::Configuration
     )
   end
 
+  def integrity
+    fetch(:integrity)
+  end
+
   private
+    def validate_output_paths!
+      # Skip validation if already validated to avoid redundant checks
+      return if @validated_output_paths
+      @validated_output_paths = true
+
+      # Only validate when both paths are configured
+      return unless fetch(:private_output_path) && fetch(:public_output_path)
+
+      private_path_str, public_path_str = resolve_paths_for_comparison
+
+      if private_path_str == public_path_str
+        raise "Shakapacker configuration error: private_output_path and public_output_path must be different. " \
+              "Both paths resolve to '#{private_path_str}'. " \
+              "The private_output_path is for server-side bundles (e.g., SSR) that should not be served publicly."
+      end
+    end
+
+    def resolve_paths_for_comparison
+      private_full_path = root_path.join(fetch(:private_output_path))
+      public_full_path = root_path.join(fetch(:public_root_path), fetch(:public_output_path))
+
+      # Create directories if they don't exist (for testing)
+      private_full_path.mkpath unless private_full_path.exist?
+      public_full_path.mkpath unless public_full_path.exist?
+
+      # Use realpath to resolve symbolic links and relative paths
+      [private_full_path.realpath.to_s, public_full_path.realpath.to_s]
+    rescue Errno::ENOENT
+      # If paths don't exist yet, fall back to cleanpath for comparison
+      [private_full_path.cleanpath.to_s, public_full_path.cleanpath.to_s]
+    end
+
     def data
       @data ||= load
     end
@@ -110,7 +255,21 @@ class Shakapacker::Configuration
       rescue ArgumentError
         YAML.load_file(config_path.to_s)
       end
-      symbolized_config = config[env].deep_symbolize_keys
+
+      # Try to find environment-specific configuration with fallback
+      # Fallback order: requested env → production
+      if config[env]
+        env_config = config[env]
+      elsif config["production"]
+        log_fallback(env, "production")
+        env_config = config["production"]
+      else
+        # No suitable configuration found - rely on bundled defaults
+        log_fallback(env, "none (will use bundled defaults)")
+        env_config = nil
+      end
+
+      symbolized_config = env_config&.deep_symbolize_keys || {}
 
       return symbolized_config
     rescue Errno::ENOENT => e
@@ -135,7 +294,10 @@ class Shakapacker::Configuration
         rescue ArgumentError
           YAML.load_file(path)
         end
-        HashWithIndifferentAccess.new(config[env] || config[Shakapacker::DEFAULT_ENV])
+        # Load defaults from bundled shakapacker.yml (always has all environments)
+        # Note: This differs from load() which reads user's config and may be missing environments
+        # Fallback to production ensures staging and other custom envs get production-like defaults
+        HashWithIndifferentAccess.new(config[env] || config["production"])
       end
     end
 
@@ -144,4 +306,13 @@ class Shakapacker::Configuration
 
       path
     end
+
+    def log_fallback(requested_env, fallback_env)
+      return unless Shakapacker.logger
+
+      Shakapacker.logger.info(
+        "Shakapacker environment '#{requested_env}' not found in #{config_path}, " \
+        "falling back to '#{fallback_env}'"
+      )
+    end
 end

data/lib/shakapacker/dev_server_runner.rb

@@ -1,11 +1,16 @@
 require "shellwords"
 require "socket"
-require "shakapacker/configuration"
-require "shakapacker/dev_server"
-require "shakapacker/runner"
+
+require_relative "configuration"
+require_relative "dev_server"
+require_relative "runner"
 
 module Shakapacker
   class DevServerRunner < Shakapacker::Runner
+    def self.run(argv)
+      new(argv).run
+    end
+
     def run
       load_config
       detect_unsupported_switches!
@@ -74,12 +79,19 @@ module Shakapacker
           env["NODE_OPTIONS"] = "#{env["NODE_OPTIONS"]} --inspect-brk --trace-warnings"
         end
 
+        # Add config file
         cmd += ["--config", @webpack_config]
-        cmd += ["--progress", "--color"] if @pretty
 
-        # Default behavior of webpack-dev-server is @hot = true
-        cmd += ["--hot", "only"] if @hot == "only"
-        cmd += ["--no-hot"] if !@hot
+        # Add assets bundler-specific flags
+        if webpack?
+          cmd += ["--progress", "--color"] if @pretty
+          # Default behavior of webpack-dev-server is @hot = true
+          cmd += ["--hot", "only"] if @hot == "only"
+          cmd += ["--no-hot"] if !@hot
+        elsif rspack?
+          # Rspack supports --hot but not --no-hot or --progress/--color
+          cmd += ["--hot"] if @hot && @hot != false
+        end
 
         cmd += @argv
 
@@ -89,7 +101,16 @@ module Shakapacker
       end
 
       def build_cmd
-        package_json.manager.native_exec_command("webpack", ["serve"])
+        command = @config.rspack? ? "rspack" : "webpack"
+        package_json.manager.native_exec_command(command, ["serve"])
+      end
+
+      def webpack?
+        @config.webpack?
+      end
+
+      def rspack?
+        @config.rspack?
       end
   end
 end

data/lib/shakapacker/digest_strategy.rb

@@ -1,5 +1,6 @@
 require "digest/sha1"
-require "shakapacker/base_strategy"
+
+require_relative "base_strategy"
 
 module Shakapacker
   class DigestStrategy < BaseStrategy