print scalar descriptions

andimarek · bbakerman · commit 270ffb4f5db6 · 2017-06-05T09:32:20.000+10:00
diff --git a/src/main/java/graphql/schema/idl/SchemaPrinter.java b/src/main/java/graphql/schema/idl/SchemaPrinter.java
@@ -140,6 +140,7 @@ private TypePrinter<GraphQLScalarType> scalarPrinter() {
                 return;
             }
             if (!ScalarInfo.isStandardScalar(type)) {
+                printComments(out, type, "");
                 out.format("scalar %s\n\n", type.getName());
             }
         };
@@ -373,6 +374,8 @@ private String getDescription(Object descriptionHolder) {
             return ((GraphQLInputObjectField) descriptionHolder).getDescription();
         } else if (descriptionHolder instanceof GraphQLInterfaceType) {
             return ((GraphQLInterfaceType) descriptionHolder).getDescription();
+        } else if (descriptionHolder instanceof GraphQLScalarType) {
+            return ((GraphQLScalarType) descriptionHolder).getDescription();
         } else {
             return Assert.assertShouldNeverHappen();
         }
diff --git a/src/test/groovy/graphql/schema/idl/SchemaPrinterTest.groovy b/src/test/groovy/graphql/schema/idl/SchemaPrinterTest.groovy
@@ -434,6 +434,42 @@ type Query {
    field : Interface
 }
 
+"""
+    }
+
+    def "prints scalar description as comment"() {
+        given:
+        GraphQLScalarType myScalar = new GraphQLScalarType("Scalar", "about scalar", new Coercing() {
+            @Override
+            Object serialize(Object input) {
+                return null
+            }
+
+            @Override
+            Object parseValue(Object input) {
+                return null
+            }
+
+            @Override
+            Object parseLiteral(Object input) {
+                return null
+            }
+        });
+        GraphQLFieldDefinition fieldDefinition = newFieldDefinition()
+                .name("field").type(myScalar).build()
+        def queryType = GraphQLObjectType.newObject().name("Query").field(fieldDefinition).build()
+        def schema = GraphQLSchema.newSchema().query(queryType).build()
+        when:
+        def result = new SchemaPrinter(SchemaPrinter.Options.defaultOptions().includeScalarTypes(true)).print(schema)
+
+        then:
+        result == """type Query {
+   field : Scalar
+}
+
+#about scalar
+scalar Scalar
+
 """
     }
 

Original file line number	Diff line number	Diff line change
`@@ -140,6 +140,7 @@ private TypePrinter<GraphQLScalarType> scalarPrinter() {`
`140`	`140`	`return;`
`141`	`141`	`}`
`142`	`142`	`if (!ScalarInfo.isStandardScalar(type)) {`
	`143`	`+ printComments(out, type, "");`
`143`	`144`	`out.format("scalar %s\n\n", type.getName());`
`144`	`145`	`}`
`145`	`146`	`};`
`@@ -373,6 +374,8 @@ private String getDescription(Object descriptionHolder) {`
`373`	`374`	`return ((GraphQLInputObjectField) descriptionHolder).getDescription();`
`374`	`375`	`} else if (descriptionHolder instanceof GraphQLInterfaceType) {`
`375`	`376`	`return ((GraphQLInterfaceType) descriptionHolder).getDescription();`
	`377`	`+ } else if (descriptionHolder instanceof GraphQLScalarType) {`
	`378`	`+ return ((GraphQLScalarType) descriptionHolder).getDescription();`
`376`	`379`	`} else {`
`377`	`380`	`return Assert.assertShouldNeverHappen();`
`378`	`381`	`}`