github
/
guard
зеркало из https://github.com/github/guard.git
1
0
Форкнуть 0
Код Задачи Пакеты Проекты Релизы Вики Активность
Страница: Programmatic use of guard
Страницы
. Add Readline support to Ruby on Mac OS X Analysis of inotify events for different editors Command line options for Guard Configuration files Configure keyboard shortcuts Correctly using the watchdir option Create a guard Custom matchers in watches Custom pry command cookbook Efficient Filesystem Handling Enabling Color Coding for Running Through SSH Guard 2.10.3 exits when Guardfile is changed. Guard 2.10.3 exits when Guardfile is changed Guard Plugins Guard alternatives Guardfile DSL Configuring Guard Guardfile examples Hooks and callbacks Interacting with Guard List of Guard Commands Maintainers Optimizing for large projects Programmatic use of guard Run guard with RubyMine Shared configurations System notifications Terminal colors on windows Understanding Guard Upgrade guide for existing guards to Guard v1.1 Upgrading to Guard 2.0 Use Guard programmatically cookbook What people say about Guard Which Growl library should I use Why Guard? _Header
5 Programmatic use of guard
Cezary Baginski редактировал(а) эту страницу 2016-05-01 00:43:37 +02:00

You can pass a Guardfile content or a Guardfile location progammatically when calling Guard.setup. Available options are as follow:

  • :guardfile - The path to a valid Guardfile.
  • :guardfile_contents - A string representing the content of a valid Guardfile.

Remember, without any options given, Guard will look for a Guardfile in your current directory and if it does not find one, it will look for it in your $HOME directory.

Guard.run_all can be used to run all Guard plugins. You can pass a scope to it with the :plugins / :plugin or :groups / :group options. Run Guard plugins, e.g. from a Rakefile:

require 'guard'
require 'guard/commander' # needed because of https://github.com/guard/guard/issues/793

# You can omit the call to Guard.setup, Guard.run_all will call Guard.setup
# under the hood if Guard has not been setuped yet
Guard.run_all group: :features

# or with multiple groups
Guard.run_all groups: [:features, :documentation]

Specify a custom Guardfile path:

require 'guard'
require 'guard/commander' # needed because of https://github.com/guard/guard/issues/793

Guard.setup(guardfile: '/path/to/Guardfile')

Start Guard and with a Guardfile as a string:

require 'guard'
require 'guard/commander' # needed because of https://github.com/guard/guard/issues/793

guardfile = <<-EOF
  guard 'rspec' do
    watch(%r{^spec/.+_spec\.rb$})
  end
EOF

# You can omit the call to Guard.setup, Guard.start will call Guard.setup
# under the hood if Guard has not been setuped yet
Guard.start(guardfile_contents: guardfile)

Intro

Installation

Getting Started

Troubleshooting

Advanced use of Guard

Cookbooks

Development

This wiki and the Guard README document contains a lot of information, please take your time and read these instructions carefully.

If you run into any trouble, you may start by understanding how Guard works.

We provide detailed changes for each Guard release.

Be sure to read the CONTRIBUTING guidelines before reporting a new Guard issue or open a pull request.

If you have any questions about the Guard usage or want to share some information with the Guard community, please go to one of the following places: