Sha256: 84a4df657de06b1240268ffa6cce2acac944d757d21daab35209a2838f068281
Contents?: true
Size: 1.35 KB
Versions: 108
Compression:
Stored size: 1.35 KB
Contents
# frozen_string_literal: true
require_relative "./base_cop"
module GraphQL
module Rubocop
module GraphQL
# Identify (and auto-correct) any argument configuration which duplicates
# the default `required: true` property.
#
# `required: true` is default because required arguments can always be converted
# to optional arguments (`required: false`) without a breaking change. (The opposite change, from `required: false`
# to `required: true`, change.)
#
# @example
# # Both of these define `id: ID!` in GraphQL:
#
# # bad
# argument :id, ID, required: true
#
# # good
# argument :id, ID
#
class DefaultRequiredTrue < BaseCop
MSG = "`required: true` is the default and can be removed."
def_node_matcher :argument_config_with_required_true?, <<-Pattern
(
send {nil? _} :argument ... (hash <$(pair (sym :required) (true)) ...>)
)
Pattern
def on_send(node)
argument_config_with_required_true?(node) do |required_config|
add_offense(required_config) do |corrector|
cleaned_node_source = source_without_keyword_argument(node, required_config)
corrector.replace(node, cleaned_node_source)
end
end
end
end
end
end
end
Version data entries
108 entries across 108 versions & 1 rubygems