Class: Inch::CLI::Command::Options::List

Inherits:
BaseList show all
Defined in:
lib/inch/cli/command/options/list.rb

Constant Summary

Constants inherited from Base

Base::EXIT_STATUS_SUCCESS

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, #exit_status, #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

#descriptions ⇒ Object 



8
9
10
11
12
13
14
15
16
17
18
19
 
# File 'lib/inch/cli/command/options/list.rb', line 8

def descriptions
  [
    '',
    'Lists objects that can be improved regarding their ' \
      'documentation ordered by their grade.',
    '',
    'Example: ' + '$ inch list lib/**/*.rb --all'.color(:cyan),
    '',
    description_hint_grades,
    description_hint_arrows
  ]
end

#list_options(opts) ⇒ Object 



21
22
23
24
25
26
 
# File 'lib/inch/cli/command/options/list.rb', line 21

def list_options(opts)
  super
  opts.on('--numbers', 'Show numbers instead of grades and arrows') do
    @numbers = true
  end
end