Schema lang descriptions

src/utilities/__tests__/buildASTSchema-test.js

@@ -66,6 +66,36 @@ type Hello {
     expect(output).to.equal(body);
   });
 
+  it('Supports descriptions', () => {
+    const body = `
+schema {
+  query: Hello
+}
+
+# This is a directive
+directive @foo(
+  # It has an argument
+  arg: Int
+) on FIELD
+
+# With an enum
+enum Color {
+  RED
+
+  # Not a creative color
+  GREEN
+  BLUE
+}
+
+# What a great type
+type Hello {
+  # And a field to boot
+  str: String
+}
+`;
+    const output = cycleOutput(body);
+    expect(output).to.equal(body);
+  });
 
   it('Maintains @skip & @include', () => {
     const body = `

src/utilities/__tests__/extendSchema-test.js

@@ -131,6 +131,20 @@ describe('extendSchema', () => {
     } ]);
   });
 
+  it('can describe the extended fields', async () => {
+    const ast = parse(`
+      extend type Query {
+        # New field description.
+        newField: String
+      }
+    `);
+    const extendedSchema = extendSchema(testSchema, ast);
+
+    expect(
+      extendedSchema.getType('Query').getFields().newField.description
+    ).to.equal('New field description.');
+  });
+
   it('extends objects by adding new fields', () => {
     const ast = parse(`
       extend type Foo {

src/utilities/__tests__/schemaPrinter-test.js

@@ -601,12 +601,32 @@ schema {
   query: Root
 }
 
-directive @include(if: Boolean!) on FIELD | FRAGMENT_SPREAD | INLINE_FRAGMENT
-
-directive @skip(if: Boolean!) on FIELD | FRAGMENT_SPREAD | INLINE_FRAGMENT
-
-directive @deprecated(reason: String = "No longer supported") on FIELD_DEFINITION | ENUM_VALUE
-
+# Directs the executor to include this field or fragment only when the \`if\` argument is true.
+directive @include(
+  # Included when true.
+  if: Boolean!
+) on FIELD | FRAGMENT_SPREAD | INLINE_FRAGMENT
+
+# Directs the executor to skip this field or fragment when the \`if\` argument is true.
+directive @skip(
+  # Skipped when true.
+  if: Boolean!
+) on FIELD | FRAGMENT_SPREAD | INLINE_FRAGMENT
+
+# Marks an element of a GraphQL schema as no longer supported.
+directive @deprecated(
+  # Explains why this element was deprecated, usually also including a suggestion
+  # for how to access supported similar data. Formatted in
+  # [Markdown](https://daringfireball.net/projects/markdown/).
+  reason: String = "No longer supported"
+) on FIELD_DEFINITION | ENUM_VALUE
+
+# A Directive provides a way to describe alternate runtime execution and type validation behavior in a GraphQL document.
+#
+# In some cases, you need to provide options to alter GraphQL's execution behavior
+# in ways field arguments will not suffice, such as conditionally including or
+# skipping a field. Directives provide this by describing additional information
+# to the executor.
 type __Directive {
   name: String!
   description: String
@@ -617,34 +637,76 @@ type __Directive {
   onField: Boolean! @deprecated(reason: "Use \`locations\`.")
 }
 
+# A Directive can be adjacent to many parts of the GraphQL language, a
+# __DirectiveLocation describes one such possible adjacencies.
 enum __DirectiveLocation {
+  # Location adjacent to a query operation.
   QUERY
+
+  # Location adjacent to a mutation operation.
   MUTATION
+
+  # Location adjacent to a subscription operation.
   SUBSCRIPTION
+
+  # Location adjacent to a field.
   FIELD
+
+  # Location adjacent to a fragment definition.
   FRAGMENT_DEFINITION
+
+  # Location adjacent to a fragment spread.
   FRAGMENT_SPREAD
+
+  # Location adjacent to an inline fragment.
   INLINE_FRAGMENT
+
+  # Location adjacent to a schema definition.
   SCHEMA
+
+  # Location adjacent to a scalar definition.
   SCALAR
+
+  # Location adjacent to an object type definition.
   OBJECT
+
+  # Location adjacent to a field definition.
   FIELD_DEFINITION
+
+  # Location adjacent to an argument definition.
   ARGUMENT_DEFINITION
+
+  # Location adjacent to an interface definition.
   INTERFACE
+
+  # Location adjacent to a union definition.
   UNION
+
+  # Location adjacent to an enum definition.
   ENUM
+
+  # Location adjacent to an enum value definition.
   ENUM_VALUE
+
+  # Location adjacent to an input object type definition.
   INPUT_OBJECT
+
+  # Location adjacent to an input object field definition.
   INPUT_FIELD_DEFINITION
 }
 
+# One possible value for a given Enum. Enum values are unique values, not a
+# placeholder for a string or numeric value. However an Enum value is returned in
+# a JSON response as a string.
 type __EnumValue {
   name: String!
   description: String
   isDeprecated: Boolean!
   deprecationReason: String
 }
 
+# Object and Interface types are described by a list of Fields, each of which has
+# a name, potentially a list of arguments, and a return type.
 type __Field {
   name: String!
   description: String
@@ -654,21 +716,46 @@ type __Field {
   deprecationReason: String
 }
 
+# Arguments provided to Fields or Directives and the input fields of an
+# InputObject are represented as Input Values which describe their type and
+# optionally a default value.
 type __InputValue {
   name: String!
   description: String
   type: __Type!
+
+  # A GraphQL-formatted string representing the default value for this input value.
   defaultValue: String
 }
 
+# A GraphQL Schema defines the capabilities of a GraphQL server. It exposes all
+# available types and directives on the server, as well as the entry points for
+# query, mutation, and subscription operations.
 type __Schema {
+  # A list of all types supported by this server.
   types: [__Type!]!
+
+  # The type that query operations will be rooted at.
   queryType: __Type!
+
+  # If this server supports mutation, the type that mutation operations will be rooted at.
   mutationType: __Type
+
+  # If this server support subscription, the type that subscription operations will be rooted at.
   subscriptionType: __Type
+
+  # A list of all directives supported by this server.
   directives: [__Directive!]!
 }
 
+# The fundamental unit of any GraphQL Schema is the type. There are many kinds of
+# types in GraphQL as represented by the \`__TypeKind\` enum.
+#
+# Depending on the kind of a type, certain fields describe information about that
+# type. Scalar types provide no information beyond a name and description, while
+# Enum types provide their values. Object and Interface types provide the fields
+# they describe. Abstract types, Union and Interface, provide the Object types
+# possible at runtime. List and NonNull types compose other types.
 type __Type {
   kind: __TypeKind!
   name: String
@@ -681,17 +768,34 @@ type __Type {
   ofType: __Type
 }
 
+# An enum describing what kind of type a given \`__Type\` is.
 enum __TypeKind {
+  # Indicates this type is a scalar.
   SCALAR
+
+  # Indicates this type is an object. \`fields\` and \`interfaces\` are valid fields.
   OBJECT
+
+  # Indicates this type is an interface. \`fields\` and \`possibleTypes\` are valid fields.
   INTERFACE
+
+  # Indicates this type is a union. \`possibleTypes\` is a valid field.
   UNION
+
+  # Indicates this type is an enum. \`enumValues\` is a valid field.
   ENUM
+
+  # Indicates this type is an input object. \`inputFields\` is a valid field.
   INPUT_OBJECT
+
+  # Indicates this type is a list. \`ofType\` is a valid field.
   LIST
+
+  # Indicates this type is a non-null. \`ofType\` is a valid field.
   NON_NULL
 }
 `;
+    console.error(output); // eslint-disable-line
     expect(output).to.equal(introspectionSchema);
   });
 });