Sha256: abb7685cbc8565e5e18c9fc13d3176a50d8f80b6d8be88fdc720923635f6f685
Contents?: true
Size: 1.72 KB
Versions: 11
Compression:
Stored size: 1.72 KB
Contents
# frozen_string_literal: true
require 'rubocop'
require_relative 'signature_cop'
module RuboCop
module Cop
module Sorbet
# This cop disallows the usage of `checked(true)`. This usage could cause
# confusion; it could lead some people to believe that a method would be checked
# even if runtime checks have not been enabled on the class or globally.
# Additionally, in the event where checks are enabled, `checked(true)` would
# be redundant; only `checked(false)` or `soft` would change the behaviour.
#
# @example
#
# # bad
# sig { void.checked(true) }
#
# # good
# sig { void }
class CheckedTrueInSignature < SignatureCop
include(RuboCop::Cop::RangeHelp)
def_node_search(:offending_node, <<~PATTERN)
(send _ :checked (true))
PATTERN
MESSAGE =
'Using `checked(true)` in a method signature definition is not allowed. ' \
'`checked(true)` is the default behavior for modules/classes with runtime checks enabled. ' \
'To enable typechecking at runtime for this module, regardless of global settings, ' \
'`include(WaffleCone::RuntimeChecks)` to this module and set other methods to `checked(false)`.'
private_constant(:MESSAGE)
def on_signature(node)
error = offending_node(node).first
return unless error
add_offense(
error,
location: source_range(
processed_source.buffer,
error.location.line,
(error.location.selector.begin_pos)..(error.location.end.begin_pos),
),
message: MESSAGE
)
end
end
end
end
end
Version data entries
11 entries across 11 versions & 1 rubygems