Class: RuboCop::CLI

Inherits:
Object
  • Object
show all
Includes:
Formatter::TextUtil
Defined in:
lib/rubocop/cli.rb

Overview

The CLI is a class responsible of handling all the command line interface logic.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Formatter::TextUtil

pluralize

Constructor Details

#initialize ⇒ CLI 



11
12
13
14
 
# File 'lib/rubocop/cli.rb', line 11

def initialize
  @options = {}
  @config_store = ConfigStore.new
end

Instance Attribute Details

#config_store ⇒ Object (readonly)

Returns the value of attribute config_store.



9
10
11
 
# File 'lib/rubocop/cli.rb', line 9

def config_store
  @config_store
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



9
10
11
 
# File 'lib/rubocop/cli.rb', line 9

def options
  @options
end

Instance Method Details

#run(args = ARGV) ⇒ Fixnum

Entry point for the application logic. Here we do the command line arguments processing and inspect the target files



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/rubocop/cli.rb', line 20

def run(args = ARGV)
  @options, paths = Options.new.parse(args)
  act_on_options

  runner = Runner.new(@options, @config_store)
  trap_interrupt(runner)
  all_passed = runner.run(paths)
  display_error_summary(runner.errors)

  all_passed && !runner.aborting? && runner.errors.empty? ? 0 : 1
rescue Cop::AmbiguousCopName => e
  $stderr.puts "Ambiguous cop name #{e.message} needs namespace " \
               'qualifier.'
  return 1
rescue StandardError, SyntaxError => e
  $stderr.puts e.message
  $stderr.puts e.backtrace
  return 1
end

#trap_interrupt(runner) ⇒ Object 



40
41
42
43
44
45
46
47
 
# File 'lib/rubocop/cli.rb', line 40

def trap_interrupt(runner)
  Signal.trap('INT') do
    exit!(1) if runner.aborting?
    runner.abort
    $stderr.puts
    $stderr.puts 'Exiting... Interrupt again to exit immediately.'
  end
end