Class: Gloo::Verbs::Help

Inherits:
GlooLang::Core::Verb
  • Object
show all
Defined in:
lib/gloo/verbs/help.rb

Constant Summary collapse

KEYWORD = 
'help'.freeze
KEYWORD_SHORT = 
'?'.freeze
DEFAULT_HELP = 
'default_help'.freeze
HELP_NOT_FOUND_ERR = 
'Help command could not be found:'.freeze
DISPATCH = 
{
  settings: 'show_settings',
  keywords: 'show_keywords',
  verb: 'show_verbs',
  verbs: 'show_verbs',
  v: 'show_verbs',
  obj: 'show_objs',
  object: 'show_objs',
  objects: 'show_objs',
  o: 'show_objs',
  topics: 'show_topics'
}.freeze

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.keyword ⇒ Object

Get the Verb’s keyword.



40
41
42
 
# File 'lib/gloo/verbs/help.rb', line 40

def self.keyword
  return KEYWORD
end

.keyword_shortcut ⇒ Object

Get the Verb’s keyword shortcut.



47
48
49
 
# File 'lib/gloo/verbs/help.rb', line 47

def self.keyword_shortcut
  return KEYWORD_SHORT
end

Instance Method Details

#run ⇒ Object

Run the verb.



32
33
34
35
 
# File 'lib/gloo/verbs/help.rb', line 32

def run
  data = "\n For documentation use the gloo website. \n\n"
  @engine.log.show data
end