Merge pull request #691 from bashly-framework/change/filewatcher

Switch from `filewatcher` to `listen`

Author: DannyBen

.github/workflows/test.yml

@@ -14,7 +14,7 @@ jobs:
       LC_ALL: en_US.UTF-8 
 
     strategy:
-      matrix: { ruby: ['3.2', '3.3', '3.4'] }
+      matrix: { ruby: ['3.2', '3.3', '3.4', '4.0'] }
 
     steps:
     - name: Checkout code

bashly.gemspec

@@ -17,16 +17,17 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'colsole', '~> 1.0'
   s.add_dependency 'completely', '~> 0.7.0'
-  s.add_dependency 'filewatcher', '~> 2.0'
   s.add_dependency 'gtx', '~> 0.1.1'
+  s.add_dependency 'listen', '~> 3.9'
   s.add_dependency 'lp', '~> 0.2.0'
-  s.add_dependency 'mister_bin', '~> 0.8.1'
+  s.add_dependency 'mister_bin', '~> 0.9.0'
   s.add_dependency 'requires', '~> 1.1'
   s.add_dependency 'tty-markdown', '~> 0.7.2'
 
-  # Sub-dependenceis (Ruby 3.3.5 warnings)
-  s.add_dependency 'logger', '>= 1', '< 3'    # required by filewatcher
-  s.add_dependency 'ostruct', '>= 0', '< 2'   # required by json
+  # Missing sub-dependencies
+  # logger: required and not bundled by `listen` 3.9.0
+  #         ref: https://github.com/guard/listen/issues/591
+  s.add_dependency 'logger', '~> 1.7'
 
   s.metadata = {
     'bug_tracker_uri'       => 'https://github.com/bashly-framework/bashly/issues',

examples/render-mandoc/docs/download.1

@@ -1,6 +1,6 @@
 .\" Automatically generated by Pandoc 3.2
 .\"
-.TH "download" "1" "December 2025" "Version 0.1.0" "Sample application"
+.TH "download" "1" "January 2026" "Version 0.1.0" "Sample application"
 .SH NAME
 \f[B]download\f[R] \- Sample application
 .SH SYNOPSIS

examples/render-mandoc/docs/download.md

@@ -1,6 +1,6 @@
 % download(1) Version 0.1.0 | Sample application
 % Lana Lang
-% December 2025
+% January 2026
 
 NAME
 ==================================================

lib/bashly.rb

@@ -12,7 +12,7 @@ module Bashly
 
   autoloads 'bashly', %i[
     CLI Config ConfigValidator Library LibrarySource LibrarySourceConfig
-    MessageStrings RenderContext RenderSource Settings VERSION
+    MessageStrings RenderContext RenderSource Settings VERSION Watch
   ]
 
   autoloads 'bashly/concerns', %i[

lib/bashly/commands/generate.rb

@@ -1,5 +1,3 @@
-require 'filewatcher'
-
 module Bashly
   module Commands
     class Generate < Base
@@ -41,7 +39,7 @@ def run
       def watch
         quiet_say "g`watching` #{Settings.source_dir}\n"
 
-        Filewatcher.new([Settings.source_dir]).watch do
+        Watch.new(Settings.source_dir).on_change do
           reset
           generate
         rescue Bashly::ConfigurationError => e

lib/bashly/commands/render.rb

@@ -1,4 +1,3 @@
-require 'filewatcher'
 require 'tty-markdown'
 
 module Bashly
@@ -75,7 +74,7 @@ def render
       def watch
         say "g`watching`\n"
 
-        Filewatcher.new(watchables).watch do
+        Watch.new(*watchables).on_change do
           render
           say "g`waiting`\n"
         end

lib/bashly/watch.rb

@@ -0,0 +1,52 @@
+require 'listen'
+
+module Bashly
+  # File system watcher - an ergonomic wrapper around the Listen gem
+  class Watch
+    attr_reader :dirs, :options
+
+    DEFAULT_OPTIONS = {
+      force_polling: true,
+      latency:       1.0,
+    }.freeze
+
+    def initialize(*dirs, **options)
+      @options = DEFAULT_OPTIONS.merge(options).freeze
+      @dirs = dirs.empty? ? ['.'] : dirs
+    end
+
+    def on_change(&)
+      start(&)
+      wait
+    ensure
+      stop
+    end
+
+  private
+
+    def build_listener
+      listen.to(*dirs, **options) do |modified, added, removed|
+        yield changes(modified, added, removed)
+      end
+    end
+
+    def start(&block)
+      raise ArgumentError, 'block required' unless block
+
+      @listener = build_listener(&block)
+      @listener.start
+    end
+
+    def stop
+      @listener&.stop
+      @listener = nil
+    end
+
+    def changes(modified, added, removed)
+      { modified:, added:, removed: }
+    end
+
+    def listen = Listen
+    def wait = sleep
+  end
+end

spec/approvals/examples/dependencies-alt

@@ -24,4 +24,4 @@ args: none
 deps:
 - ${deps[git]} = /usr/bin/git
 - ${deps[http_client]} = /usr/bin/curl
-- ${deps[ruby]} = /home/vagrant/.rbenv/versions/3.4.1/bin/ruby
+- ${deps[ruby]} = /home/vagrant/.rbenv/versions/4.0.0/bin/ruby

spec/bashly/commands/generate_spec.rb

@@ -229,20 +229,20 @@
 
     let(:bashly_config_path) { "#{source_dir}/bashly.yml" }
     let(:bashly_config) { YAML.load_file bashly_config_path }
-    let(:watcher_double) { instance_double Filewatcher, watch: nil }
+    let(:watch_double) { instance_double Watch, on_change: nil }
 
     it 'generates immediately and on change' do
-      allow(Filewatcher).to receive(:new).and_return(watcher_double)
-      allow(watcher_double).to receive(:watch).and_yield
+      allow(Watch).to receive(:new).and_return(watch_double)
+      allow(watch_double).to receive(:on_change).and_yield
 
       expect { subject.execute %w[generate --watch] }
         .to output_approval('cli/generate/watch')
     end
 
     context 'when ConfigurationError is raised during watch' do
       it 'shows the error gracefully and continues to watch' do
-        allow(Filewatcher).to receive(:new).and_return(watcher_double)
-        allow(watcher_double).to receive(:watch) do |&block|
+        allow(Watch).to receive(:new).and_return(watch_double)
+        allow(watch_double).to receive(:on_change) do |&block|
           bashly_config['invalid_option'] = 'error this'
           File.write bashly_config_path, bashly_config.to_yaml
           block.call