Sha256: 88a29620475c5b56642b3d734ba0ad4f30fa597424c0cbcbb2bfb5713909f32e
Contents?: true
Size: 1.45 KB
Versions: 50
Compression:
Stored size: 1.45 KB
Contents
# frozen_string_literal: true
module RuboCop
module Cop
module Style
# This cop checks ensures source files have no utf-8 encoding comments.
# @example
# # bad
# # encoding: UTF-8
# # coding: UTF-8
# # -*- coding: UTF-8 -*-
class Encoding < Base
include RangeHelp
extend AutoCorrector
MSG_UNNECESSARY = 'Unnecessary utf-8 encoding comment.'
ENCODING_PATTERN = /#.*coding\s?[:=]\s?(?:UTF|utf)-8/.freeze
SHEBANG = '#!'
def on_new_investigation
return if processed_source.buffer.source.empty?
line_number = encoding_line_number(processed_source)
return unless (@message = offense(processed_source, line_number))
range = processed_source.buffer.line_range(line_number + 1)
add_offense(range, message: @message) do |corrector|
corrector.remove(range_with_surrounding_space(range: range, side: :right))
end
end
private
def offense(processed_source, line_number)
line = processed_source[line_number]
MSG_UNNECESSARY if encoding_omitable?(line)
end
def encoding_omitable?(line)
ENCODING_PATTERN.match?(line)
end
def encoding_line_number(processed_source)
line_number = 0
line_number += 1 if processed_source[line_number].start_with?(SHEBANG)
line_number
end
end
end
end
end
Version data entries
50 entries across 50 versions & 5 rubygems