shakapacker 8.4.0 → 9.0.0

data/lib/shakapacker/manifest.rb

@@ -108,15 +108,17 @@ class Shakapacker::Manifest
     end
 
     def missing_file_from_manifest_error(bundle_name)
+      bundler_name = config.assets_bundler
       <<-MSG
 Shakapacker can't find #{bundle_name} in #{config.manifest_path}. Possible causes:
 1. You forgot to install javascript packages or are running an incompatible javascript runtime version
 2. Your app has code with a non-standard extension (like a `.jsx` file) but the extension is not in the `extensions` config in `config/shakapacker.yml`
 3. You have set compile: false (see `config/shakapacker.yml`) for this environment
    (unless you are using the `bin/shakapacker -w` or the `bin/shakapacker-dev-server`, in which case maybe you aren't running the dev server in the background?)
-4. webpack has not yet FINISHED running to reflect updates.
+4. Your #{bundler_name} has not yet FINISHED running to reflect updates.
 5. You have misconfigured Shakapacker's `config/shakapacker.yml` file.
-6. Your webpack configuration is not creating a manifest.
+6. Your #{bundler_name} configuration is not creating a manifest with the expected structure.
+7. Ensure the 'assets_bundler' in config/shakapacker.yml is set correctly (currently: #{bundler_name}).
 
 Your manifest contains:
 #{JSON.pretty_generate(@data)}

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/swc_migrator.rb

@@ -0,0 +1,376 @@
+require "yaml"
+require "json"
+require "fileutils"
+require "logger"
+require "pathname"
+
+module Shakapacker
+  class SwcMigrator
+    attr_reader :root_path, :logger
+
+    # Babel packages safe to remove when migrating to SWC
+    # Note: @babel/core and @babel/eslint-parser are excluded as they may be needed for ESLint
+    BABEL_PACKAGES = [
+      "@babel/plugin-proposal-class-properties",
+      "@babel/plugin-proposal-object-rest-spread",
+      "@babel/plugin-syntax-dynamic-import",
+      "@babel/plugin-transform-destructuring",
+      "@babel/plugin-transform-regenerator",
+      "@babel/plugin-transform-runtime",
+      "@babel/preset-env",
+      "@babel/preset-react",
+      "@babel/preset-typescript",
+      "@babel/runtime",
+      "babel-loader",
+      "babel-plugin-macros",
+      "babel-plugin-transform-react-remove-prop-types"
+    ].freeze
+
+    # Babel packages that may be needed for ESLint - only remove if user explicitly confirms
+    ESLINT_BABEL_PACKAGES = [
+      "@babel/core",
+      "@babel/eslint-parser"
+    ].freeze
+
+    SWC_PACKAGES = {
+      "@swc/core" => "^1.7.39",
+      "swc-loader" => "^0.2.6"
+    }.freeze
+
+    ESLINT_CONFIG_FILES = %w[
+      .eslintrc
+      .eslintrc.js
+      .eslintrc.cjs
+      .eslintrc.yaml
+      .eslintrc.yml
+      .eslintrc.json
+    ].freeze
+
+    DEFAULT_SWC_CONFIG = <<~JS.freeze
+      // config/swc.config.js
+      // This file is merged with Shakapacker's default SWC configuration
+      // See: https://swc.rs/docs/configuration/compilation
+
+      module.exports = {
+        jsc: {
+          transform: {
+            react: {
+              runtime: "automatic"
+            }
+          }
+        }
+      }
+    JS
+
+    def initialize(root_path, logger: nil)
+      @root_path = Pathname.new(root_path)
+      @logger = logger || Logger.new($stdout)
+    end
+
+    def migrate_to_swc(run_installer: true)
+      logger.info "🔄 Starting migration from Babel to SWC..."
+
+      results = {
+        config_updated: update_shakapacker_config,
+        packages_installed: install_swc_packages,
+        swc_config_created: create_swc_config,
+        babel_packages_found: find_babel_packages
+      }
+
+      logger.info "🎉 Migration to SWC complete!"
+      logger.info "   Note: SWC is approximately 20x faster than Babel for transpilation."
+      logger.info "   Please test your application thoroughly after migration."
+      logger.info "\n📝 Configuration Info:"
+      logger.info "   - config/swc.config.js is merged with Shakapacker's default SWC configuration"
+      logger.info "   - You can customize config/swc.config.js to add additional options"
+      logger.info "   - Avoid using .swcrc as it overrides Shakapacker defaults completely"
+
+      # Show cleanup recommendations if babel packages found
+      if results[:babel_packages_found].any?
+        logger.info "\n🧹 Cleanup Recommendations:"
+        logger.info "   Found the following Babel packages in your package.json:"
+        results[:babel_packages_found].each do |package|
+          logger.info "   - #{package}"
+        end
+        logger.info "\n   To remove them, run:"
+        logger.info "   rails shakapacker:clean_babel_packages"
+      end
+
+      # Suggest running doctor to verify configuration
+      logger.info "\n🩺 Run 'rails shakapacker:doctor' to verify your configuration"
+
+      # Run package manager install if packages were added
+      if run_installer && results[:packages_installed].any?
+        run_package_manager_install
+      end
+
+      results
+    end
+
+    def clean_babel_packages(run_installer: true)
+      logger.info "🧹 Removing Babel packages..."
+
+      package_json_path = root_path.join("package.json")
+      unless package_json_path.exist?
+        logger.error "❌ No package.json found"
+        return { removed_packages: [], config_files_deleted: [], preserved_packages: [] }
+      end
+
+      # Check if ESLint uses Babel parser
+      preserved_for_eslint = []
+      if eslint_uses_babel?
+        logger.info "\n⚠️  ESLint configuration detected that uses Babel parser"
+        logger.info "   Preserving @babel/core and @babel/eslint-parser for ESLint compatibility"
+        logger.info "   To switch ESLint parser:"
+        logger.info "   1. For TypeScript: use @typescript-eslint/parser"
+        logger.info "   2. For JavaScript: use espree (ESLint's default parser)"
+        preserved_for_eslint = ESLINT_BABEL_PACKAGES
+      end
+
+      removed_packages = remove_babel_from_package_json(package_json_path, preserve: preserved_for_eslint)
+      deleted_files = delete_babel_config_files
+
+      if removed_packages.any?
+        logger.info "✅ Babel packages removed successfully!"
+        run_package_manager_install if run_installer
+      else
+        logger.info "ℹ️  No Babel packages found to remove"
+      end
+
+      { removed_packages: removed_packages, config_files_deleted: deleted_files, preserved_packages: preserved_for_eslint }
+    end
+
+    def find_babel_packages
+      package_json_path = root_path.join("package.json")
+      return [] unless package_json_path.exist?
+
+      begin
+        package_json = JSON.parse(File.read(package_json_path))
+        dependencies = package_json["dependencies"] || {}
+        dev_dependencies = package_json["devDependencies"] || {}
+        all_deps = dependencies.merge(dev_dependencies)
+
+        # Find all babel packages (including ESLint-related ones for display)
+        all_babel_packages = BABEL_PACKAGES + ESLINT_BABEL_PACKAGES
+        found_packages = all_babel_packages.select { |pkg| all_deps.key?(pkg) }
+        found_packages
+      rescue JSON::ParserError => e
+        logger.error "Failed to parse package.json: #{e.message}"
+        []
+      end
+    end
+
+    private
+
+      def eslint_uses_babel?
+        # Check for ESLint config files
+        # Note: This is a heuristic check that may have false positives (e.g., in comments),
+        # but false positives only result in an extra warning, which is safer than silently
+        # breaking ESLint configurations.
+        ESLINT_CONFIG_FILES.each do |config_file|
+          config_path = root_path.join(config_file)
+          next unless config_path.exist?
+
+          content = File.read(config_path)
+          # Check for Babel parser references
+          return true if content.match?(/@babel\/eslint-parser|babel-eslint/)
+        end
+
+        # Check package.json for eslintConfig
+        package_json_path = root_path.join("package.json")
+        if package_json_path.exist?
+          begin
+            package_json = JSON.parse(File.read(package_json_path))
+            if package_json["eslintConfig"]
+              # Check parser field explicitly
+              parser = package_json["eslintConfig"]["parser"]
+              return true if parser && parser.match?(/@babel\/eslint-parser|babel-eslint/)
+
+              # Also check entire config for babel parser references (catches nested configs)
+              return true if package_json["eslintConfig"].to_json.match?(/@babel\/eslint-parser|babel-eslint/)
+            end
+
+            # Check if Babel ESLint packages are installed
+            dependencies = package_json["dependencies"] || {}
+            dev_dependencies = package_json["devDependencies"] || {}
+            all_deps = dependencies.merge(dev_dependencies)
+            return true if all_deps.key?("@babel/eslint-parser") || all_deps.key?("babel-eslint")
+          rescue JSON::ParserError => e
+            logger.debug "Could not parse package.json for ESLint detection: #{e.message}"
+          end
+        end
+
+        false
+      end
+
+      def update_shakapacker_config
+        config_path = root_path.join("config/shakapacker.yml")
+        return false unless config_path.exist?
+
+        logger.info "📝 Updating shakapacker.yml..."
+        config = begin
+          YAML.load_file(config_path, aliases: true)
+        rescue ArgumentError
+          YAML.load_file(config_path)
+        end
+
+        config.each do |env, settings|
+          next unless settings.is_a?(Hash)
+
+          if settings["babel"]
+            logger.info "  - Removing babel config from #{env} environment"
+            settings.delete("babel")
+          end
+
+          settings["swc"] = true
+          logger.info "  - Enabled SWC for #{env} environment"
+        end
+
+        File.write(config_path, config.to_yaml)
+        logger.info "✅ shakapacker.yml updated"
+        true
+      rescue StandardError => e
+        logger.error "Failed to update config: #{e.message}"
+        false
+      end
+
+      def install_swc_packages
+        package_json_path = root_path.join("package.json")
+        return {} unless package_json_path.exist?
+
+        logger.info "📦 Installing SWC dependencies..."
+        package_json = JSON.parse(File.read(package_json_path))
+
+        dependencies = package_json["dependencies"] || {}
+        dev_dependencies = package_json["devDependencies"] || {}
+        installed = {}
+
+        SWC_PACKAGES.each do |package, version|
+          unless dependencies[package] || dev_dependencies[package]
+            logger.info "  - Adding #{package}@#{version}"
+            dev_dependencies[package] = version
+            installed[package] = version
+          else
+            logger.info "  - #{package} already installed"
+          end
+        end
+
+        if installed.any?
+          package_json["devDependencies"] = dev_dependencies
+          File.write(package_json_path, JSON.pretty_generate(package_json) + "\n")
+          logger.info "✅ package.json updated with SWC dependencies"
+        end
+
+        installed
+      rescue StandardError => e
+        logger.error "Failed to install packages: #{e.message}"
+        {}
+      end
+
+      def create_swc_config
+        config_dir = root_path.join("config")
+        swc_config_path = config_dir.join("swc.config.js")
+
+        if swc_config_path.exist?
+          logger.info "ℹ️  config/swc.config.js already exists"
+          return false
+        end
+
+        FileUtils.mkdir_p(config_dir) unless config_dir.exist?
+
+        logger.info "📄 Creating config/swc.config.js..."
+        File.write(swc_config_path, DEFAULT_SWC_CONFIG)
+        logger.info "✅ config/swc.config.js created"
+        true
+      rescue StandardError => e
+        logger.error "Failed to create config/swc.config.js: #{e.message}"
+        false
+      end
+
+      def remove_babel_from_package_json(package_json_path, preserve: [])
+        package_json = JSON.parse(File.read(package_json_path))
+        dependencies = package_json["dependencies"] || {}
+        dev_dependencies = package_json["devDependencies"] || {}
+        removed_packages = []
+
+        BABEL_PACKAGES.each do |package|
+          next if preserve.include?(package)
+
+          if dependencies.delete(package)
+            removed_packages << package
+            logger.info "  - Removed #{package} from dependencies"
+          end
+          if dev_dependencies.delete(package)
+            removed_packages << package
+            logger.info "  - Removed #{package} from devDependencies"
+          end
+        end
+
+        # Log preserved packages
+        preserve.each do |package|
+          if dependencies[package] || dev_dependencies[package]
+            logger.info "  - Preserved #{package} (needed for ESLint)"
+          end
+        end
+
+        if removed_packages.any?
+          package_json["dependencies"] = dependencies
+          package_json["devDependencies"] = dev_dependencies
+          File.write(package_json_path, JSON.pretty_generate(package_json) + "\n")
+          logger.info "✅ package.json updated"
+        end
+
+        removed_packages.uniq
+      rescue StandardError => e
+        logger.error "Failed to remove packages: #{e.message}"
+        []
+      end
+
+      def delete_babel_config_files
+        deleted_files = []
+        babel_config_files = [".babelrc", "babel.config.js", ".babelrc.js", "babel.config.json"]
+
+        babel_config_files.each do |file|
+          file_path = root_path.join(file)
+          if file_path.exist?
+            logger.info "  - Removing #{file}"
+            File.delete(file_path)
+            deleted_files << file
+          end
+        end
+
+        deleted_files
+      rescue StandardError => e
+        logger.error "Failed to delete config files: #{e.message}"
+        []
+      end
+
+      def run_package_manager_install
+        logger.info "\n🔧 Running npm/yarn install..."
+
+        yarn_lock = root_path.join("yarn.lock")
+        pnpm_lock = root_path.join("pnpm-lock.yaml")
+
+        if yarn_lock.exist?
+          system("yarn install")
+        elsif pnpm_lock.exist?
+          system("pnpm install")
+        else
+          system("npm install")
+        end
+      end
+
+      def package_manager
+        yarn_lock = root_path.join("yarn.lock")
+        pnpm_lock = root_path.join("pnpm-lock.yaml")
+
+        if yarn_lock.exist?
+          "yarn"
+        elsif pnpm_lock.exist?
+          "pnpm"
+        else
+          "npm"
+        end
+      end
+  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".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