Module: CLI::Task

Defined in:
lib/cli-console/task.rb

Overview

Task module which must be included in class which provides commands

Example:

  class UI
    extend CLI::Task

    usage 'Usage: command'
    desc 'command desciption'

    def command(params)
    end

  end

Instance Method Summary collapse

Instance Method Details

#get_description(name) ⇒ String

description for command

Parameters:

  • name (String) —

    name of command

Returns:

  • (String) —

    description



52
53
54
 
# File 'lib/cli-console/task.rb', line 52

def get_description(name)
    return @@__desc__[name] if @@__desc__.key?(name)
end

#get_usage(name) ⇒ String

usage information for command

Parameters:

  • name (String) —

    name of command

Returns:

  • (String) —

    usage



59
60
61
 
# File 'lib/cli-console/task.rb', line 59

def get_usage(name)
    return @@__usage__[name] if @@__usage__.key?(name)
end