Sha256: 016836dc9c9838d1d9706735d416348b55097dbedd59e20eaf6bb83cd0375b56
Contents?: true
Size: 1.64 KB
Versions: 201
Compression:
Stored size: 1.64 KB
Contents
# frozen_string_literal: true
module RuboCop
module Formatter
# This formatter formats report data as GitHub Workflow commands resulting
# in GitHub check annotations when run within GitHub Actions.
class GitHubActionsFormatter < BaseFormatter
ESCAPE_MAP = { '%' => '%25', "\n" => '%0A', "\r" => '%0D' }.freeze
def started(_target_files)
@offenses_for_files = {}
end
def file_finished(file, offenses)
@offenses_for_files[file] = offenses unless offenses.empty?
end
def finished(_inspected_files)
@offenses_for_files.each do |file, offenses|
offenses.each do |offense|
report_offense(file, offense)
end
end
output.puts
end
private
def github_escape(string)
string.gsub(Regexp.union(ESCAPE_MAP.keys), ESCAPE_MAP)
end
def minimum_severity_to_fail
@minimum_severity_to_fail ||= begin
# Unless given explicitly as `fail_level`, `:info` severity offenses do not fail
name = options.fetch(:fail_level, :refactor)
RuboCop::Cop::Severity.new(name)
end
end
def github_severity(offense)
offense.severity < minimum_severity_to_fail ? 'warning' : 'error'
end
def report_offense(file, offense)
output.printf(
"\n::%<severity>s file=%<file>s,line=%<line>d,col=%<column>d::%<message>s",
severity: github_severity(offense),
file: PathUtil.smart_path(file),
line: offense.line,
column: offense.real_column,
message: github_escape(offense.message)
)
end
end
end
end
Version data entries
201 entries across 194 versions & 20 rubygems