https://github.com/faustinoaq/watcher

Crystal shard to watch file changes using File.stat
https://github.com/faustinoaq/watcher

crystal monitor

Last synced: 15 days ago
JSON representation

Crystal shard to watch file changes using File.stat

• Host: GitHub
• URL: https://github.com/faustinoaq/watcher
• Owner: faustinoaq
• License: mit
• Created: 2017-03-29T14:24:51.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2018-06-18T19:59:15.000Z (over 6 years ago)
• Last Synced: 2024-08-01T17:34:06.818Z (3 months ago)
• Topics: crystal, monitor
• Language: Crystal
• Size: 176 KB
• Stars: 21
• Watchers: 2
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-crystal - watcher - Watch file changes using File.stat (Development Tools)
• awesome-crystal - watcher - Watch file changes using File.stat (Development Tools)

README

        


[![Build Status](https://travis-ci.org/faustinoaq/watcher.svg?branch=master)](https://travis-ci.org/faustinoaq/watcher)

Crystal shard to watch file changes. This shard use the same code implemented [here (Guardian)](https://github.com/f/guardian/blob/master/src/guardian/watcher.cr#L45) and [here (Sentry)](https://github.com/samueleaton/sentry/blob/master/src/sentry.cr#L52).

## Installation

Add this to your application's `shard.yml`:

```yaml

dependencies:

  watcher:

    github: faustinoaq/watcher

```

## Usage

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

```crystal

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`

```crystal

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.

```crystal

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](https://github.com/agatan/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](https://github.com/faustinoaq) Faustino Aguilar - creator, maintainer