Class: Gloo::Verbs::Cls

Inherits:
Core::Verb show all
Defined in:
lib/gloo/verbs/cls.rb

Constant Summary collapse

KEYWORD = 
'clear'.freeze
KEYWORD_SHORT = 
'cls'.freeze

Constants inherited from Core::Baseo

Core::Baseo::NOT_IMPLEMENTED_ERR

Instance Attribute Summary

Attributes inherited from Core::Verb

#params, #tokens

Attributes inherited from Core::Baseo

#name

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Core::Verb

#display_value, help, inherited, #initialize, #type_display

Methods inherited from Core::Baseo

#initialize, #type_display

Constructor Details

This class inherits a constructor from Gloo::Core::Verb

Class Method Details

.doc_data ⇒ Object

Get the verb's documentation data.



42
43
44
45
46
47
48
49
50
51
 
# File 'lib/gloo/verbs/cls.rb', line 42

def self.doc_data
  {
    :name => KEYWORD,
    :shortcut => KEYWORD_SHORT,
    :description => 'Clear the console screen.',
    :syntax => [ 'clear' ],
    :result => 'The screen is cleared and cursor set to the top.',
    :examples => '> clear'
  }
end

.keyword ⇒ Object

Get the Verb's keyword.



24
25
26
 
# File 'lib/gloo/verbs/cls.rb', line 24

def self.keyword
  return KEYWORD
end

.keyword_shortcut ⇒ Object

Get the Verb's keyword shortcut.



31
32
33
 
# File 'lib/gloo/verbs/cls.rb', line 31

def self.keyword_shortcut
  return KEYWORD_SHORT
end

Instance Method Details

#run ⇒ Object

Run the verb.



17
18
19
 
# File 'lib/gloo/verbs/cls.rb', line 17

def run
  @engine.platform&.clear_screen
end