class GraphQL::RakeTask

A rake task for dumping a schema as IDL or JSON.

By default, schemas are looked up by name as constants using schema_name:. You can provide a load_schema function to return your schema another way.

Use load_context: and visible? to dump schemas under certain visibility constraints.

Examples

Example: Dump a Schema to .graphql + .json files

require "graphql/rake_task"
GraphQL::RakeTask.new(schema_name: "MySchema")

# $ rake graphql:schema:dump
# Schema IDL dumped to ./schema.graphql
# Schema JSON dumped to ./schema.json

Example: Invoking the task from Ruby

require "rake"
Rake::Task["graphql:schema:dump"].invoke

Example: Providing arguments to build the introspection query

require "graphql/rake_task"
GraphQL::RakeTask.new(schema_name: "MySchema", include_is_one_of: true)

Constants

DEFAULT_OPTIONS

Attributes

dependencies [RW]

Returns

Array<String>

directory [RW]

Returns

String — directory for IDL & JSON files

idl_outfile [RW]

Returns

String — target for IDL task

include_deprecated_args [RW]

See GraphQL::Schema.as_json.

Returns

Boolean — Options for additional fields in the introspection query JSON response

include_is_one_of [RW]

See GraphQL::Schema.as_json.

Returns

Boolean — Options for additional fields in the introspection query JSON response

include_is_repeatable [RW]

See GraphQL::Schema.as_json.

Returns

Boolean — Options for additional fields in the introspection query JSON response

include_schema_description [RW]

See GraphQL::Schema.as_json.

Returns

Boolean — Options for additional fields in the introspection query JSON response

include_specified_by_url [RW]

See GraphQL::Schema.as_json.

Returns

Boolean — Options for additional fields in the introspection query JSON response

json_outfile [RW]

Returns

String — target for JSON task

load_context [RW]

Returns

<#call(task)> — A callable for loading the query context

load_schema [RW]

Returns

<#call(task)> — A proc for loading the target GraphQL schema

namespace [W]

Returns

String — Namespace for generated tasks

schema_name [RW]

See load_schema for loading a schema another way

Returns

String — By default, used to find the schema as a constant.

Public Class Methods

new (options = {}) { |self| ... }

Source

# File lib/graphql/rake_task.rb, line 115
def initialize(options = {})
  all_options = DEFAULT_OPTIONS.merge(options)
  all_options.each do |k, v|
    self.public_send("#{k}=", v)
  end

  if block_given?
    yield(self)
  end

  define_task
end

Set the parameters of this task by passing keyword arguments or assigning attributes inside the block

Public Instance Methods

rake_namespace ()

Source

# File lib/graphql/rake_task.rb, line 65
def rake_namespace
  @namespace
end