shakapacker 8.4.0 → 9.0.0.beta.2

data/lib/shakapacker/rspack_runner.rb

@@ -0,0 +1,19 @@
+require "shellwords"
+
+require_relative "runner"
+
+module Shakapacker
+  class RspackRunner < Shakapacker::Runner
+    def self.run(argv)
+      $stdout.sync = true
+      ENV["NODE_ENV"] ||= (ENV["RAILS_ENV"] == "production") ? "production" : "development"
+      new(argv).run
+    end
+
+    private
+
+      def build_cmd
+        package_json.manager.native_exec_command("rspack")
+      end
+  end
+end

data/lib/shakapacker/runner.rb

@@ -1,14 +1,60 @@
 require_relative "utils/misc"
 require_relative "utils/manager"
+require_relative "configuration"
 
 require "package_json"
+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)
@@ -16,7 +62,12 @@ module Shakapacker
 
       @app_path              = File.expand_path(".", Dir.pwd)
       @shakapacker_config    = ENV["SHAKAPACKER_CONFIG"] || File.join(@app_path, "config/shakapacker.yml")
-      @webpack_config        = find_webpack_config
+      @config                = Configuration.new(
+        root_path: Pathname.new(@app_path),
+        config_path: Pathname.new(@shakapacker_config),
+        env: ENV["RAILS_ENV"] || ENV["NODE_ENV"] || "development"
+      )
+      @webpack_config        = find_assets_bundler_config
 
       Shakapacker::Utils::Manager.error_unless_package_manager_is_obvious!
     end
@@ -25,16 +76,105 @@ 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_assets_bundler_config
+        if @config.rspack?
+          find_rspack_config_with_fallback
+        else
+          find_webpack_config
+        end
+      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) }
+        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 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 "[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
+
       def find_webpack_config
         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."
-          exit!
+          $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 = "8.4.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

@@ -1,16 +1,30 @@
 /* eslint global-require: 0 */
 /* eslint import/no-dynamic-require: 0 */
 
-const { existsSync, readdirSync } = require("fs")
 const { basename, dirname, join, relative, resolve } = require("path")
+const { existsSync, readdirSync } = require("fs")
 const extname = require("path-complete-extname")
-// TODO: Change to `const { WebpackAssetsManifest }` when dropping 'webpack-assets-manifest < 6.0.0' (Node >=20.10.0) support
-const WebpackAssetsManifest = require("webpack-assets-manifest")
-const webpack = require("webpack")
-const rules = require("../rules")
 const config = require("../config")
 const { isProduction } = require("../env")
-const { moduleExists } = require("../utils/helpers")
+
+const pluginsPath = resolve(
+  __dirname,
+  "..",
+  "plugins",
+  `${config.assets_bundler}.js`
+)
+const { getPlugins } = require(pluginsPath)
+const rulesPath = resolve(
+  __dirname,
+  "..",
+  "rules",
+  `${config.assets_bundler}.js`
+)
+const rules = require(rulesPath)
+
+// Don't use contentHash except for production for performance
+// https://webpack.js.org/guides/build-performance/#avoid-production-specific-tooling
+const hash = isProduction || config.useContentHash ? "-[contenthash]" : ""
 
 const getFilesInDirectory = (dir, includeNested) => {
   if (!existsSync(dir)) {
@@ -73,63 +87,6 @@ const getModulePaths = () => {
   return result
 }
 
-// TODO: Remove WebpackAssetsManifestConstructor workaround when dropping 'webpack-assets-manifest < 6.0.0' (Node >=20.10.0) support
-const WebpackAssetsManifestConstructor =
-  "WebpackAssetsManifest" in WebpackAssetsManifest
-    ? WebpackAssetsManifest.WebpackAssetsManifest
-    : WebpackAssetsManifest
-const getPlugins = () => {
-  const plugins = [
-    new webpack.EnvironmentPlugin(process.env),
-    new WebpackAssetsManifestConstructor({
-      entrypoints: true,
-      writeToDisk: true,
-      output: config.manifestPath,
-      entrypointsUseAssets: true,
-      publicPath: config.publicPathWithoutCDN,
-      integrity: config.integrity.enabled,
-      integrityHashes: config.integrity.hash_functions
-    })
-  ]
-
-  if (moduleExists("css-loader") && moduleExists("mini-css-extract-plugin")) {
-    const hash = isProduction || config.useContentHash ? "-[contenthash:8]" : ""
-    const MiniCssExtractPlugin = require("mini-css-extract-plugin")
-    plugins.push(
-      new MiniCssExtractPlugin({
-        filename: `css/[name]${hash}.css`,
-        chunkFilename: `css/[id]${hash}.css`,
-        // 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
-      })
-    )
-  }
-
-  if (
-    moduleExists("webpack-subresource-integrity") &&
-    config.integrity.enabled
-  ) {
-    const {
-      SubresourceIntegrityPlugin
-    } = require("webpack-subresource-integrity")
-
-    plugins.push(
-      new SubresourceIntegrityPlugin({
-        hashFuncNames: config.integrity.hash_functions,
-        enabled: isProduction
-      })
-    )
-  }
-
-  return plugins
-}
-
-// Don't use contentHash except for production for performance
-// https://webpack.js.org/guides/build-performance/#avoid-production-specific-tooling
-const hash = isProduction || config.useContentHash ? "-[contenthash]" : ""
-
 module.exports = {
   mode: "production",
   output: {
@@ -160,12 +117,10 @@ module.exports = {
 
   optimization: {
     splitChunks: { chunks: "all" },
-
     runtimeChunk: "single"
   },
 
   module: {
-    strictExportPresence: true,
     rules
   }
 }

data/package/environments/development.js

@@ -1,13 +1,68 @@
 const { merge } = require("webpack-merge")
-
+const config = require("../config")
 const baseConfig = require("./base")
 const webpackDevServerConfig = require("../webpackDevServerConfig")
 const { runningWebpackDevServer } = require("../env")
+const { moduleExists } = require("../utils/helpers")
 
-const devConfig = {
+const baseDevConfig = {
   mode: "development",
-  devtool: "cheap-module-source-map",
-  ...(runningWebpackDevServer && { devServer: webpackDevServerConfig() })
+  devtool: "cheap-module-source-map"
+}
+
+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
 }
 
-module.exports = merge(baseConfig, devConfig)
+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.assets_bundler === "rspack" ? rspackDevConfig() : webpackDevConfig()
+
+module.exports = merge(baseConfig, bundlerConfig)

data/package/environments/production.js

@@ -1,47 +1,50 @@
 /* eslint global-require: 0 */
 /* eslint import/no-dynamic-require: 0 */
 
+const { resolve } = require("path")
 const { merge } = require("webpack-merge")
-const CompressionPlugin = require("compression-webpack-plugin")
-const TerserPlugin = require("terser-webpack-plugin")
 const baseConfig = require("./base")
 const { moduleExists } = require("../utils/helpers")
 const config = require("../config")
 
+const optimizationPath = resolve(
+  __dirname,
+  "..",
+  "optimization",
+  `${config.assets_bundler}.js`
+)
+const { getOptimization } = require(optimizationPath)
+
+let CompressionPlugin = null
+if (moduleExists("compression-webpack-plugin")) {
+  // eslint-disable-next-line global-require
+  CompressionPlugin = require("compression-webpack-plugin")
+}
+
 const getPlugins = () => {
   const plugins = []
 
-  plugins.push(
-    new CompressionPlugin({
-      filename: "[path][base].gz[query]",
-      algorithm: "gzip",
-      test: /\.(js|css|html|json|ico|svg|eot|otf|ttf|map)$/
-    })
-  )
-
-  if ("brotli" in process.versions) {
+  if (CompressionPlugin) {
     plugins.push(
       new CompressionPlugin({
-        filename: "[path][base].br[query]",
-        algorithm: "brotliCompress",
+        filename: "[path][base].gz[query]",
+        algorithm: "gzip",
         test: /\.(js|css|html|json|ico|svg|eot|otf|ttf|map)$/
       })
     )
-  }
 
-  return plugins
-}
-
-const tryCssMinimizer = () => {
-  if (
-    moduleExists("css-loader") &&
-    moduleExists("css-minimizer-webpack-plugin")
-  ) {
-    const CssMinimizerPlugin = require("css-minimizer-webpack-plugin")
-    return new CssMinimizerPlugin()
+    if ("brotli" in process.versions) {
+      plugins.push(
+        new CompressionPlugin({
+          filename: "[path][base].br[query]",
+          algorithm: "brotliCompress",
+          test: /\.(js|css|html|json|ico|svg|eot|otf|ttf|map)$/
+        })
+      )
+    }
   }
 
-  return null
+  return plugins
 }
 
 const productionConfig = {
@@ -49,32 +52,7 @@ const productionConfig = {
   stats: "normal",
   bail: true,
   plugins: getPlugins(),
-  optimization: {
-    minimizer: [
-      tryCssMinimizer(),
-      new TerserPlugin({
-        parallel: Number.parseInt(process.env.SHAKAPACKER_PARALLEL, 10) || true,
-        terserOptions: {
-          parse: {
-            // Let terser parse ecma 8 code but always output
-            // ES5 compliant code for older browsers
-            ecma: 8
-          },
-          compress: {
-            ecma: 5,
-            warnings: false,
-            comparisons: false
-          },
-          mangle: { safari10: true },
-          output: {
-            ecma: 5,
-            comments: false,
-            ascii_only: true
-          }
-        }
-      })
-    ].filter(Boolean)
-  }
+  optimization: getOptimization()
 }
 
 if (config.useContentHash === false) {

data/package/environments/test.js

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