3 - Add watch & version commands (#3)

* 3 - Add watch & version commands

* lint

* lint

* lint

Author: carlwiedemann

CHANGELOG.md

@@ -13,7 +13,11 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 ## [Unreleased]
 
-TBD
+## [1.3.0] - 2024-01-05
+
+### Added
+
+[#3](https://github.com/carlwiedemann/foresite/pull/3) version & watch commands (not sure how to test these best right now).
 
 ## [1.2.0] - 2023-02-11
 

README.md

@@ -107,6 +107,10 @@ In this example, the `index.html` will contain:
 </ul>
 ```
 
+### 5. Watch files and build automatically
+
+Run `foresite watch` to detect changes to markdown or ERB files, build will run automatically. Useful for previewing content locally.
+
 ## Development
 
 1. Clone

foresite.gemspec

@@ -38,6 +38,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "kramdown", "~> 2.4"
   spec.add_dependency "thor", "~> 1.2"
   spec.add_dependency "zeitwerk", "~> 2.6"
+  spec.add_dependency "filewatcher", "~> 2.1"
 
   spec.add_development_dependency "rspec", "~> 3.2"
   spec.add_development_dependency "standard", "~> 1.3"

lib/foresite.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
 
 require "erb"
-require "thor"
+require "filewatcher"
 require "kramdown"
+require "thor"
 require "zeitwerk"
 
 loader = Zeitwerk::Loader.for_gem

lib/foresite/cli.rb

@@ -12,6 +12,11 @@ def self.exit_on_failure?
       true
     end
 
+    desc "version", "Displays version"
+    def version
+      $stdout.puts(Foresite::VERSION)
+    end
+
     desc "init", "Initializes foresite in current directory"
     long_desc <<-LONGDESC
       Initializes foresite in the current directory.
@@ -117,5 +122,28 @@ def build
 
       $stdout.puts("Created #{Foresite.relative_path(index_html_path)}")
     end
+
+    desc "watch", "Watches markdown and templates files and runs `build` when they change"
+    long_desc <<-LONGDESC
+      See `build` help for more information
+    LONGDESC
+
+    # @todo How might we test this?
+    def watch
+      dirs_to_watch = [
+        Foresite::DIRNAME_MARKDOWN,
+        Foresite::DIRNAME_ERB
+      ]
+
+      $stdout.puts("Watching #{dirs_to_watch.map { "./#{_1}" }.join(", ")} for changes... (Ctrl+C to exit)")
+
+      Filewatcher.new(dirs_to_watch).watch do |changes|
+        changes.each do |filename, event|
+          $stdout.puts("#{File.basename(filename)} #{event}")
+        end
+
+        build
+      end
+    end
   end
 end

lib/foresite/renderer.rb

@@ -14,7 +14,7 @@ def initialize(path, vars)
       @path = path
       vars.each do |k, v|
         if k.is_a?(Symbol)
-          instance_variable_set("@#{k}".to_sym, v)
+          instance_variable_set(:"@#{k}", v)
         end
       end
     end

lib/foresite/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Foresite
-  VERSION = "1.2.0"
+  VERSION = "1.3.0"
 end

spec/foresite/cli_spec.rb

@@ -9,7 +9,7 @@
       expected_stderr = ForesiteRSpec.cli_line("Nonexistent directory foo")
       expected_exit_code = 1
 
-      expect { Foresite::Cli.new.invoke(:init) }.to output(expected_stderr).to_stderr \
+      expect { Foresite::Cli.new.invoke(:init) }.to output(expected_stderr).to_stderr
         .and(raise_error(SystemExit) { |error| expect(error.status).to eq(expected_exit_code) })
     end
 
@@ -19,7 +19,7 @@
       expected_stderr = ForesiteRSpec.cli_line("Cannot write to directory /usr")
       expected_exit_code = 1
 
-      expect { Foresite::Cli.new.invoke(:init) }.to output(expected_stderr).to_stderr \
+      expect { Foresite::Cli.new.invoke(:init) }.to output(expected_stderr).to_stderr
         .and(raise_error(SystemExit) { |error| expect(error.status).to eq(expected_exit_code) })
     end
 
@@ -80,7 +80,7 @@
         exptected_stderr = ForesiteRSpec.cli_line("Missing subdirectories, try running `foresite init`")
         expected_exit_code = 1
 
-        expect { Foresite::Cli.new.invoke(:touch, ["something"]) }.to output(exptected_stderr).to_stderr \
+        expect { Foresite::Cli.new.invoke(:touch, ["something"]) }.to output(exptected_stderr).to_stderr
           .and(raise_error(SystemExit) { |error| expect(error.status).to eq(expected_exit_code) })
       end
     end
@@ -220,7 +220,7 @@
         exptected_stderr = ForesiteRSpec.cli_line("Missing subdirectories, try running `foresite init`")
         expected_exit_code = 1
 
-        expect { Foresite::Cli.new.invoke(:build) }.to output(exptected_stderr).to_stderr \
+        expect { Foresite::Cli.new.invoke(:build) }.to output(exptected_stderr).to_stderr
           .and(raise_error(SystemExit) { |error| expect(error.status).to eq(expected_exit_code) })
       end
     end
@@ -235,7 +235,7 @@
         exptected_stderr = ForesiteRSpec.cli_line("No markdown files, try running `foresite touch`")
         expected_exit_code = 1
 
-        expect { Foresite::Cli.new.invoke(:build) }.to output(exptected_stderr).to_stderr \
+        expect { Foresite::Cli.new.invoke(:build) }.to output(exptected_stderr).to_stderr
           .and(raise_error(SystemExit) { |error| expect(error.status).to eq(expected_exit_code) })
       end
     end