Class Guard::DslDescriber
In: lib/guard/dsl_describer.rb
Parent: Dsl

The DslDescriber overrides methods to create an internal structure of the Guardfile that is used in some inspection utility methods like the CLI commands `show` and `list`.

@see Guard::Dsl @see Guard::CLI

Methods

Public Class methods

Evaluate the DSL methods in the `Guardfile`.

@option options [Array<Symbol,String>] groups the groups to evaluate @option options [String] guardfile the path to a valid Guardfile @option options [String] guardfile_contents a string representing the content of a valid Guardfile @raise [ArgumentError] when options are not a Hash

List the Guard plugins that are available for use in your system and marks those that are currently used in your `Guardfile`.

@example Guard list output

  Available guards:
    bundler *
    livereload
    ronn
    rspec *
    spork

  See also https://github.com/guard/guard/wiki/List-of-available-Guards
  * denotes ones already in your Guardfile

@param [Hash] options the Guard options

Shows all Guard plugins and their options that are defined in the `Guardfile`.

@example guard show output

  (global):
    bundler
    coffeescript: input => "app/assets/javascripts", noop => true
    jasmine
    rspec: cli => "--fail-fast --format Fuubar

@param [Hash] options the Guard options

[Validate]