Class: KBuilder::Watch::ActionDisplayHelp

Inherits:
BaseAction
  • Object
show all
Defined in:
lib/k_builder/watch/action_display_help.rb

Overview

Action for displaying CLI help

Instance Attribute Summary

Attributes inherited from BaseAction

#options

Instance Method Summary collapse

Methods inherited from BaseAction

#initialize

Constructor Details

This class inherits a constructor from KBuilder::Watch::BaseAction

Instance Method Details

#run ⇒ Object 



13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
 
# File 'lib/k_builder/watch/action_display_help.rb', line 13

def run
  puts 'HELP: k_watcher [OPTION] ... DIR'
  puts ''
  puts '  -h, --help:                                   - show help'
  puts '  --debug                                       - display debug options'
  puts '  -n, --new [folder_name]                       - create a new .builders folder with setup file, optionally create it under the [FolderName]'
  puts ''
  puts ' DIR:                                           - The directory to watch, will default to current directory "."'
  puts ''
  puts 'examples'
  puts ''
  puts 'Get Help                                        - k_watcher -h'
  puts 'Debug                                           - k_watcher --debug'
  puts 'New builder project   (./.builders)             - k_watcher -n'
  puts 'New builder project   (./HelloWorld/.builders)  - k_watcher -n HelloWorld'
  puts 'Watch current folder  (.)                       - k_watcher'
  puts 'Watch the subfolder   (.builders)               - k_watcher .builders'
end