hotwire-livereload 0.1.4 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f8001c1b5e1ae699af050da2c601fd29ee3242cdcdd87f1487b38d18a395978
-  data.tar.gz: 0fa2a43353fceb7e14908d1130cb7fcea7c71b59846888c3845e91922b5ac833
+  metadata.gz: b6e414e66bbb4fbc76eef6000651aad79952f8f51ea70f19970691c780af09c2
+  data.tar.gz: 76540592b6138efb0365019b43ef04751a7071037f62814babbd05e96ff5bf01
 SHA512:
-  metadata.gz: 7202fa592b12ab9ef913d0fc62979b998a53357f9d74731df1fe1990ebe1f358a628509ae4a6010ee8dec1fbcadb60281bf9e62def1e829da728af9eeb211684
-  data.tar.gz: 7b3b8dd4a60f103f2f2b9c673ceab137855a9ceaf583a6ed564384d1e1f617a80b06c7e751d09cdf801d583c7bea9ed60801accce6cd0c11203a1f0b9e996922
+  metadata.gz: bac450b366a58fe90bdadfdab8898f9592681bc97ff1d1cc2450db0be1fee0f6b32fadce34c5c66fb709266a7283932bee827413b56671ab36b72564238b6447
+  data.tar.gz: acd23ee5a23fce850579b5604ae2d5a2bd4c4d12134bf10bfd0a442a0dcdf96a396aa9bcbdda3aab2953f89d0d7988231cba40ace417c72ce8e37bd79045523a

data/README.md

@@ -1,16 +1,81 @@
 # Hotwire::Livereload
 
-Automatically reload Hotwire Turbo when "view" files are modified.
+Automatically reload Hotwire Turbo when app files are modified.
 
-https://user-images.githubusercontent.com/839922/131983979-afd0bcc7-86e8-4c53-9758-3bf762dbb16a.mp4
+https://user-images.githubusercontent.com/839922/148676469-0acfa036-832e-4b40-aa05-1fdd945baa1f.mp4
 
-## Installation
+## Gettings
 
-The JavaScript for Hotwire::Livereload is installed via asset pipeline, which is included with this gem.
+Add `hotwire-livereload` to your Gemfile:
+```
+bundle add hotwire-livereload --group development
+```
 
-1. Add `hotwire-livereload` gem to your Gemfile: `gem 'hotwire-livereload'`
-2. Run `./bin/bundle install`
-3. Run `./bin/rails hotwire_livereload:install`
+Run installer:
+```
+rails livereload:install
+```
+
+Folders listened by default:
+- `app/views`
+- `app/helpers`
+- `app/javascript`
+- `app/assets/stylesheets`
+- `app/assets/javascripts`
+- `app/assets/images`
+- `app/components`
+- `config/locales`
+
+## Configuration
+
+You can watch for changes in additional folders by adding them to `listen_paths`:
+```ruby
+# config/environments/development.rb
+
+Rails.application.configure do
+  # ...
+  config.hotwire_livereload.listen_paths << Rails.root.join("app/custom_folder")
+end
+```
+
+You can disable default listen paths and fully override them:
+```ruby
+# config/environments/development.rb
+
+Rails.application.configure do
+  # ...
+  config.hotwire_livereload.disable_default_listeners = true
+  config.hotwire_livereload.listen_paths = [
+    Rails.root.join("app/assets/stylesheets"),
+    Rails.root.join("app/javascript")
+  ]
+end
+```
+
+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
+
+Rails.application.configure do
+  # ...
+  config.hotwire_livereload.force_reload_paths << Rails.root.join("app/assets/stylesheets")
+  config.hotwire_livereload.force_reload_paths << Rails.root.join("app/javascript")
+end
+```
+
+## Disable livereload
+
+To temporarily disable livereload use:
+```bash
+bin/rails livereload:disable
+```
+
+To re-enable:
+```bash
+bin/rails livereload:enable
+```
+
+No server restart is required. Disabling is managed by `tmp/livereload-disabled.txt` file.
 
 ## Development
 

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,8 @@ module Hotwire
       isolate_namespace Hotwire::Livereload
       config.hotwire_livereload = ActiveSupport::OrderedOptions.new
       config.hotwire_livereload.listen_paths ||= []
+      config.hotwire_livereload.force_reload_paths ||= []
+      config.hotwire_livereload.disable_default_listeners = false
       config.autoload_once_paths = %W(
         #{root}/app/channels
         #{root}/app/helpers
@@ -27,20 +29,41 @@ module Hotwire
 
       initializer "hotwire_livereload.set_configs" do |app|
         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")
+
+        unless options.disable_default_listeners
+          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.listen_paths += default_listen_paths.select { |p| Dir.exist?(p) }
         end
       end
 
       config.after_initialize do |app|
-        if Rails.env.development?
-          @listener = Listen.to(*app.config.hotwire_livereload.listen_paths) do |modified, added, removed|
-            if modified.any? || removed.any? || added.any?
-              content = { modified: modified, removed: removed, added: added }
-              ActionCable.server.broadcast("hotwire-reload", content)
+        if Rails.env.development? && defined?(Rails::Server)
+          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)
+              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.1.4"
+    VERSION = "1.1.0"
   end
 end

data/lib/hotwire/livereload.rb

@@ -2,5 +2,6 @@ require "hotwire/livereload/engine"
 
 module Hotwire
   module Livereload
+    DISABLE_FILE = "tmp/livereload-disabled.txt"
   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"

data/lib/tasks/livereload_tasks.rake

@@ -0,0 +1,21 @@
+namespace :livereload do
+  desc "Install Hotwire::Livereload into the app"
+  task :install do
+    system "#{RbConfig.ruby} ./bin/rails app:template LOCATION=#{File.expand_path("../install/install.rb",  __dir__)}"
+  end
+
+  desc "Disable Hotwire::Livereload"
+  task :disable do
+    FileUtils.mkdir_p("tmp")
+    FileUtils.touch Hotwire::Livereload::DISABLE_FILE
+    puts "Livereload disabled."
+  end
+
+  desc "Enable Hotwire::Livereload"
+  task :enable do
+    if File.exist?(Hotwire::Livereload::DISABLE_FILE)
+      File.delete Hotwire::Livereload::DISABLE_FILE
+    end
+    puts "Livereload enabled."
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hotwire-livereload
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 1.1.0
 platform: ruby
 authors:
 - Kirill Platonov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-08 00:00:00.000000000 Z
+date: 2022-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -55,7 +55,7 @@ files:
 - lib/hotwire/livereload/engine.rb
 - lib/hotwire/livereload/version.rb
 - lib/install/install.rb
-- lib/tasks/hotwire/livereload/install.rake
+- lib/tasks/livereload_tasks.rake
 homepage: https://github.com/kirillplatonov/hotwire-livereload
 licenses:
 - MIT
@@ -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: []

data/lib/tasks/hotwire/livereload/install.rake

@@ -1,6 +0,0 @@
-namespace :hotwire_livereload do
-  desc "Setup Hotwire Livereload"
-  task :install do
-    system "#{RbConfig.ruby} ./bin/rails app:template LOCATION=#{File.expand_path("../../../install/install.rb",  __dir__)}"
-  end
-end