hotwire-livereload 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f8001c1b5e1ae699af050da2c601fd29ee3242cdcdd87f1487b38d18a395978
-  data.tar.gz: 0fa2a43353fceb7e14908d1130cb7fcea7c71b59846888c3845e91922b5ac833
+  metadata.gz: 05ad19b6e77492fec265a2da6af3ddd9aa8b7b149ae284397644db40b553974b
+  data.tar.gz: 7f497acf2a34e1774d80c7a2fa1030b6a2eb9228cc2fe257b73a7cdad0e912fc
 SHA512:
-  metadata.gz: 7202fa592b12ab9ef913d0fc62979b998a53357f9d74731df1fe1990ebe1f358a628509ae4a6010ee8dec1fbcadb60281bf9e62def1e829da728af9eeb211684
-  data.tar.gz: 7b3b8dd4a60f103f2f2b9c673ceab137855a9ceaf583a6ed564384d1e1f617a80b06c7e751d09cdf801d583c7bea9ed60801accce6cd0c11203a1f0b9e996922
+  metadata.gz: 554901b08d7d257da5660c5020cbfb8bab03e987eff1d329337fa9943119c6e3a8bead3bc62c97edec32250f7c0bb5503b7d306373e794bd7908a208f211284a
+  data.tar.gz: 8e213677c64df89f7903d672c421b7faa9d8a5d12e136ef24e92e7dbc1a0deedc650d92cd882b06627f20e89ddcd4d46ea72943e22cf035152b9aff2e3284c02

data/README.md

@@ -10,7 +10,34 @@ The JavaScript for Hotwire::Livereload is installed via asset pipeline, which is
 
 1. Add `hotwire-livereload` gem to your Gemfile: `gem 'hotwire-livereload'`
 2. Run `./bin/bundle install`
-3. Run `./bin/rails hotwire_livereload:install`
+3. Run `./bin/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/assets/stylesheets")
+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/lib/hotwire/livereload/engine.rb

@@ -36,11 +36,13 @@ module Hotwire
       end
 
       config.after_initialize do |app|
-        if Rails.env.development?
+        if Rails.env.development? && defined?(Rails::Server)
           @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)
+            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)
+              end
             end
           end
           @listener.start

data/lib/hotwire/livereload/version.rb

@@ -1,5 +1,5 @@
 module Hotwire
   module Livereload
-    VERSION = "0.1.4"
+    VERSION = "0.2.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/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: 0.2.0
 platform: ruby
 authors:
 - Kirill Platonov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-08 00:00:00.000000000 Z
+date: 2021-12-04 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

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