Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/guard/guard-livereload
Guard::LiveReload automatically reload your browser when 'view' files are modified.
https://github.com/guard/guard-livereload
Last synced: 6 days ago
JSON representation
Guard::LiveReload automatically reload your browser when 'view' files are modified.
- Host: GitHub
- URL: https://github.com/guard/guard-livereload
- Owner: guard
- License: mit
- Created: 2010-10-10T10:32:56.000Z (over 14 years ago)
- Default Branch: master
- Last Pushed: 2022-11-07T16:11:15.000Z (over 2 years ago)
- Last Synced: 2024-05-18T15:45:22.808Z (9 months ago)
- Language: JavaScript
- Homepage: https://rubygems.org/gems/guard-livereload
- Size: 193 KB
- Stars: 2,105
- Watchers: 44
- Forks: 146
- Open Issues: 34
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-ruby - Guard::LiveReload - Automatically reload your browser when 'view' files are modified. (File System Listener)
README
#### :warning: :warning: :warning: Security Vulnerability: please upgrade to v2.5.2 - [details here ](https://github.com/guard/guard-livereload/issues/159). (Credits: [Michael Coyne](https://github.com/mikeycgto))
# Guard::LiveReload
[](http://badge.fury.io/rb/guard-livereload) [](http://travis-ci.org/guard/guard-livereload) [](https://gemnasium.com/guard/guard-livereload) [](https://codeclimate.com/github/guard/guard-livereload) [](https://coveralls.io/r/guard/guard-livereload)
[](https://gitter.im/guard/guard-livereload?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
LiveReload guard allows to automatically reload your browser when 'view' files are modified.
## Support
##### :warning: Guard::LiveReload is looking for a new maintainer. Please [contact me](mailto:[email protected]) if you're interested.
For any support question/issue related to `livereload` please ask on [email protected].
## Install
Please be sure to have [Guard](https://github.com/guard/guard) installed before continuing.
Install the gem:
``` bash
$ gem install guard-livereload
```
Add it to your Gemfile (inside development group):
``` ruby
group :development do
gem 'guard-livereload', '~> 2.5', require: false
end
```
Add guard definition to your Guardfile by running this command:
``` bash
$ guard init livereload
```
And to get everything running in the browser, use [rack-livereload](https://github.com/onesupercoder/rack-livereload) or install the [LiveReload Safari/Chrome/Firefox extension](http://livereload.com/extensions#installing-sections).
## Usage
For a quick start, [check out the wiki](https://github.com/guard/guard-livereload/wiki/Usage).
If you're using Rails or Rack based apps, check out [rack-livereload how it works readme section](https://github.com/onesupercoder/rack-livereload#readme).
For info about Guard and it's plugins, see [Guard usage doc](https://github.com/guard/guard#readme)
For more info about LiveReload extensions, see [LiveReload extension usage doc](https://github.com/mockko/livereload/blob/master/README-old.md) from version 1.x
## Guardfile
You can adapt your 'view' files like you want.
Please read [Guard doc](https://github.com/guard/guard#readme) for more info about Guardfile DSL.
``` ruby
guard 'livereload' do
watch(%r{app/views/.+\.(erb|haml|slim)})
watch(%r{app/helpers/.+\.rb})
watch(%r{public/.+\.(css|js|html)})
watch(%r{config/locales/.+\.yml})
# Rails Assets Pipeline
watch(%r{(app|vendor)(/assets/\w+/(.+\.(css|js|html))).*}) { |m| "/assets/#{m[3]}" }
end
```
## Options
LiveReload guard has 6 options that you can set like this:
``` ruby
guard 'livereload', grace_period: 0.5, override_url: true do
# ...
end
```
Available options:
``` ruby
notify: true # default false
host: '127.3.3.1' # default '0.0.0.0'
port: '12345' # default '35729'
apply_css_live: false # default true
override_url: false # default false
grace_period: 0.5 # default 0 (seconds)
js_template: './my_livereload.js.erb' # default is livereload.js.erb from gem
```
Additional custom JS template options (see livereload.js.erb for details):
``` ruby
js_apple_webkit_extra_wait_time: 50 # default is 5 (see issue #123)
js_default_extra_wait_time: 100 # default is 200
```
`notify` uses Guard's [system notifications](https://github.com/guard/guard/wiki/System-notifications).
See [LiveReload configuration doc](https://github.com/mockko/livereload/blob/master/README-old.md) from version 1.x for more info about other options.
## Troubleshooting
To work out what's wrong and where, just follow this easy guide: https://github.com/guard/guard-livereload/wiki/Troubleshooting
### Other issues:
##### 1. "hw.ncpu" is an unknown key.
Solution: just upgrade the `listen` gem to '3.x' (Listen is used by Guard).
(Details: https://github.com/guard/guard-livereload/issues/134)
## Development
* Source hosted at [GitHub](https://github.com/guard/guard-livereload).
* Report issues and feature requests to [GitHub Issues](https://github.com/guard/guard-livereload/issues).
Pull requests are very welcome! Please try to follow these simple "rules", though:
* Please create a topic branch for every separate change you make.
* Make sure your patches are well tested.
* Update the README (if applicable).
* Please **do not change** the version number.
For questions please join us on our [Google group](http://groups.google.com/group/guard-dev) or on `#guard` (irc.freenode.net).
## Author
[Thibaud Guillaume-Gentil](https://github.com/thibaudgg)