hotwire-livereload 1.3.2 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 44376128ac37b1619d34c7ee8dee64eb1901804cc170dd0bd5c2114973e98225
-  data.tar.gz: 9053700099d671c33b11fa0483100ec5f921016a7e2f1315113072c5c1bba587
+  metadata.gz: 76c9e1c7f17f98e067a076d8dfc624d03aa1a7a64784da9fdde0b59f211bebe5
+  data.tar.gz: 3fa02e7e5a7592c61be7db173ff945f9d2f6da2e29ba4a777072702619b54473
 SHA512:
-  metadata.gz: 5677a61e971bfa24bb8c8ea76970420e370e03003f07970632bf07b22c187cc6dfc3289963509c8597f7b12c08e112d8db56f308fa85008023c3160a9f700846
-  data.tar.gz: 4e91a4a01f3e5b8d54e18b2344351c17bef3e1ac09568adc3b1802dc6a8f95eaa4abc6c972e93c8edd7eafa61a944e2b390e339697b1bc802cc7a8e85176b6ff
+  metadata.gz: 760b3adbb7ef2bc0231f8e90f7ec3b5bfabbc2c01965518d1c69ab9885b0974cbdf0551d1f44e72a498917c55f790947fbad61ec1267973ac139ff85704c2a2f
+  data.tar.gz: 449e13ba3578d4fcc8e41e4939abecd29ee1a9673cdeaa7a0da24090c31de249868ae7c6541ed37c181cc4a4a23a40c6ee04f83b6922b65be3d9b0d92131d44c

data/README.md

@@ -20,7 +20,7 @@ Run installer:
 rails livereload:install
 ```
 
-Folders listened by default:
+Folders watched by default:
 - `app/views`
 - `app/helpers`
 - `app/javascript`
@@ -32,6 +32,12 @@ Folders listened by default:
 
 The gem detects if you use [`jsbundling-rails`](https://github.com/rails/jsbundling-rails) or [`cssbundling-rails`](https://github.com/rails/cssbundling-rails) and watches for changes in their output folder `app/assets/builds` automatically.
 
+In your layout, make sure you don't `turbo-track` your JS/CSS in development:
+```diff
++ <%= stylesheet_link_tag "application", "data-turbo-track": Rails.env.production? ? "reload" : "" %>
+- <%= stylesheet_link_tag "application", "data-turbo-track": "reload" %>
+```
+
 ## Configuration
 
 ### Listen paths
@@ -46,6 +52,16 @@ Rails.application.configure do
 end
 ```
 
+You can skip one or few default listen paths:
+```ruby
+# config/environments/development.rb
+
+Rails.application.configure do
+  # ...
+  config.hotwire_livereload.skip_listen_paths << Rails.root.join("app/views")
+end
+```
+
 You can disable default listen paths and fully override them:
 ```ruby
 # config/environments/development.rb
@@ -112,6 +128,21 @@ Rails.application.configure do
 end
 ```
 
+### Listen debounce delay
+
+If your app uses TailwindCSS or similar that compiles your CSS from looking at your templates, you can end up in a situation, where updating a template triggers twice for changes; once for the template and once for the rebuilt CSS. This can lead to unreliable reloads, ie. the reload happening before the CSS is built.
+
+To avoid this, you can add a debounce delay to the file watcher:
+
+```ruby
+# config/environments/development.rb
+
+Rails.application.configure do
+  # ...
+  config.hotwire_livereload.debounce_delay_ms = 300 # in milliseconds
+end
+```
+
 ## Disable livereload
 
 To temporarily disable livereload use:

data/lib/hotwire/livereload/engine.rb

@@ -8,6 +8,7 @@ module Hotwire
       isolate_namespace Hotwire::Livereload
       config.hotwire_livereload = ActiveSupport::OrderedOptions.new
       config.hotwire_livereload.listen_paths ||= []
+      config.hotwire_livereload.skip_listen_paths ||= []
       config.hotwire_livereload.force_reload_paths ||= []
       config.hotwire_livereload.reload_method = :action_cable
       config.hotwire_livereload.disable_default_listeners = false
@@ -16,6 +17,7 @@ module Hotwire
         #{root}/app/helpers
       ]
       config.hotwire_livereload.listen_options ||= {}
+      config.hotwire_livereload.debounce_delay_ms = 0
 
       initializer "hotwire_livereload.assets" do
         if Rails.application.config.respond_to?(:assets)
@@ -31,6 +33,7 @@ module Hotwire
 
       initializer "hotwire_livereload.set_configs" do |app|
         options = app.config.hotwire_livereload
+        skip_listen_paths = options.skip_listen_paths.map(&:to_s).uniq
 
         unless options.disable_default_listeners
           default_listen_paths = %w[
@@ -55,11 +58,20 @@ module Hotwire
             .uniq
             .map { |p| Rails.root.join(p) }
             .select { |p| Dir.exist?(p) }
+            .reject { |p| skip_listen_paths.include?(p.to_s) }
         end
       end
 
       config.after_initialize do |app|
         if Rails.env.development? && Hotwire::Livereload.server_process?
+          @trigger_reload = (Hotwire::Livereload.debounce(config.hotwire_livereload.debounce_delay_ms) do |options|
+            if config.hotwire_livereload.reload_method == :turbo_stream
+              Hotwire::Livereload.turbo_stream(options)
+            else
+              Hotwire::Livereload.action_cable(options)
+            end
+          end)
+
           options = app.config.hotwire_livereload
           listen_paths = options.listen_paths.map(&:to_s).uniq
           force_reload_paths = options.force_reload_paths.map(&:to_s).uniq.join("|")
@@ -74,11 +86,7 @@ module Hotwire
               end
 
               options = {changed: changed, force_reload: force_reload}
-              if config.hotwire_livereload.reload_method == :turbo_stream
-                Hotwire::Livereload.turbo_stream(options)
-              else
-                Hotwire::Livereload.action_cable(options)
-              end
+              @trigger_reload.call(options)
             end
           end
           @listener.start
@@ -111,5 +119,27 @@ module Hotwire
 
       puma_process || rails_server
     end
+
+    def self.debounce(wait_ms, &block)
+      if wait_ms.zero?
+        return ->(*args) { yield(*args) }
+      end
+
+      mutex = Mutex.new
+      timer_thread = nil
+      seconds = wait_ms.to_f / 1000.0
+
+      lambda do |*args|
+        mutex.synchronize do
+          # Cancel previous timer
+          timer_thread&.kill
+
+          timer_thread = Thread.new do
+            sleep(seconds)
+            yield(*args)
+          end
+        end
+      end
+    end
   end
 end

data/lib/hotwire/livereload/version.rb

@@ -1,5 +1,5 @@
 module Hotwire
   module Livereload
-    VERSION = "1.3.2"
+    VERSION = "1.4.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hotwire-livereload
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.4.0
 platform: ruby
 authors:
 - Kirill Platonov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-28 00:00:00.000000000 Z
+date: 2024-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties