{"id":13426842,"url":"https://github.com/guard/guard-livereload","last_synced_at":"2025-05-14T00:10:28.267Z","repository":{"id":1108608,"uuid":"976103","full_name":"guard/guard-livereload","owner":"guard","description":"Guard::LiveReload automatically reload your browser when 'view' files are modified.","archived":false,"fork":false,"pushed_at":"2022-11-07T16:11:15.000Z","size":198,"stargazers_count":2112,"open_issues_count":34,"forks_count":144,"subscribers_count":42,"default_branch":"master","last_synced_at":"2025-05-04T02:03:05.651Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://rubygems.org/gems/guard-livereload","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"AtomLinter/linter-puppet-lint","license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/guard.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2010-10-10T10:32:56.000Z","updated_at":"2025-03-12T23:32:53.000Z","dependencies_parsed_at":"2023-01-13T10:56:56.420Z","dependency_job_id":null,"html_url":"https://github.com/guard/guard-livereload","commit_stats":null,"previous_names":[],"tags_count":43,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/guard%2Fguard-livereload","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/guard%2Fguard-livereload/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/guard%2Fguard-livereload/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/guard%2Fguard-livereload/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/guard","download_url":"https://codeload.github.com/guard/guard-livereload/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253474206,"owners_count":21914227,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-07-31T00:01:46.355Z","updated_at":"2025-05-14T00:10:23.259Z","avatar_url":"https://github.com/guard.png","language":"JavaScript","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))\n\n# Guard::LiveReload\n\n[![Gem Version](https://badge.fury.io/rb/guard-livereload.svg)](http://badge.fury.io/rb/guard-livereload) [![Build Status](https://travis-ci.org/guard/guard-livereload.svg?branch=master)](http://travis-ci.org/guard/guard-livereload) [![Dependency Status](https://gemnasium.com/guard/guard-livereload.svg)](https://gemnasium.com/guard/guard-livereload) [![Code Climate](https://codeclimate.com/github/guard/guard-livereload.svg)](https://codeclimate.com/github/guard/guard-livereload) [![Coverage Status](https://coveralls.io/repos/guard/guard-livereload/badge.svg?branch=master)](https://coveralls.io/r/guard/guard-livereload)\n[![Join the chat at https://gitter.im/guard/guard-livereload](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/guard/guard-livereload?utm_source=badge\u0026utm_medium=badge\u0026utm_campaign=pr-badge\u0026utm_content=badge)\n\n\nLiveReload guard allows to automatically reload your browser when 'view' files are modified.\n\n## Support\n\n##### :warning: Guard::LiveReload is looking for a new maintainer. Please [contact me](mailto:thibaud@thibaud.gg) if you're interested.\n\nFor any support question/issue related to `livereload` please ask on support@livereload.com.\n\n## Install\n\nPlease be sure to have [Guard](https://github.com/guard/guard) installed before continuing.\n\nInstall the gem:\n\n``` bash\n$ gem install guard-livereload\n```\n\nAdd it to your Gemfile (inside development group):\n\n``` ruby\ngroup :development do\n  gem 'guard-livereload', '~\u003e 2.5', require: false\nend\n```\n\nAdd guard definition to your Guardfile by running this command:\n\n``` bash\n$ guard init livereload\n```\n\nAnd 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).\n\n## Usage\n\nFor a quick start, [check out the wiki](https://github.com/guard/guard-livereload/wiki/Usage).\n\nIf you're using Rails or Rack based apps, check out [rack-livereload how it works readme section](https://github.com/onesupercoder/rack-livereload#readme).\n\nFor info about Guard and it's plugins, see [Guard usage doc](https://github.com/guard/guard#readme)\n\nFor more info about LiveReload extensions, see [LiveReload extension usage doc](https://github.com/mockko/livereload/blob/master/README-old.md) from version 1.x\n\n\n## Guardfile\n\nYou can adapt your 'view' files like you want.\nPlease read [Guard doc](https://github.com/guard/guard#readme) for more info about Guardfile DSL.\n\n``` ruby\nguard 'livereload' do\n  watch(%r{app/views/.+\\.(erb|haml|slim)})\n  watch(%r{app/helpers/.+\\.rb})\n  watch(%r{public/.+\\.(css|js|html)})\n  watch(%r{config/locales/.+\\.yml})\n  # Rails Assets Pipeline\n  watch(%r{(app|vendor)(/assets/\\w+/(.+\\.(css|js|html))).*}) { |m| \"/assets/#{m[3]}\" }\nend\n```\n\n## Options\n\nLiveReload guard has 6 options that you can set like this:\n\n``` ruby\nguard 'livereload', grace_period: 0.5, override_url: true do\n  # ...\nend\n```\n\nAvailable options:\n\n``` ruby\nnotify: true          # default false\nhost: '127.3.3.1'     # default '0.0.0.0'\nport: '12345'         # default '35729'\napply_css_live: false # default true\noverride_url: false   # default false\ngrace_period: 0.5     # default 0 (seconds)\njs_template: './my_livereload.js.erb' # default is livereload.js.erb from gem\n```\n\nAdditional custom JS template options (see livereload.js.erb for details):\n``` ruby\njs_apple_webkit_extra_wait_time: 50 # default is 5 (see issue #123)\njs_default_extra_wait_time: 100 # default is 200\n```\n\n\n`notify` uses Guard's [system notifications](https://github.com/guard/guard/wiki/System-notifications).\nSee [LiveReload configuration doc](https://github.com/mockko/livereload/blob/master/README-old.md) from version 1.x for more info about other options.\n\n## Troubleshooting\n\nTo work out what's wrong and where, just follow this easy guide: https://github.com/guard/guard-livereload/wiki/Troubleshooting\n\n### Other issues:\n\n##### 1. \"hw.ncpu\" is an unknown key.\n\nSolution: just upgrade the `listen` gem to '3.x' (Listen is used by Guard).\n\n(Details: https://github.com/guard/guard-livereload/issues/134)\n\n## Development\n\n* Source hosted at [GitHub](https://github.com/guard/guard-livereload).\n* Report issues and feature requests to [GitHub Issues](https://github.com/guard/guard-livereload/issues).\n\nPull requests are very welcome! Please try to follow these simple \"rules\", though:\n\n* Please create a topic branch for every separate change you make.\n* Make sure your patches are well tested.\n* Update the README (if applicable).\n* Please **do not change** the version number.\n\nFor questions please join us on our [Google group](http://groups.google.com/group/guard-dev) or on `#guard` (irc.freenode.net).\n\n## Author\n\n[Thibaud Guillaume-Gentil](https://github.com/thibaudgg)\n","funding_links":[],"categories":["JavaScript","Workflow","Middlewares","File System Listener"],"sub_categories":["Visual Studio Code"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fguard%2Fguard-livereload","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fguard%2Fguard-livereload","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fguard%2Fguard-livereload/lists"}