class Inspec::Plugin::V2::PluginType::CliCommand

Public Class Methods

new(args, options, config) click to toggle source

initialize log options for plugins

Calls superclass method
# File lib/inspec/plugin/v2/plugin_types/cli.rb, line 11
def initialize(args, options, config)
  super(args, options, config)
  class_options = config.fetch(:class_options, nil)
  if class_options
    Inspec::Log.init(class_options["log_location"]) if class_options.key?("log_location")
    Inspec::Log.level = get_log_level(class_options["log_level"]) if class_options.key?("log_level")
  end
end
register_with_thor() click to toggle source

Register the command group with Thor. This must be called on the implementation class AFTER the the cli_command activator has been called

# File lib/inspec/plugin/v2/plugin_types/cli.rb, line 32
def self.register_with_thor
  # Figure out my activator name (= subcommand group name)
  subcommand_name = Inspec::Plugin::V2::Registry.instance \
    .find_activators(plugin_type: :cli_command, implementation_class: self) \
    .first.activator_name.to_s

  # Register with Thor
  Inspec::InspecCLI.register(self, subcommand_name, @usage_msg, @desc_msg, {})
end
subcommand_desc(usage_msg, desc_msg) click to toggle source

Provide a description for the command group.

# File lib/inspec/plugin/v2/plugin_types/cli.rb, line 25
def self.subcommand_desc(usage_msg, desc_msg)
  @usage_msg = usage_msg
  @desc_msg = desc_msg
end