Class: Clin::HelpOptions

Inherits:

GeneralOption

• Object
• GeneralOption
• Clin::HelpOptions

Defined in:

lib/clin/common/help_options.rb

Overview

Help option class Add the help option to you command “‘ class MyCommand < Clin::Command

general_option Clin::HelpOptions

end “‘ Then running you command with -h or –help will show the help menu

Instance Method Summary

• #execute(options) ⇒ Object
• #initialize(raise: true) ⇒ HelpOptions constructor

  A new instance of HelpOptions.

Constructor Details

#initialize(raise: true) ⇒ HelpOptions

Returns a new instance of HelpOptions.

# File 'lib/clin/common/help_options.rb', line 17

def initialize(raise: true)
  @raise = raise
end

Instance Method Details

#execute(options) ⇒ Object

# File 'lib/clin/common/help_options.rb', line 21

def execute(options)
  return unless @raise
  fail Clin::HelpError, options[:help] if options[:help]
end