Class: Guard::CoffeeScript

Inherits:
Guard
  • Object
show all
Defined in:
lib/guard/coffeescript.rb,
lib/guard/coffeescript/runner.rb,
lib/guard/coffeescript/formatter.rb,
lib/guard/coffeescript/inspector.rb

Overview

The CoffeeScript guard that gets notifications about the following Guard events: start, stop, reload, run_all and run_on_change.

Defined Under Namespace

Modules: Formatter, Inspector, Runner

Constant Summary collapse

DEFAULT_OPTIONS = 
{
    :bare         => false,
    :shallow      => false,
    :hide_success => false,
    :noop         => false,
    :error_to_js  => false,
    :all_on_start => false
}

Instance Method Summary collapse

Constructor Details

#initialize(watchers = [], options = {}) ⇒ CoffeeScript

Initialize Guard::CoffeeScript.

Parameters:

  • watchers (Array<Guard::Watcher>) (defaults to: []) —

    the watchers in the Guard block

  • options (Hash) (defaults to: {}) —

    the options for the Guard

Options Hash (options):

  • :input (String) —

    the input directory

  • :output (String) —

    the output directory

  • :bare (Boolean) —

    do not wrap the output in a top level function

  • :shallow (Boolean) —

    do not create nested directories

  • :hide_success (Boolean) —

    hide success message notification

  • :all_on_start (Boolean) —

    generate all JavaScripts files on start

  • :noop (Boolean) —

    do not generate an output file



37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/guard/coffeescript.rb', line 37

def initialize(watchers = [], options = {})
  watchers = [] if !watchers
  defaults = DEFAULT_OPTIONS.clone

  if options[:input]
    defaults.merge!({ :output => options[:input] })
    watchers << ::Guard::Watcher.new(%r{^#{ options.delete(:input) }/(.+\.coffee)$})
  end

  super(watchers, defaults.merge(options))
end

Instance Method Details

#run_all ⇒ Object

Gets called when all files should be regenerated.

Raises:

  • (:task_has_failed) —

    when stop has failed



61
62
63
 
# File 'lib/guard/coffeescript.rb', line 61

def run_all
  run_on_changes(Watcher.match_files(self, Dir.glob('**{,/*/**}/*.coffee')))
end

#run_on_changes(paths) ⇒ Object

Gets called when watched paths and files have changes.

Parameters:

  • paths (Array<String>) —

    the changed paths and files

Raises:

  • (:task_has_failed) —

    when stop has failed



70
71
72
73
74
 
# File 'lib/guard/coffeescript.rb', line 70

def run_on_changes(paths)
  changed_files, success = Runner.run(Inspector.clean(paths), watchers, options)

  throw :task_has_failed unless success
end

#run_on_removals(paths) ⇒ Object

Called on file(s) deletions that the Guard watches.

Parameters:

  • paths (Array<String>) —

    the deleted files or paths

Raises:

  • (:task_has_failed) —

    when run_on_change has failed



81
82
83
 
# File 'lib/guard/coffeescript.rb', line 81

def run_on_removals(paths)
  Runner.remove(Inspector.clean(paths, :missing_ok => true), watchers, options)
end

#start ⇒ Object

Gets called once when Guard starts.

Raises:

  • (:task_has_failed) —

    when stop has failed



53
54
55
 
# File 'lib/guard/coffeescript.rb', line 53

def start
  run_all if options[:all_on_start]
end