Class: Textigniter::Help

Inherits:
Object
  • Object
show all
Defined in:
lib/textigniter/help.rb

Overview

The Help Class provides usage options to the command line for quick reference. The help class is also called when textigniter is called with no options or incorrect options.

Instance Method Summary collapse

Constructor Details

#initialize(args) ⇒ Help

Returns a new instance of Help.



6
7
8
9
10
11
12
13
14
15
 
# File 'lib/textigniter/help.rb', line 6

def initialize(args)
  STDOUT.puts "Usage:\r\n".yellow_on_black
  STDOUT.puts "   textigniter COMMAND [OPTION]\r\n".white_on_black
  # show build help
  build
  # show init help
  init
  # show scrub help
  scrub
end

Instance Method Details

#build ⇒ Object

Build help



18
19
20
21
 
# File 'lib/textigniter/help.rb', line 18

def build
  STDOUT.puts "   textigniter build".bold.white_on_black
  STDOUT.puts "   Builds static output from the textigniter environment\r\n".yellow_on_black
end

#init ⇒ Object

Init help



24
25
26
27
 
# File 'lib/textigniter/help.rb', line 24

def init
  STDOUT.puts "   textigniter init".bold.white_on_black
  STDOUT.puts "   Creates a new textigniter environment\r\n".yellow_on_black    
end

#scrub ⇒ Object

Scruby help



30
31
32
33
 
# File 'lib/textigniter/help.rb', line 30

def scrub
  STDOUT.puts "   textigniter scrub".bold.white_on_black
  STDOUT.puts "   Deletes the textigniter environment\r\n".yellow_on_black
end