Module: Ronin::Core::CLI::Generator::Options::Summary

Defined in:
lib/ronin/core/cli/generator/options/summary.rb

Overview

Adds the -S,--summary TEXT option to the generator command.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#summary ⇒ String? (readonly)

The summary text to output.

Returns:

  • (String, nil) 


48
49
50
 
# File 'lib/ronin/core/cli/generator/options/summary.rb', line 48

def summary
  @summary
end

Class Method Details

.included(command) ⇒ Object

Defines the -S,--summary TEXT option.

Parameters:



34
35
36
37
38
39
40
41
42
43
 
# File 'lib/ronin/core/cli/generator/options/summary.rb', line 34

def self.included(command)
  command.option :summary, short: '-S',
                           value: {
                             type: String,
                             usage: 'TEXT'
                           },
                           desc: 'One sentence summary' do |text|
                             @summary = text
                           end
end