hotwire-livereload 0.1.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5df2481e44b656c233a0088024d87bc11fcc54ba3fd469bc5c5ef6b5ff69225f
-  data.tar.gz: 6550a575e2cb6d601e2b516106a155fd7805fdecb4b25a89137c56fadd78a291
+  metadata.gz: 2634bec56254429d0d3f222fdc56d3e6acae483e8158da3c8314540c812da537
+  data.tar.gz: 0162d148937597fb06a5f6f23ba43dedabe550cde88e892dbc2369ce63e6fd4f
 SHA512:
-  metadata.gz: 40269aa33f0c249354eb64f688461bcfde1956b0727e183c80c7c70d277040195e235110eeef12ec81a47f1261317a2a2096f4e605aa04e68c76d9ae140ca290
-  data.tar.gz: e792c0b4fcc371ef4c9fbb87bb7766516a4b93e54a69574c1e9fc320cbb594c06e09cf731afc2cdbdb12bebbaca7bcb8dc84ecb2c129ad41f71e79d8e8ef0aa0
+  metadata.gz: 946841da42fc46ab057128a32881e72a2d35dc69759e6036cf562b58d70db8d793a0d338312623c665afcf5c3edf4e4a54e3b573528b139e6a20af2bb1bb24c2
+  data.tar.gz: ec6af99da8e71eadae77b68e579a65ccab81ad3acb9bd54f70466908cdc14f67ece5667e7bc31f7a4f44f52e0d449a22961a3729c2a098189ca30ec84c24c09e

data/README.md

@@ -8,9 +8,61 @@ 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 hotwire_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.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,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,17 +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 += default_listen_paths.select { |p| Dir.exist?(p) }
       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.3"
+    VERSION = "1.0.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.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Kirill Platonov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-03 00:00:00.000000000 Z
+date: 2021-12-31 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