class RuboCop::Formatter::SimpleTextFormatter
A basic formatter that displays only files with offenses. Offenses are displayed at compact form - just the location of the problem and the associated message.
Constants
- COLOR_FOR_SEVERITY
Public Instance Methods
Source
# File lib/rubocop/formatter/simple_text_formatter.rb, line 29 def file_finished(file, offenses) return if offenses.empty? count_stats(offenses) report_file(file, offenses) end
Source
# File lib/rubocop/formatter/simple_text_formatter.rb, line 36 def finished(inspected_files) report_summary(inspected_files.count, @total_offense_count, @total_correction_count, @total_correctable_count) end
Source
# File lib/rubocop/formatter/simple_text_formatter.rb, line 43 def report_file(file, offenses) output.puts yellow("== #{smart_path(file)} ==") offenses.each do |o| output.printf( "%<severity>s:%3<line>d:%3<column>d: %<message>s\n", severity: colored_severity_code(o), line: o.line, column: o.real_column, message: message(o) ) end end
Source
# File lib/rubocop/formatter/simple_text_formatter.rb, line 57 def report_summary(file_count, offense_count, correction_count, correctable_count) report = Report.new(file_count, offense_count, correction_count, correctable_count, rainbow, # :safe_autocorrect is a derived option based on several command-line # arguments - see RuboCop::Options#add_autocorrection_options safe_autocorrect: @options[:safe_autocorrect]) output.puts output.puts report.summary end
Source
# File lib/rubocop/formatter/simple_text_formatter.rb, line 23 def started(_target_files) @total_offense_count = 0 @total_correction_count = 0 @total_correctable_count = 0 end
Private Instance Methods
Source
# File lib/rubocop/formatter/simple_text_formatter.rb, line 85 def annotate_message(msg) msg.gsub(/`(.*?)`/m, yellow('\1')) end
Source
# File lib/rubocop/formatter/simple_text_formatter.rb, line 80 def colored_severity_code(offense) color = COLOR_FOR_SEVERITY.fetch(offense.severity.name) colorize(offense.severity.code, color) end
Source
# File lib/rubocop/formatter/simple_text_formatter.rb, line 73 def count_stats(offenses) @total_offense_count += offenses.count corrected = offenses.count(&:corrected?) @total_correction_count += corrected @total_correctable_count += offenses.count(&:correctable?) - corrected end
Source
# File lib/rubocop/formatter/simple_text_formatter.rb, line 89 def message(offense) message = if offense.corrected_with_todo? green('[Todo] ') elsif offense.corrected? green('[Corrected] ') elsif offense.correctable? yellow('[Correctable] ') else '' end "#{message}#{annotate_message(offense.message)}" end