Module: Thor::Actions::ClassMethods

Defined in:
lib/thor/actions.rb

Instance Method Summary collapse

Instance Method Details

#add_runtime_options! ⇒ Object

Add runtime options that help actions execution.



48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/thor/actions.rb', line 48

def add_runtime_options!
  class_option :force, type: :boolean, aliases: "-f", group: :runtime,
                       desc: "Overwrite files that already exist"

  class_option :pretend, type: :boolean, aliases: "-p", group: :runtime,
                         desc: "Run but do not make any changes"

  class_option :quiet, type: :boolean, aliases: "-q", group: :runtime,
                       desc: "Suppress status output"

  class_option :skip, type: :boolean, aliases: "-s", group: :runtime,
                      desc: "Skip files that already exist"
end

#source_paths ⇒ Object

Hold source paths for one Thor instance. source_paths_for_search is the method responsible to gather source_paths from this current class, inherited paths and the source root.



22
23
24
 
# File 'lib/thor/actions.rb', line 22

def source_paths
  @_source_paths ||= []
end

#source_paths_for_search ⇒ Object

Returns the source paths in the following order:

1) This class source paths
2) Source root
3) Parents source paths



38
39
40
41
42
43
44
 
# File 'lib/thor/actions.rb', line 38

def source_paths_for_search
  paths = []
  paths += source_paths
  paths << source_root if source_root
  paths += from_superclass(:source_paths, [])
  paths
end

#source_root(path = nil) ⇒ Object

Stores and return the source root for this class



27
28
29
30
 
# File 'lib/thor/actions.rb', line 27

def source_root(path = nil)
  @_source_root = path if path
  @_source_root ||= nil
end