Module: Clin

Defined in:

lib/clin.rb,
lib/clin/errors.rb,
lib/clin/version.rb

Overview

Clin version

Defined Under Namespace

Classes: Argument, Command, CommandDispatcher, CommandOptionsMixin, CommandParser, FixedArgumentError, GeneralOption, HelpOptions, MissingArgumentError, Option, OptionList

Constant Summary

Error =

Parent error class for all Clin errors

Class.new(RuntimeError)

CommandLineError =

Error cause by the user input(when parsing command)

Class.new(Error)

HelpError =

Error when the help needs to be shown

Class.new(CommandLineError)

ArgumentError =

Error when an positional argument is wrong

Class.new(CommandLineError)

OptionError =

Error when a option is wrong

Class.new(CommandLineError)

VERSION =

'0.2.0'

Class Attribute Summary

• .exe_name ⇒ Object

  Global exe_name If this is not override it will be ‘command’.

Class Method Summary

• .default_exe_name ⇒ Object

Class Attribute Details

.exe_name ⇒ Object

Global exe_name If this is not override it will be ‘command’

# File 'lib/clin.rb', line 18

def exe_name
  @exe_name ||= Clin.default_exe_name
end

Class Method Details

.default_exe_name ⇒ Object

# File 'lib/clin.rb', line 12

def default_exe_name
  'command'
end