hotwire-livereload 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 05ad19b6e77492fec265a2da6af3ddd9aa8b7b149ae284397644db40b553974b
-  data.tar.gz: 7f497acf2a34e1774d80c7a2fa1030b6a2eb9228cc2fe257b73a7cdad0e912fc
+  metadata.gz: a4397b862ba6f621e8442f674fbf5ffa478422e8d01b293f299afbd8213154ac
+  data.tar.gz: e9e4a35a16d3f09c9f88467e2e0267ee98220d6be0ddda7bd28fc9b3cb8bff95
 SHA512:
-  metadata.gz: 554901b08d7d257da5660c5020cbfb8bab03e987eff1d329337fa9943119c6e3a8bead3bc62c97edec32250f7c0bb5503b7d306373e794bd7908a208f211284a
-  data.tar.gz: 8e213677c64df89f7903d672c421b7faa9d8a5d12e136ef24e92e7dbc1a0deedc650d92cd882b06627f20e89ddcd4d46ea72943e22cf035152b9aff2e3284c02
+  metadata.gz: 71e11b2197803862c7afb86717f6ccc753ddd60923e7f330b715af28f2263fe49e8baa839bf6d7110ff5bf6dfddeba49c84c7182ea5edc54400c9597e7cbd0ec
+  data.tar.gz: a847e23ec3f9eb51ba0f7a7cc3d9ee112980b5eae0ae250e5d82505c19cebd97f6849c01a058d227946d9c075c043cca5909120aa09cc3f95fafa4e121233fe9

data/README.md

@@ -8,20 +8,45 @@ https://user-images.githubusercontent.com/839922/131983979-afd0bcc7-86e8-4c53-97
 
 The JavaScript for Hotwire::Livereload is installed via asset pipeline, which is included with this gem.
 
-1. Add `hotwire-livereload` gem to your Gemfile: `gem 'hotwire-livereload'`
-2. Run `./bin/bundle install`
-3. Run `./bin/rails livereload:install`
+Add `hotwire-livereload` to your Gemfile:
+```
+bundle add hotwire-livereload --group development
+```
+
+Run installer:
+```
+rails livereload:install
+```
 
 ## Configuration
 
 You can watch for changes in additional folders by adding them to `listen_paths`. For example, you can watch for CSS changes:
+```ruby
+# config/environments/development.rb
+
+Rails.application.configure do
+  # ...
+  config.hotwire_livereload.listen_paths << Rails.root.join("app/custom_folder")
+end
+```
 
+Folders listened by default:
+- `app/views`
+- `app/helpers`
+- `app/javascript`
+- `app/assets/stylesheets`
+- `app/assets/javascripts`
+- `app/assets/images`
+- `app/components`
+- `config/locales`
+
+You can setup force reloading (full page reload) for changes in some folders using `force_reload_paths` option. For example, you can trigger force reload on JS changes:
 ```ruby
 # config/environments/development.rb
 
 Rails.application.configure do
   # ...
-  config.hotwire_livereload.listen_paths << Rails.root.join("app/assets/stylesheets")
+  config.hotwire_livereload.force_reload_paths << Rails.root.join("app/javascript")
 end
 ```
 

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

@@ -601,9 +601,15 @@
   var import_actioncable = __toModule(require_action_cable());
   var import_debounce = __toModule(require_debounce());
   var consumer = (0, import_actioncable.createConsumer)();
-  var received = (0, import_debounce.default)(() => {
-    console.log("[Hotwire::Livereload] Files changed");
-    Turbo.visit(window.location.href);
+  var received = (0, import_debounce.default)(({ force_reload }) => {
+    const onErrorPage = document.title === "Action Controller: Exception caught";
+    if (onErrorPage || force_reload) {
+      console.log("[Hotwire::Livereload] Files changed. Force reloading..");
+      document.location.reload();
+    } else {
+      console.log("[Hotwire::Livereload] Files changed. Reloading..");
+      Turbo.visit(window.location.href);
+    }
   }, 300);
   consumer.subscriptions.create("Hotwire::Livereload::ReloadChannel", {
     received,

data/app/javascript/hotwire-livereload.js

@@ -2,9 +2,16 @@ import { createConsumer } from "@rails/actioncable"
 import debounce from "debounce"
 
 const consumer = createConsumer()
-const received = debounce(() => {
-  console.log("[Hotwire::Livereload] Files changed")
-  Turbo.visit(window.location.href)
+const received = debounce(({force_reload}) => {
+  const onErrorPage = document.title === "Action Controller: Exception caught"
+
+  if (onErrorPage || force_reload) {
+    console.log("[Hotwire::Livereload] Files changed. Force reloading..")
+    document.location.reload()
+  } else {
+    console.log("[Hotwire::Livereload] Files changed. Reloading..")
+    Turbo.visit(window.location.href)
+  }
 }, 300)
 
 consumer.subscriptions.create("Hotwire::Livereload::ReloadChannel", {

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.force_reload_paths ||= []
       config.autoload_once_paths = %W(
         #{root}/app/channels
         #{root}/app/helpers
@@ -26,23 +27,40 @@ module Hotwire
       end
 
       initializer "hotwire_livereload.set_configs" do |app|
+        default_listen_paths = %w[
+          app/views
+          app/helpers
+          app/javascript
+          app/assets/stylesheets
+          app/assets/javascripts
+          app/assets/images
+          app/components
+          config/locales
+        ].map { |p| Rails.root.join(p) }
+
         options = app.config.hotwire_livereload
-        options.listen_paths = options.listen_paths.map(&:to_s)
-        options.listen_paths << Rails.root.join("app/views")
-        options.listen_paths << Rails.root.join("app/helpers")
-        if Dir.exist?(Rails.root.join("app/javascript"))
-          options.listen_paths << Rails.root.join("app/javascript")
-        end
+        options.listen_paths += default_listen_paths.select { |p| Dir.exist?(p) }
       end
 
       config.after_initialize do |app|
         if Rails.env.development? && defined?(Rails::Server)
-          @listener = Listen.to(*app.config.hotwire_livereload.listen_paths) do |modified, added, removed|
+          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("|")
+
+          @listener = Listen.to(*listen_paths) do |modified, added, removed|
             unless File.exists?(DISABLE_FILE)
-              if (modified.any? || removed.any? || added.any?)
-                content = { modified: modified, removed: removed, added: added }
-                ActionCable.server.broadcast("hotwire-reload", content)
+              changed = [modified, removed, added].flatten.uniq
+              return unless changed.any?
+
+              force_reload = force_reload_paths.present? && changed.any? do |path|
+                path.match(%r{#{force_reload_paths}})
               end
+
+              ActionCable.server.broadcast("hotwire-reload", {
+                changed: changed,
+                force_reload: force_reload
+              })
             end
           end
           @listener.start

data/lib/hotwire/livereload/version.rb

@@ -1,5 +1,5 @@
 module Hotwire
   module Livereload
-    VERSION = "0.2.0"
+    VERSION = "0.3.0"
   end
 end

data/lib/install/install.rb

@@ -3,18 +3,26 @@ CABLE_CONFIG_PATH = Rails.root.join("config/cable.yml")
 
 if APP_LAYOUT_PATH.exist?
   say "Add Hotwire Livereload tag in application layout"
-  insert_into_file APP_LAYOUT_PATH, before: /\s*<\/head>/ do <<-HTML
-\n    <%= hotwire_livereload_tags %>
+  content = <<-HTML
+\n    <% if Rails.env.development? %>
+      <%= javascript_include_tag "hotwire-livereload", defer: true %>
+    <% end %>
 HTML
-  end
+  insert_into_file APP_LAYOUT_PATH, content.chop, before: /\s*<\/head>/
 else
   say "Default application.html.erb is missing!", :red
   say %(  Add <%= hotwire_livereload_tags %> within the <head> tag in your custom layout.)
 end
 
 if CABLE_CONFIG_PATH.exist?
-  say "Enable redis in bundle"
-  uncomment_lines "Gemfile", %(gem 'redis')
+  gemfile = File.read(Rails.root.join("Gemfile"))
+  if gemfile.include?("redis")
+    say "Uncomment redis in Gemfile"
+    uncomment_lines "Gemfile", %(gem "redis")
+  else
+    say "Add redis to Gemfile"
+    gem "redis"
+  end
 
   say "Switch development cable to use redis"
   gsub_file CABLE_CONFIG_PATH.to_s, /development:\n\s+adapter: async/, "development:\n  adapter: redis\n  url: redis://localhost:6379/1"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hotwire-livereload
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Kirill Platonov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-04 00:00:00.000000000 Z
+date: 2021-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -75,8 +75,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
-summary: Automatically reload Hotwire Turbo when 'view' files are modified.
+summary: Automatically reload Hotwire Turbo when app files are modified.
 test_files: []