shakapacker 9.0.0.beta.0 → 9.0.0.beta.2

data/lib/shakapacker/rspack_runner.rb

@@ -4,48 +4,10 @@ require_relative "runner"
 
 module Shakapacker
   class RspackRunner < Shakapacker::Runner
-    RSPACK_COMMANDS = [
-      "help",
-      "h",
-      "--help",
-      "-h",
-      "version",
-      "v",
-      "--version",
-      "-v",
-      "info",
-      "i"
-    ].freeze
-
-    def run
-      env = Shakapacker::Compiler.env
-      env["SHAKAPACKER_CONFIG"] = @shakapacker_config
-      env["NODE_OPTIONS"] = ENV["NODE_OPTIONS"] || ""
-
-      cmd = build_cmd
-
-      if @argv.delete("--debug-shakapacker")
-        env["NODE_OPTIONS"] = "#{env["NODE_OPTIONS"]} --inspect-brk"
-      end
-
-      if @argv.delete "--trace-deprecation"
-        env["NODE_OPTIONS"] = "#{env["NODE_OPTIONS"]} --trace-deprecation"
-      end
-
-      if @argv.delete "--no-deprecation"
-        env["NODE_OPTIONS"] = "#{env["NODE_OPTIONS"]} --no-deprecation"
-      end
-
-      # Rspack commands are not compatible with --config option.
-      if (@argv & RSPACK_COMMANDS).empty?
-        cmd += ["--config", @webpack_config]
-      end
-
-      cmd += @argv
-
-      Dir.chdir(@app_path) do
-        Kernel.exec env, *cmd
-      end
+    def self.run(argv)
+      $stdout.sync = true
+      ENV["NODE_ENV"] ||= (ENV["RAILS_ENV"] == "production") ? "production" : "development"
+      new(argv).run
     end
 
     private

data/lib/shakapacker/runner.rb

@@ -7,10 +7,54 @@ require "pathname"
 
 module Shakapacker
   class Runner
+    attr_reader :config
+
+    # Common commands that don't work with --config option
+    BASE_COMMANDS = [
+      "help",
+      "h",
+      "--help",
+      "-h",
+      "version",
+      "v",
+      "--version",
+      "-v",
+      "info",
+      "i"
+    ].freeze
     def self.run(argv)
       $stdout.sync = true
       ENV["NODE_ENV"] ||= (ENV["RAILS_ENV"] == "production") ? "production" : "development"
-      new(argv).run
+
+      # Create a single runner instance to avoid loading configuration twice.
+      # We extend it with the appropriate build command based on the bundler type.
+      runner = new(argv)
+
+      if runner.config.rspack?
+        require_relative "rspack_runner"
+        # Extend the runner instance with rspack-specific methods
+        # This avoids creating a new RspackRunner which would reload the configuration
+        runner.extend(Module.new do
+          def build_cmd
+            package_json.manager.native_exec_command("rspack")
+          end
+
+          def assets_bundler_commands
+            BASE_COMMANDS + %w[build watch]
+          end
+        end)
+        runner.run
+      else
+        require_relative "webpack_runner"
+        # Extend the runner instance with webpack-specific methods
+        # This avoids creating a new WebpackRunner which would reload the configuration
+        runner.extend(Module.new do
+          def build_cmd
+            package_json.manager.native_exec_command("webpack")
+          end
+        end)
+        runner.run
+      end
     end
 
     def initialize(argv)
@@ -23,7 +67,7 @@ module Shakapacker
         config_path: Pathname.new(@shakapacker_config),
         env: ENV["RAILS_ENV"] || ENV["NODE_ENV"] || "development"
       )
-      @webpack_config        = find_bundler_config
+      @webpack_config        = find_assets_bundler_config
 
       Shakapacker::Utils::Manager.error_unless_package_manager_is_obvious!
     end
@@ -32,8 +76,55 @@ module Shakapacker
       @package_json ||= PackageJson.read(@app_path)
     end
 
+    def run
+      puts "[Shakapacker] Preparing environment for assets bundler execution..."
+      env = Shakapacker::Compiler.env
+      env["SHAKAPACKER_CONFIG"] = @shakapacker_config
+      env["NODE_OPTIONS"] = ENV["NODE_OPTIONS"] || ""
+
+      cmd = build_cmd
+      puts "[Shakapacker] Base command: #{cmd.join(" ")}"
+
+      if @argv.delete("--debug-shakapacker")
+        puts "[Shakapacker] Debug mode enabled (--debug-shakapacker)"
+        env["NODE_OPTIONS"] = "#{env["NODE_OPTIONS"]} --inspect-brk"
+      end
+
+      if @argv.delete "--trace-deprecation"
+        puts "[Shakapacker] Trace deprecation enabled (--trace-deprecation)"
+        env["NODE_OPTIONS"] = "#{env["NODE_OPTIONS"]} --trace-deprecation"
+      end
+
+      if @argv.delete "--no-deprecation"
+        puts "[Shakapacker] Deprecation warnings disabled (--no-deprecation)"
+        env["NODE_OPTIONS"] = "#{env["NODE_OPTIONS"]} --no-deprecation"
+      end
+
+      # Commands are not compatible with --config option.
+      if (@argv & assets_bundler_commands).empty?
+        puts "[Shakapacker] Adding config file: #{@webpack_config}"
+        cmd += ["--config", @webpack_config]
+      else
+        puts "[Shakapacker] Skipping config file (running assets bundler command: #{(@argv & assets_bundler_commands).join(", ")})"
+      end
+
+      cmd += @argv
+      puts "[Shakapacker] Final command: #{cmd.join(" ")}"
+      puts "[Shakapacker] Working directory: #{@app_path}"
+
+      Dir.chdir(@app_path) do
+        Kernel.exec env, *cmd
+      end
+    end
+
+    protected
+
+      def assets_bundler_commands
+        BASE_COMMANDS
+      end
+
     private
-      def find_bundler_config
+      def find_assets_bundler_config
         if @config.rspack?
           find_rspack_config_with_fallback
         else
@@ -41,34 +132,35 @@ module Shakapacker
         end
       end
 
-      def get_bundler_type
-        @config.bundler
-      end
-
       def find_rspack_config_with_fallback
         # First try rspack-specific paths
         rspack_paths = %w[ts js].map do |ext|
           File.join(@app_path, "config/rspack/rspack.config.#{ext}")
         end
 
+        puts "[Shakapacker] Looking for Rspack config in: #{rspack_paths.join(", ")}"
         rspack_path = rspack_paths.find { |f| File.exist?(f) }
-        return rspack_path if rspack_path
+        if rspack_path
+          puts "[Shakapacker] Found Rspack config: #{rspack_path}"
+          return rspack_path
+        end
 
         # Fallback to webpack config with deprecation warning
         webpack_paths = %w[ts js].map do |ext|
           File.join(@app_path, "config/webpack/webpack.config.#{ext}")
         end
 
+        puts "[Shakapacker] Rspack config not found, checking for webpack config fallback..."
         webpack_path = webpack_paths.find { |f| File.exist?(f) }
         if webpack_path
-          $stderr.puts "⚠️  DEPRECATION WARNING: Using webpack config file for Rspack bundler."
+          $stderr.puts "⚠️  DEPRECATION WARNING: Using webpack config file for Rspack assets bundler."
           $stderr.puts "   Please create config/rspack/rspack.config.js and migrate your configuration."
           $stderr.puts "   Using: #{webpack_path}"
           return webpack_path
         end
 
         # No config found
-        $stderr.puts "rspack config #{rspack_paths.last} not found, please run 'bundle exec rails shakapacker:install' to install Shakapacker with default configs or create the missing config file."
+        $stderr.puts "[Shakapacker] ERROR: rspack config #{rspack_paths.last} not found, please run 'bundle exec rails shakapacker:install' to install Shakapacker with default configs or create the missing config file."
         exit(1)
       end
 
@@ -76,11 +168,13 @@ module Shakapacker
         possible_paths = %w[ts js].map do |ext|
           File.join(@app_path, "config/webpack/webpack.config.#{ext}")
         end
+        puts "[Shakapacker] Looking for Webpack config in: #{possible_paths.join(", ")}"
         path = possible_paths.find { |f| File.exist?(f) }
         unless path
-          $stderr.puts "webpack config #{possible_paths.last} not found, please run 'bundle exec rails shakapacker:install' to install Shakapacker with default configs or add the missing config file for your custom environment."
+          $stderr.puts "[Shakapacker] ERROR: webpack config #{possible_paths.last} not found, please run 'bundle exec rails shakapacker:install' to install Shakapacker with default configs or add the missing config file for your custom environment."
           exit(1)
         end
+        puts "[Shakapacker] Found Webpack config: #{path}"
         path
       end
   end

data/lib/shakapacker/utils/manager.rb

@@ -58,6 +58,8 @@ module Shakapacker
         def self.rails_root
           if defined?(APP_ROOT)
             Pathname.new(APP_ROOT)
+          elsif ENV["APP_ROOT"]
+            Pathname.new(ENV["APP_ROOT"])
           elsif defined?(Rails)
             Rails.root
           else

data/lib/shakapacker/version.rb

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

data/lib/shakapacker/version_checker.rb

@@ -126,7 +126,7 @@ module Shakapacker
           end
 
           def relative_path?
-            raw.match(%r{(\.\.|\Afile:///)}).present?
+            raw.match(%r{(\.\.|\Afile:)}).present?
           end
 
           def git_url?

data/lib/shakapacker/webpack_runner.rb

@@ -4,48 +4,10 @@ require_relative "runner"
 
 module Shakapacker
   class WebpackRunner < Shakapacker::Runner
-    WEBPACK_COMMANDS = [
-      "help",
-      "h",
-      "--help",
-      "-h",
-      "version",
-      "v",
-      "--version",
-      "-v",
-      "info",
-      "i"
-    ].freeze
-
-    def run
-      env = Shakapacker::Compiler.env
-      env["SHAKAPACKER_CONFIG"] = @shakapacker_config
-      env["NODE_OPTIONS"] = ENV["NODE_OPTIONS"] || ""
-
-      cmd = build_cmd
-
-      if @argv.delete("--debug-shakapacker")
-        env["NODE_OPTIONS"] = "#{env["NODE_OPTIONS"]} --inspect-brk"
-      end
-
-      if @argv.delete "--trace-deprecation"
-        env["NODE_OPTIONS"] = "#{env["NODE_OPTIONS"]} --trace-deprecation"
-      end
-
-      if @argv.delete "--no-deprecation"
-        env["NODE_OPTIONS"] = "#{env["NODE_OPTIONS"]} --no-deprecation"
-      end
-
-      # Webpack commands are not compatible with --config option.
-      if (@argv & WEBPACK_COMMANDS).empty?
-        cmd += ["--config", @webpack_config]
-      end
-
-      cmd += @argv
-
-      Dir.chdir(@app_path) do
-        Kernel.exec env, *cmd
-      end
+    def self.run(argv)
+      $stdout.sync = true
+      ENV["NODE_ENV"] ||= (ENV["RAILS_ENV"] == "production") ? "production" : "development"
+      new(argv).run
     end
 
     private

data/lib/tasks/shakapacker/install.rake

@@ -2,10 +2,14 @@ install_template_path = File.expand_path("../../install/template.rb", __dir__).f
 bin_path = ENV["BUNDLE_BIN"] || Rails.root.join("bin")
 
 namespace :shakapacker do
-  desc "Install Shakapacker in this application"
-  task install: [:check_node] do |task|
+  desc "Install Shakapacker in this application (use ASSETS_BUNDLER=rspack for Rspack)"
+  task :install, [:bundler] => [:check_node] do |task, args|
     Shakapacker::Configuration.installing = true
 
+    if args[:bundler] == "rspack" || ENV["ASSETS_BUNDLER"] == "rspack"
+      ENV["SHAKAPACKER_ASSETS_BUNDLER"] = "rspack"
+    end
+
     prefix = task.name.split(/#|shakapacker:install/).first
 
     if Rails::VERSION::MAJOR >= 5

data/package/config.js

@@ -53,4 +53,28 @@ if (config.manifest_path) {
 // Ensure no duplicate hash functions exist in the returned config object
 config.integrity.hash_functions = [...new Set(config.integrity.hash_functions)]
 
+// Allow ENV variable to override assets_bundler
+if (process.env.SHAKAPACKER_ASSETS_BUNDLER) {
+  config.assets_bundler = process.env.SHAKAPACKER_ASSETS_BUNDLER
+}
+
+// Define clear defaults
+const DEFAULT_JAVASCRIPT_TRANSPILER =
+  config.assets_bundler === "rspack" ? "swc" : "babel"
+
+// Backward compatibility: Add webpack_loader property that maps to javascript_transpiler
+// Show deprecation warning if webpack_loader is used
+if (config.webpack_loader && !config.javascript_transpiler) {
+  console.warn(
+    "⚠️  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."
+  )
+  config.javascript_transpiler = config.webpack_loader
+} else if (!config.javascript_transpiler) {
+  config.javascript_transpiler =
+    config.webpack_loader || DEFAULT_JAVASCRIPT_TRANSPILER
+}
+
+// Ensure webpack_loader is always available for backward compatibility
+config.webpack_loader = config.javascript_transpiler
+
 module.exports = config

data/package/environments/base.js

@@ -7,9 +7,19 @@ const extname = require("path-complete-extname")
 const config = require("../config")
 const { isProduction } = require("../env")
 
-const pluginsPath = resolve(__dirname, "..", "plugins", `${config.bundler}.js`)
+const pluginsPath = resolve(
+  __dirname,
+  "..",
+  "plugins",
+  `${config.assets_bundler}.js`
+)
 const { getPlugins } = require(pluginsPath)
-const rulesPath = resolve(__dirname, "..", "rules", `${config.bundler}.js`)
+const rulesPath = resolve(
+  __dirname,
+  "..",
+  "rules",
+  `${config.assets_bundler}.js`
+)
 const rules = require(rulesPath)
 
 // Don't use contentHash except for production for performance

data/package/environments/development.js

@@ -3,26 +3,66 @@ const config = require("../config")
 const baseConfig = require("./base")
 const webpackDevServerConfig = require("../webpackDevServerConfig")
 const { runningWebpackDevServer } = require("../env")
+const { moduleExists } = require("../utils/helpers")
 
-const webpackDevConfig = {
+const baseDevConfig = {
   mode: "development",
-  devtool: "cheap-module-source-map",
-  ...(runningWebpackDevServer && { devServer: webpackDevServerConfig() })
+  devtool: "cheap-module-source-map"
 }
 
-const rspackDevConfig = {
-  mode: "development",
-  devtool: "cheap-module-source-map",
-  // Force writing assets to disk in development for Rails compatibility
-  devServer: {
-    ...webpackDevServerConfig(),
-    devMiddleware: {
-      writeToDisk: true
+const webpackDevConfig = () => {
+  const webpackConfig = {
+    ...baseDevConfig,
+    ...(runningWebpackDevServer && { devServer: webpackDevServerConfig() })
+  }
+
+  const devServerConfig = webpackDevServerConfig()
+  if (
+    runningWebpackDevServer &&
+    devServerConfig.hot &&
+    moduleExists("@pmmmwh/react-refresh-webpack-plugin")
+  ) {
+    // eslint-disable-next-line global-require
+    const ReactRefreshWebpackPlugin = require("@pmmmwh/react-refresh-webpack-plugin")
+    webpackConfig.plugins = [
+      ...(webpackConfig.plugins || []),
+      new ReactRefreshWebpackPlugin()
+    ]
+  }
+
+  return webpackConfig
+}
+
+const rspackDevConfig = () => {
+  const devServerConfig = webpackDevServerConfig()
+  const rspackConfig = {
+    ...baseDevConfig,
+    devServer: {
+      ...devServerConfig,
+      devMiddleware: {
+        ...devServerConfig.devMiddleware,
+        writeToDisk: (filePath) => !filePath.includes(".hot-update.")
+      }
     }
   }
+
+  if (
+    runningWebpackDevServer &&
+    devServerConfig.hot &&
+    moduleExists("@rspack/plugin-react-refresh")
+  ) {
+    // eslint-disable-next-line global-require
+    const ReactRefreshPlugin = require("@rspack/plugin-react-refresh")
+    rspackConfig.plugins = [
+      ...(rspackConfig.plugins || []),
+      new ReactRefreshPlugin()
+    ]
+  }
+
+  return rspackConfig
 }
 
 const bundlerConfig =
-  config.bundler === "rspack" ? rspackDevConfig : webpackDevConfig
+  config.assets_bundler === "rspack" ? rspackDevConfig() : webpackDevConfig()
 
 module.exports = merge(baseConfig, bundlerConfig)

data/package/environments/production.js

@@ -1,14 +1,19 @@
 /* eslint global-require: 0 */
 /* eslint import/no-dynamic-require: 0 */
 
-const { merge } = require("webpack-merge")
 const { resolve } = require("path")
+const { merge } = require("webpack-merge")
 const baseConfig = require("./base")
 const { moduleExists } = require("../utils/helpers")
 const config = require("../config")
 
-const path = resolve(__dirname, "..", "optimization", `${config.bundler}.js`)
-const { getOptimization } = require(path)
+const optimizationPath = resolve(
+  __dirname,
+  "..",
+  "optimization",
+  `${config.assets_bundler}.js`
+)
+const { getOptimization } = require(optimizationPath)
 
 let CompressionPlugin = null
 if (moduleExists("compression-webpack-plugin")) {

data/package/environments/test.js

@@ -2,16 +2,18 @@ const { merge } = require("webpack-merge")
 const config = require("../config")
 const baseConfig = require("./base")
 
-const rspackTestConfig = {
+const rspackTestConfig = () => ({
   mode: "development",
   devtool: "cheap-module-source-map",
   // Disable file watching in test mode
   watchOptions: {
     ignored: /node_modules/
   }
-}
+})
+
+const webpackTestConfig = () => ({})
 
 const bundlerConfig =
-  config.bundler === "rspack" ? rspackTestConfig : baseConfig
+  config.assets_bundler === "rspack" ? rspackTestConfig() : webpackTestConfig()
 
 module.exports = merge(baseConfig, bundlerConfig)

data/package/index.d.ts

@@ -1,6 +1,6 @@
-declare module 'shakapacker' {
-  import { Configuration, RuleSetRule } from 'webpack'
-  import * as https from 'node:https';
+declare module "shakapacker" {
+  import { Configuration, RuleSetRule } from "webpack"
+  import * as https from "node:https"
 
   export interface Config {
     source_path: string
@@ -14,11 +14,11 @@ declare module 'shakapacker' {
     shakapacker_precompile: boolean
     additional_paths: string[]
     cache_manifest: boolean
-    webpack_loader: string
+    javascript_transpiler: string
     ensure_consistent_versioning: boolean
     compiler_strategy: string
     useContentHash: boolean
-    compile: boolean,
+    compile: boolean
     outputPath: string
     publicPath: string
     publicPathWithoutCDN: string
@@ -33,9 +33,11 @@ declare module 'shakapacker' {
     runningWebpackDevServer: boolean
   }
 
-  type Header = Array<{ key: string; value: string }> | Record<string, string | string[]>
-  type ServerType = 'http' | 'https' | 'spdy'
-  type WebSocketType = 'sockjs' | 'ws'
+  type Header =
+    | Array<{ key: string; value: string }>
+    | Record<string, string | string[]>
+  type ServerType = "http" | "https" | "spdy"
+  type WebSocketType = "sockjs" | "ws"
 
   /**
    * This has the same keys and behavior as https://webpack.js.org/configuration/dev-server/ except:
@@ -44,59 +46,85 @@ declare module 'shakapacker' {
    * @see {import('webpack-dev-server').Configuration}
    */
   interface DevServerConfig {
-    allowed_hosts?: 'all' | 'auto' | string | string[]
+    allowed_hosts?: "all" | "auto" | string | string[]
     bonjour?: boolean | Record<string, unknown> // bonjour.BonjourOptions
     client?: Record<string, unknown> // Client
     compress?: boolean
     dev_middleware?: Record<string, unknown> // webpackDevMiddleware.Options
     headers?: Header | (() => Header)
     history_api_fallback?: boolean | Record<string, unknown> // HistoryApiFallbackOptions
-    hmr?: 'only' | boolean
-    host?: 'local-ip' | 'local-ipv4' | 'local-ipv6' | string
+    hmr?: "only" | boolean
+    host?: "local-ip" | "local-ipv4" | "local-ipv6" | string
     http2?: boolean
     https?: boolean | https.ServerOptions
     ipc?: boolean | string
     magic_html?: boolean
     live_reload?: boolean
-    open?: boolean | string | string[] | Record<string, unknown> | Record<string, unknown>[]
-    port?: 'auto' | string | number
+    open?:
+      | boolean
+      | string
+      | string[]
+      | Record<string, unknown>
+      | Record<string, unknown>[]
+    port?: "auto" | string | number
     proxy?: unknown // ProxyConfigMap | ProxyConfigArray
     setup_exit_signals?: boolean
     static?: boolean | string | unknown // Static | Array<string | Static>
     watch_files?: string | string[] | unknown // WatchFiles | Array<WatchFiles | string>
-    web_socket_server?: string | boolean | WebSocketType | { type?: string | boolean | WebSocketType, options?: Record<string, unknown> }
-    server?: string | boolean | ServerType | { type?: string | boolean | ServerType, options?: https.ServerOptions }
+    web_socket_server?:
+      | string
+      | boolean
+      | WebSocketType
+      | {
+          type?: string | boolean | WebSocketType
+          options?: Record<string, unknown>
+        }
+    server?:
+      | string
+      | boolean
+      | ServerType
+      | { type?: string | boolean | ServerType; options?: https.ServerOptions }
     [otherWebpackDevServerConfigKey: string]: unknown
   }
 
   export const config: Config
   export const devServer: DevServerConfig
-  export function generateWebpackConfig(extraConfig?: Configuration): Configuration
+  export function generateWebpackConfig(
+    extraConfig?: Configuration
+  ): Configuration
   export const baseConfig: Configuration
   export const env: Env
   export const rules: RuleSetRule[]
   export function moduleExists(packageName: string): boolean
-  export function canProcess<T = unknown>(rule: string, fn: (modulePath: string) => T): T | null
+  export function canProcess<T = unknown>(
+    rule: string,
+    fn: (modulePath: string) => T
+  ): T | null
   export const inliningCss: boolean
-  export * from 'webpack-merge'
+  export * from "webpack-merge"
 }
 
-declare module 'shakapacker/rspack' {
-  import type { RspackOptions, RuleSetRule } from '@rspack/core'
-  
-  export const config: Config
-  export function generateRspackConfig(extraConfig?: RspackOptions): RspackOptions
+declare module "shakapacker/rspack" {
+  import type { RspackOptions } from "@rspack/core"
+
+  export const config: import("shakapacker").Config
+  export function generateRspackConfig(
+    extraConfig?: RspackOptions
+  ): RspackOptions
   export const baseConfig: RspackOptions
-  export const env: Env
-  export const rules: RuleSetRule[]
+  export const env: import("shakapacker").Env
+  export const rules: NonNullable<RspackOptions["module"]>["rules"]
   export function moduleExists(packageName: string): boolean
-  export function canProcess<T = unknown>(rule: string, fn: (modulePath: string) => T): T | null
+  export function canProcess<T = unknown>(
+    rule: string,
+    fn: (modulePath: string) => T
+  ): T | null
   export const inliningCss: boolean
-  export * from 'webpack-merge'
+  export * from "webpack-merge"
 }
 
-declare module 'shakapacker/package/babel/preset.js' {
-  import { ConfigAPI, PluginItem, TransformOptions } from '@babel/core'
+declare module "shakapacker/package/babel/preset.js" {
+  import { ConfigAPI, PluginItem, TransformOptions } from "@babel/core"
 
   interface RequiredTransformOptions {
     plugins: PluginItem[]

data/package/index.js

@@ -7,7 +7,7 @@ const { existsSync } = require("fs")
 const config = require("./config")
 const baseConfig = require("./environments/base")
 
-const rulesPath = resolve(__dirname, "rules", `${config.bundler}.js`)
+const rulesPath = resolve(__dirname, "rules", `${config.assets_bundler}.js`)
 const rules = require(rulesPath)
 const devServer = require("./dev_server")
 const env = require("./env")