Sha256: d79925d929555f4b1735b79c9f2eed120af941676e5734fd0194d73acd478054
Contents?: true
Size: 1.49 KB
Versions: 10
Compression:
Stored size: 1.49 KB
Contents
# frozen_string_literal: true
require "rubocop"
require_relative "signature_cop"
module RuboCop
module Cop
module Sorbet
# This cop checks for the ordering of keyword arguments required by
# sorbet-runtime. The ordering requires that all keyword arguments
# are at the end of the parameters list, and all keyword arguments
# with a default value must be after those without default values.
#
# @example
#
# # bad
# sig { params(a: Integer, b: String).void }
# def foo(a: 1, b:); end
#
# # good
# sig { params(b: String, a: Integer).void }
# def foo(b:, a: 1); end
class KeywordArgumentOrdering < SignatureCop
def on_signature(node)
method_node = node.parent.children[node.sibling_index + 1]
return if method_node.nil?
method_parameters = method_node.arguments
check_order_for_kwoptargs(method_parameters)
end
private
def check_order_for_kwoptargs(parameters)
out_of_kwoptarg = false
parameters.reverse.each do |param|
out_of_kwoptarg = true unless param.type == :kwoptarg || param.type == :blockarg || param.type == :kwrestarg
next unless param.type == :kwoptarg && out_of_kwoptarg
add_offense(
param,
message: "Optional keyword arguments must be at the end of the parameter list."
)
end
end
end
end
end
end
Version data entries
10 entries across 10 versions & 1 rubygems