Class: MGit::HelpCommand

Inherits:
Command show all
Defined in:
lib/mgit/commands/help.rb

Instance Method Summary collapse

Methods inherited from Command

#check_arity, create, execute, instance_each, list, load_commands, register_alias, register_command, require_commands_from_directory

Methods included from Output

#perror, #pinfo, #psystem, #ptable, #pwarn

Instance Method Details

#arity ⇒ Object 



17
18
19
 
# File 'lib/mgit/commands/help.rb', line 17

def arity
  [0, 1]
end

#description ⇒ Object 



25
26
27
 
# File 'lib/mgit/commands/help.rb', line 25

def description
  'display help information'
end

#execute(args) ⇒ Object 



3
4
5
6
7
8
9
10
11
12
13
14
15
 
# File 'lib/mgit/commands/help.rb', line 3

def execute(args)
  if args.size == 0
    pinfo 'M[eta]Git - manage multiple git repositories at the same time'
    pinfo ''
    pinfo 'Usage:'
    Command.instance_each do |cmd|
      pinfo "mgit #{cmd.usage}"
      pinfo "\t- #{cmd.description}"
    end
  else
    pinfo Command.create(args[0]).help
  end
end

#usage ⇒ Object 



21
22
23
 
# File 'lib/mgit/commands/help.rb', line 21

def usage
  'help [command]'
end