Class: Inch::CLI::Command::Options::Suggest

Inherits:
BaseList show all
Includes:
API::Options::Suggest::DefaultAttributeValues
Defined in:
lib/inch/cli/command/options/suggest.rb

Constant Summary

Constants included from API::Options::Suggest::DefaultAttributeValues

API::Options::Suggest::DefaultAttributeValues::DEFAULT_FILE_COUNT, API::Options::Suggest::DefaultAttributeValues::DEFAULT_GRADES_TO_DISPLAY, API::Options::Suggest::DefaultAttributeValues::DEFAULT_GRADE_WEIGHTS, API::Options::Suggest::DefaultAttributeValues::DEFAULT_OBJECT_COUNT, API::Options::Suggest::DefaultAttributeValues::DEFAULT_OBJECT_MAX_SCORE, API::Options::Suggest::DefaultAttributeValues::DEFAULT_OBJECT_MIN_PRIORITY, API::Options::Suggest::DefaultAttributeValues::DEFAULT_PROPER_GRADES

Instance Attribute Summary

Attributes inherited from BaseList

#objects

Attributes inherited from Base

#codebase

Instance Method Summary collapse

Methods inherited from BaseList

#prepare_codebase

Methods inherited from Base

#description, #initialize, #name, register_command_as, run, #run, #usage

Methods included from TraceHelper

#ui

Constructor Details

This class inherits a constructor from Inch::CLI::Command::Base

Instance Method Details

#descriptionsObject


26
27
28
29
30
31
32
33
34
35
36
37
38
# File 'lib/inch/cli/command/options/suggest.rb', line 26

def descriptions
  [
    '',
    'Suggests objects and files that can be improved regarding ' \
      'their documentation.',
    '',
    'Example: ' +
      '$ inch suggest lib/**/*.rb --pedantic'.color(:cyan),
    '',
    description_hint_grades,
    description_hint_arrows
  ]
end

#set_options(opts) ⇒ Object


18
19
20
21
22
23
24
# File 'lib/inch/cli/command/options/suggest.rb', line 18

def set_options(opts)
  list_options(opts)
  suggest_options(opts)
  common_options(opts)

  yardopts_options(opts)
end