react_on_rails 16.0.0 → 16.0.1.rc.2

data/lib/tasks/doctor.rake

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require_relative "../react_on_rails"
+require_relative "../react_on_rails/doctor"
+
+begin
+  require "rainbow"
+rescue LoadError
+  # Fallback if Rainbow is not available
+  class Rainbow
+    def self.method_missing(_method, text)
+      SimpleColorWrapper.new(text)
+    end
+
+    def self.respond_to_missing?(_method, _include_private = false)
+      true
+    end
+  end
+
+  class SimpleColorWrapper
+    def initialize(text)
+      @text = text
+    end
+
+    def method_missing(_method, *_args)
+      self
+    end
+
+    def respond_to_missing?(_method, _include_private = false)
+      true
+    end
+
+    def to_s
+      @text
+    end
+  end
+end
+
+namespace :react_on_rails do
+  desc "Diagnose React on Rails setup and configuration"
+  task :doctor do
+    verbose = ENV["VERBOSE"] == "true"
+    fix = ENV["FIX"] == "true"
+
+    doctor = ReactOnRails::Doctor.new(verbose: verbose, fix: fix)
+    doctor.run_diagnosis
+  end
+end

data/lib/tasks/generate_packs.rake

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+# rubocop:disable Metrics/BlockLength
 namespace :react_on_rails do
   desc <<~DESC
     If there is a file inside any directory matching config.components_subdirectory, this command generates corresponding packs.
@@ -21,11 +22,133 @@ namespace :react_on_rails do
     puts Rainbow("📂 Components subdirectory: #{ReactOnRails.configuration.components_subdirectory}").cyan
     puts ""
 
-    start_time = Time.now
-    ReactOnRails::PacksGenerator.instance.generate_packs_if_stale
-    end_time = Time.now
+    begin
+      start_time = Time.now
+      ReactOnRails::PacksGenerator.instance.generate_packs_if_stale
+      end_time = Time.now
 
+      puts ""
+      puts Rainbow("✨ Pack generation completed in #{((end_time - start_time) * 1000).round(1)}ms").green
+    rescue ReactOnRails::Error => e
+      handle_react_on_rails_error(e)
+      exit 1
+    rescue StandardError => e
+      handle_standard_error(e)
+      exit 1
+    end
+  end
+
+  private
+
+  # rubocop:disable Metrics/AbcSize
+  def handle_react_on_rails_error(error)
+    puts ""
+    puts Rainbow("❌ REACT ON RAILS ERROR").red.bold
+    puts Rainbow("=" * 80).red
+    puts Rainbow("🚨 Pack generation failed with the following error:").red
+    puts ""
+    puts Rainbow("📋 ERROR DETAILS:").yellow
+    puts Rainbow("   Type: #{error.class.name}").white
+    puts Rainbow("   Message: #{error.message}").white
+    puts ""
+
+    highlight_main_error(error)
+    show_common_solutions(error)
+    show_debugging_steps
+    show_documentation_links
+  end
+  # rubocop:enable Metrics/AbcSize
+
+  def highlight_main_error(error)
+    return unless error.message.include?("**ERROR**")
+
+    error_lines = error.message.split("\n")
+    error_lines.each do |line|
+      next unless line.include?("**ERROR**")
+
+      puts Rainbow("🔥 MAIN ISSUE:").red.bold
+      puts Rainbow("   #{line.gsub('**ERROR**', '').strip}").yellow
+    end
+  end
+
+  # rubocop:disable Metrics/AbcSize
+  def show_common_solutions(error)
+    puts ""
+    puts Rainbow("💡 COMMON SOLUTIONS:").green.bold
+
+    case error.message
+    when /client specific definition.*overrides the common definition/
+      puts Rainbow("   • You have both common and client/server specific component files").white
+      puts Rainbow("   • Delete the common component file (e.g., Component.jsx)").white
+      puts Rainbow("   • Keep only the client/server specific files " \
+                   "(Component.client.jsx, Component.server.jsx)").white
+      puts Rainbow("   • See: https://www.shakacode.com/react-on-rails/docs/guides/" \
+                   "file-system-based-automated-bundle-generation.md").cyan
+
+    when /Cannot find component/
+      puts Rainbow("   • Check that your component file exists in the expected location").white
+      puts Rainbow("   • Verify the component is exported as default export").white
+      puts Rainbow("   • Ensure the file extension is .jsx or .js").white
+
+    when /CSS module.*not found/
+      puts Rainbow("   • Check that the CSS module file exists").white
+      puts Rainbow("   • Verify the import path is correct").white
+      puts Rainbow("   • Ensure all CSS classes referenced in the component exist").white
+
+    else
+      puts Rainbow("   • Check component file structure and naming").white
+      puts Rainbow("   • Verify all imports and exports are correct").white
+      puts Rainbow("   • Run with --trace for more detailed error information").white
+    end
+  end
+  # rubocop:enable Metrics/AbcSize
+
+  def show_debugging_steps
+    puts ""
+    puts Rainbow("🔧 DEBUGGING STEPS:").blue.bold
+    components_path = "app/javascript/src/**/#{ReactOnRails.configuration.components_subdirectory}/"
+    puts Rainbow("   1. Check component files in: #{components_path}").white
+    puts Rainbow("   2. Verify component exports: export default ComponentName").white
+    puts Rainbow("   3. Check for conflicting common/client/server files").white
+    puts Rainbow("   4. Run: rake react_on_rails:generate_packs --trace").white
+    puts Rainbow("   5. Check Rails logs for additional details").white
+  end
+
+  def show_documentation_links
+    puts ""
+    puts Rainbow("📚 DOCUMENTATION:").magenta.bold
+    puts Rainbow("   • File-system based components: https://www.shakacode.com/react-on-rails/docs/" \
+                 "guides/file-system-based-automated-bundle-generation.md").cyan
+    puts Rainbow("   • Component registration: https://www.shakacode.com/react-on-rails/docs/").cyan
+    puts Rainbow("=" * 80).red
+  end
+
+  # rubocop:disable Metrics/AbcSize
+  def handle_standard_error(error)
+    puts ""
+    puts Rainbow("❌ UNEXPECTED ERROR").red.bold
+    puts Rainbow("=" * 80).red
+    puts Rainbow("🚨 An unexpected error occurred during pack generation:").red
+    puts ""
+    puts Rainbow("📋 ERROR DETAILS:").yellow
+    puts Rainbow("   Type: #{error.class.name}").white
+    puts Rainbow("   Message: #{error.message}").white
+    puts Rainbow("   Backtrace:").white
+    error.backtrace.first(10).each { |line| puts Rainbow("     #{line}").white }
+    puts Rainbow("     ... (run with --trace for full backtrace)").white
+    puts ""
+    puts Rainbow("🔧 DEBUGGING STEPS:").blue.bold
+    puts Rainbow("   1. Run: rake react_on_rails:generate_packs --trace").white
+    puts Rainbow("   2. Check Rails logs: tail -f log/development.log").white
+    puts Rainbow("   3. Verify all dependencies are installed: bundle install && npm install").white
+    puts Rainbow("   4. Clear cache: rm -rf tmp/cache").white
     puts ""
-    puts Rainbow("✨ Pack generation completed in #{((end_time - start_time) * 1000).round(1)}ms").green
+    puts Rainbow("📞 GET HELP:").magenta.bold
+    puts Rainbow("   • Create an issue: https://github.com/shakacode/react_on_rails/issues").cyan
+    puts Rainbow("   • Community discussions: https://github.com/shakacode/react_on_rails/discussions").cyan
+    puts Rainbow("   • Professional support: https://www.shakacode.com/react-on-rails-pro").cyan
+    puts Rainbow("=" * 80).red
   end
+  # rubocop:enable Metrics/AbcSize
 end
+# rubocop:enable Metrics/BlockLength