hotwire-livereload 1.3.1 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42f6430166f2bcdcb52940e92965a5e1d202c57b09966ddb72f76b746918b473
-  data.tar.gz: be8743a9b6cbced10614d8fb4fc9cae8306c4355648175a91ed716a763722453
+  metadata.gz: 44376128ac37b1619d34c7ee8dee64eb1901804cc170dd0bd5c2114973e98225
+  data.tar.gz: 9053700099d671c33b11fa0483100ec5f921016a7e2f1315113072c5c1bba587
 SHA512:
-  metadata.gz: 909b0a55ec3d9d4dcbb0f7536e72c380a2d2d8e885cc5d988fe64f91771b759a2809d65f3fad8e500e565a51620532ae1b43c338880c7da977f396852f3b2d6b
-  data.tar.gz: 90116c0e4b698346603d398cc3a4c7dd6616403f6caae041a014251ea24f57a5e36f83bc6e8554d1c65b21e36e92592c9a583f2f14ca042f357a7d324ecbff8d
+  metadata.gz: 5677a61e971bfa24bb8c8ea76970420e370e03003f07970632bf07b22c187cc6dfc3289963509c8597f7b12c08e112d8db56f308fa85008023c3160a9f700846
+  data.tar.gz: 4e91a4a01f3e5b8d54e18b2344351c17bef3e1ac09568adc3b1802dc6a8f95eaa4abc6c972e93c8edd7eafa61a944e2b390e339697b1bc802cc7a8e85176b6ff

data/README.md

@@ -34,6 +34,8 @@ The gem detects if you use [`jsbundling-rails`](https://github.com/rails/jsbundl
 
 ## Configuration
 
+### Listen paths
+
 You can watch for changes in additional folders by adding them to `listen_paths`:
 ```ruby
 # config/environments/development.rb
@@ -58,6 +60,8 @@ Rails.application.configure do
 end
 ```
 
+### Force reload
+
 If you don't have `data-turbo-track="reload"` attribute on your JS and CSS bundles you might need to setup force reloading. This will trigger full browser reloading for JS and CSS files only:
 ```ruby
 # config/environments/development.rb
@@ -69,6 +73,8 @@ Rails.application.configure do
 end
 ```
 
+### Reload method
+
 Instead of a direct ActionCable websocket connection, you can reuse the existing TurboStream websocket connection and send updates using standard turbo-streams:
 ```ruby
 # config/environments/development.rb
@@ -90,6 +96,22 @@ In that case you need to place `hotwire_livereload_tags` helper in your layout *
 </head>
 ```
 
+### Listen options
+
+[Listen gem](https://github.com/guard/listen), which is used for file system monitoring, accepts [options](https://github.com/guard/listen?tab=readme-ov-file#options) like enabling a fallback mechanism called "polling" to detect file changes.
+
+By default, Listen uses a more efficient mechanism called "native" which relies on the operating system's file system events to detect changes. However, in some cases, such as when working with network-mounted file systems or in certain virtualized environments, the native mechanism may not work reliably. In such cases, enabling force_polling ensures that file changes are still detected, albeit with a slightly higher resource usage.
+
+You may use listen_options to pass these options like:
+```ruby
+# config/environments/development.rb
+
+Rails.application.configure do
+  # ...
+  config.hotwire_livereload.listen_options[:force_polling] = true
+end
+```
+
 ## Disable livereload
 
 To temporarily disable livereload use:

data/app/assets/javascripts/hotwire-livereload-turbo-stream.js

@@ -115,6 +115,7 @@
     } else {
       console.log("[Hotwire::Livereload] Files changed. Reloading..");
       hotwire_livereload_scroll_position_default.save();
+      Turbo.cache.clear();
       Turbo.visit(window.location.href, { action: "replace" });
     }
   }, 300);

data/app/assets/javascripts/hotwire-livereload.js

@@ -697,6 +697,7 @@
     } else {
       console.log("[Hotwire::Livereload] Files changed. Reloading..");
       hotwire_livereload_scroll_position_default.save();
+      Turbo.cache.clear();
       Turbo.visit(window.location.href, { action: "replace" });
     }
   }, 300);

data/app/javascript/lib/hotwire-livereload-received.js

@@ -10,6 +10,7 @@ export default debounce(({force_reload}) => {
   } else {
     console.log("[Hotwire::Livereload] Files changed. Reloading..")
     scrollPosition.save()
+    Turbo.cache.clear()
     Turbo.visit(window.location.href, { action: 'replace' })
   }
 }, 300)

data/lib/hotwire/livereload/engine.rb

@@ -15,6 +15,7 @@ module Hotwire
         #{root}/app/channels
         #{root}/app/helpers
       ]
+      config.hotwire_livereload.listen_options ||= {}
 
       initializer "hotwire_livereload.assets" do
         if Rails.application.config.respond_to?(:assets)
@@ -63,7 +64,7 @@ module Hotwire
           listen_paths = options.listen_paths.map(&:to_s).uniq
           force_reload_paths = options.force_reload_paths.map(&:to_s).uniq.join("|")
 
-          @listener = Listen.to(*listen_paths) do |modified, added, removed|
+          @listener = Listen.to(*listen_paths, **config.hotwire_livereload.listen_options) do |modified, added, removed|
             unless File.exist?(DISABLE_FILE)
               changed = [modified, removed, added].flatten.uniq
               next unless changed.any?

data/lib/hotwire/livereload/version.rb

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

metadata

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