print object descriptions

andimarek · bbakerman · commit 17b8f5628e44 · 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
@@ -18,11 +18,13 @@
 import java.io.PrintWriter;
 import java.io.StringWriter;
 import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.Comparator;
 import java.util.LinkedHashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.Stack;
+import java.util.stream.Stream;
 
 /**
  * This can print an in memory GraphQL schema back to a logical schema definition
@@ -58,7 +60,6 @@ public static Options defaultOptions() {
          * This will allow you to include introspection types that are contained in a schema
          *
          * @param flag whether to include them
-         *
          * @return options
          */
         public Options includeIntrospectionTypes(boolean flag) {
@@ -69,7 +70,6 @@ public Options includeIntrospectionTypes(boolean flag) {
          * This will allow you to include scalar types that are contained in a schema
          *
          * @param flag whether to include them
-         *
          * @return options
          */
         public Options includeScalarTypes(boolean flag) {
@@ -99,7 +99,6 @@ public SchemaPrinter(Options options) {
      * This can print an in memory GraphQL schema back to a logical schema definition
      *
      * @param schema the schema in play
-     *
      * @return the logical schema definition
      */
     public String print(GraphQLSchema schema) {
@@ -192,6 +191,7 @@ private TypePrinter<GraphQLObjectType> objectPrinter() {
             if (isIntrospectionType(type)) {
                 return;
             }
+            printComments(out, type);
             out.format("type %s {\n", type.getName());
             type.getFieldDefinitions().forEach(fd ->
                     out.format("   %s%s : %s\n",
@@ -330,4 +330,12 @@ private void printType(PrintWriter out, GraphQLType type) {
         TypePrinter<Object> printer = printer(type.getClass());
         printer.print(out, type);
     }
+
+    void printComments(PrintWriter out, GraphQLObjectType graphQLType) {
+        if (graphQLType.getDescription() == null) {
+            return;
+        }
+        Stream<String> stream = Arrays.stream(graphQLType.getDescription().split("\n"));
+        stream.map(s -> "#" + s + "\n").forEach(out::write);
+    }
 }
