faustinoaq / watcher

Crystal shard to watch file changes using File.stat

Crystal shard to watch file changes. This shard use the same code implemented here (Guardian) and here (Sentry).

Installation

Add this to your application's shard.yml:

dependencies:
  watcher:
    github: faustinoaq/watcher

Usage

Use the keyword watch to watch files or file groups, for example:

require "watcher"

watch "src/assets/js/*.js" do |event|
  event.on_change do |files|
    files.each do |file, {first, timestamp}|
      puts "File #{file} has changed at #{timestamp}"
    end
    # ...
  end
end

Also you can have more than one watcher, just use spawn

spawn do
  watch ["src/assets/*.css", "src/views/*.html"] do |event|
    event.on_change do
      # ...
    end
  end
end

# Other watcher
watch ... do |event|
 #...
end

And you can change time interval for a watcher.

watch "public/*.json", interval: 0.5 do |event|
  event.on_change do
    # ...
  end
end

Also you can use Watcher.watch instead of watch.

How does it work?

Watcher uses timestamps to check file changes every second, if you want some more advanced then you can use Watchbird that uses libnotify to check events like modify, access and delete but just work in Linux for now.

Contributing

1. Fork it ( https://github.com/faustinoaq/watcher/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request

Contributors

• faustinoaq Faustino Aguilar - creator, maintainer

watcher's Issues

Wathcer logo offer

Hi sir. I want to contribute for watcher. I degined a logo for readme file.

Logo Idea: watch file changes... If you want it, i will send a pull-request. Please fedback me. Good works!

Stuck in a loop

At some point this seems to have stopped working - and now the watcher thinks that the files have changed continuously even though there were no file changes.

on every loop the event._on_change reports the file landing.html has changed but it hasn't

1. "src/webapp/public/landing.html" => {true, "20191009174705.775"}
2. "src/webapp/public/landing.html" => {true, "20191009174705.775"}
   3 ... and forever etc