Class: RuboCop::Formatter::BaseFormatter

Inherits:
Object
  • Object
show all
Defined in:
lib/rubocop/formatter/base_formatter.rb

Overview

Abstract base class for formatter, implements all public API methods.

## Creating Custom Formatter

You can create a custom formatter by subclassing RuboCop::Formatter::BaseFormatter and overriding some methods, or by implementing all the methods by duck typing.

## Using Custom Formatter in Command Line

You can tell RuboCop to use your custom formatter with a combination of --format and --require option. For example, when you have defined MyCustomFormatter in ./path/to/my_custom_formatter.rb, you would type this command:

rubocop --require ./path/to/my_custom_formatter --format MyCustomFormatter

Note: The path passed to --require is directly passed to Kernel.require. If your custom formatter file is not in ‘$LOAD_PATH`, you need to specify the path as relative path prefixed with ./ explicitly, or absolute path.

## Method Invocation Order

For example, when RuboCop inspects 2 files, the invocation order should be like this:

  • #initialize

  • #started

  • #file_started

  • #file_finished

  • #file_started

  • #file_finished

  • #finished

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(output, options = {}) ⇒ BaseFormatter

Returns a new instance of BaseFormatter.

Parameters:

  • ‘$stdout` or opened file

API:

  • public



67
68
69
70
 
# File 'lib/rubocop/formatter/base_formatter.rb', line 67

def initialize(output, options = {})
  @output = output
  @options = options
end

Instance Attribute Details

#options ⇒ Hash (readonly)

Returns:

API:

  • public



61
62
63
 
# File 'lib/rubocop/formatter/base_formatter.rb', line 61

def options
  @options
end

#output ⇒ IO (readonly)

Returns the IO object passed to #initialize.

Returns:

  • the IO object passed to #initialize

See Also:

API:

  • public



54
55
56
 
# File 'lib/rubocop/formatter/base_formatter.rb', line 54

def output
  @output
end

Instance Method Details

#file_finished(file, offenses) ⇒ void

This method returns an undefined value.

Invoked at the end of inspecting each files.

Parameters:

  • the file path

  • all detected offenses for the file

See Also:

API:

  • public



108
 
# File 'lib/rubocop/formatter/base_formatter.rb', line 108

def file_finished(file, offenses); end

#file_started(file, options) ⇒ void

This method returns an undefined value.

Invoked at the beginning of inspecting each files.

Parameters:

  • the file path

  • file specific information, currently this is always empty.

API:

  • public



93
 
# File 'lib/rubocop/formatter/base_formatter.rb', line 93

def file_started(file, options); end

#finished(inspected_files) ⇒ void

This method returns an undefined value.

Invoked after all files are inspected, or interrupted by user.

Parameters:

  • the inspected file paths. This would be same as target_files passed to #started unless RuboCop is interrupted by user.

API:

  • public



120
 
# File 'lib/rubocop/formatter/base_formatter.rb', line 120

def finished(inspected_files); end

#started(target_files) ⇒ void

This method returns an undefined value.

Invoked once before any files are inspected.

Parameters:

  • all target file paths to be inspected

API:

  • public



80
 
# File 'lib/rubocop/formatter/base_formatter.rb', line 80

def started(target_files); end