123456789_123456789_123456789_123456789_123456789_

Class: RuboCop::Formatter::BaseFormatter

Overview

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

Creating Custom Formatter

You can create a custom formatter by subclassing 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:

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Constructor Details

.new(output, options = {}) ⇒ BaseFormatter

Parameters:

  • output (IO) —

    $stdout or opened file

[ GitHub ] 

  


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



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


  







Instance Attribute Details



  

    #options  ⇒ Hash  (readonly)
  



  

    
  





  


  [ GitHub ]


  

  


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



attr_reader :options


  








  

    #output  ⇒ IO  (readonly)
  



  

    
  





  
Returns:


    
  
  • 
    (IO)
—    
    

    the IO object passed to #initialize
    

    
  
    • 


  
See Also:

  
    
      
  • #initialize
    • 
      




  [ GitHub ]


  

  


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



attr_reader :output


  







Instance Method Details



  

    #file_finished(file, offenses)  
  



  

    
This method returns an undefined value.


Invoked at the end of inspecting each files.



  





  
Parameters:


  
See Also:

  



  [ GitHub ]


  

  


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



def file_finished(file, offenses); end


  








  

    #file_problems(file, errors, warnings)  
  



  

    
This method returns an undefined value.


Invoked before #file_finished for a file that a cop crashed on or
raised a warning for, or whose corrections went into an infinite loop.
Optional: a formatter implementing the API by duck typing is skipped
when it doesn’t define it.



  





  
Parameters:


    
  
  • 
    file
    (String)
—    
    

    the file path
    

    
  
    • 
  
  • 
    errors
    (Array(String))
—    
    

    the error messages as they’re printed, without colors. A cop that
crashes on every node of a kind has a message for each, naming the
line and column.
    

    
  
    • 
  
  • 
    warnings
    (Array(String))
—    
    

    the warning messages, in the same form
    

    
  
    • 





  [ GitHub ]


  

  


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



def file_problems(file, errors, warnings); end


  








  

    #file_started(file, options)  
  



  

    
This method returns an undefined value.


Invoked at the beginning of inspecting each files.



  





  
Parameters:


    
  
  • 
    file
    (String)
—    
    

    the file path
    

    
  
    • 
  
  • 
    options
    (Hash)
—    
    

    file specific information, currently this is always empty.
    

    
  
    • 





  [ GitHub ]


  

  


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



def file_started(file, options); end


  








  

    #finished(inspected_files)  
  



  

    
This method returns an undefined value.


Invoked after all files are inspected or interrupted by user.



  





  
Parameters:


    
  
  • 
    inspected_files
    (Array(String))
—    
    

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

    
  
    • 





  [ GitHub ]


  

  


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



def finished(inspected_files); end


  








  

    #started(target_files)  
  



  

    
This method returns an undefined value.


Invoked once before any files are inspected.



  





  
Parameters:


    
  
  • 
    target_files
    (Array(String))
—    
    

    all target file paths to be inspected
    

    
  
    • 





  [ GitHub ]


  

  


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



def started(target_files); end