rubocop/cop/graphql/json_type.rb


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40

# frozen_string_literal: true

# This cop checks for use of GraphQL::Types::JSON types in GraphQL fields
# and arguments.
#
# @example
#
#   # bad
#   class AwfulClass
#     field :some_field, GraphQL::Types::JSON
#   end
#
#   # good
#   class GreatClass
#     field :some_field, GraphQL::Types::String
#   end

module RuboCop
  module Cop
    module Graphql
      class JSONType < RuboCop::Cop::Cop
        MSG = 'Avoid using GraphQL::Types::JSON. See: ' \
              'https://docs.gitlab.com/ee/development/api_graphql_styleguide.html#json'

        def_node_matcher :has_json_type?, <<~PATTERN
          (send nil? {:field :argument}
            (sym _)
            (const
              (const
                (const nil? :GraphQL) :Types) :JSON)
            (...)?)
        PATTERN

        def on_send(node)
          add_offense(node, location: :expression) if has_json_type?(node)
        end
      end
    end
  end
end