Fix description (#289)

vektah · Jan 8, 2024 · a942954 · a942954
1 parent bf1736a
commit a942954
Show file tree

Hide file tree

Showing 20 changed files with 210 additions and 70 deletions.
diff --git a/formatter/formatter.go b/formatter/formatter.go
@@ -110,13 +110,10 @@ func (f *formatter) WriteDescription(s string) *formatter {
 	}
 
 	f.WriteString(`"""`)
-	if ss := strings.Split(s, "\n"); len(ss) > 1 {
-		f.WriteNewline()
-		for _, s := range ss {
-			f.WriteString(s).WriteNewline()
-		}
-	} else {
-		f.WriteString(s)
+	ss := strings.Split(s, "\n")
+	f.WriteNewline()
+	for _, s := range ss {
+		f.WriteString(s).WriteNewline()
 	}
 
 	f.WriteString(`"""`).WriteNewline()

diff --git a/formatter/testdata/baseline/FormatSchema/comments/definition.graphql b/formatter/testdata/baseline/FormatSchema/comments/definition.graphql
@@ -1,6 +1,8 @@
 # Cat0 comment
 # Cat0 comment 2
-"""Cat0 description"""
+"""
+Cat0 description
+"""
 scalar Cat0
 # Cat1 comment
 type Cat1 {

diff --git a/formatter/testdata/baseline/FormatSchema/comments/description.graphql b/formatter/testdata/baseline/FormatSchema/comments/description.graphql
@@ -6,7 +6,13 @@ meow!
 # type comment
 type Cat {
 	# field description comment
-	"""Shiny brillian name."""
+	"""
+	Shiny brillian name.
+	"""
 	# field comment
 	name: String
+	"""
+	Only "meow" is allowed.
+	"""
+	speaks: String
 }
diff --git a/formatter/testdata/baseline/FormatSchema/comments/schema.graphql b/formatter/testdata/baseline/FormatSchema/comments/schema.graphql
@@ -6,36 +6,50 @@ schema {
 type TopMutation {
 	noop: Boolean
 	noop2(
-		"""noop2 foo bar"""
+		"""
+		noop2 foo bar
+		"""
 		arg: String
 	): Boolean
 	noop3(
-		"""noop3 foo bar"""
+		"""
+		noop3 foo bar
+		"""
 		arg: String
 	): Boolean
 }
 type TopQuery {
 	noop: Boolean
 	noop2(
-		"""noop2 foo bar"""
+		"""
+		noop2 foo bar
+		"""
 		arg: String
 	): Boolean
 	noop3(
-		"""noop3 foo bar"""
+		"""
+		noop3 foo bar
+		"""
 		arg: String
 	): Boolean
 }
 type TopSubscription {
 	noop: Boolean
 	noop2(
-		"""noop2 foo bar"""
+		"""
+		noop2 foo bar
+		"""
 		arg: String
 	): Boolean
 	noop3(
-		"""noop3 foo bar"""
+		"""
+		noop3 foo bar
+		"""
 		arg1: String
 
-		"""noop3 foo bar"""
+		"""
+		noop3 foo bar
+		"""
 		arg2: String
 	): Boolean
 }
diff --git a/formatter/testdata/baseline/FormatSchema/default/definition.graphql b/formatter/testdata/baseline/FormatSchema/default/definition.graphql
@@ -1,4 +1,6 @@
-"""Cat0 description"""
+"""
+Cat0 description
+"""
 scalar Cat0
 type Cat1 {
 	name: String

diff --git a/formatter/testdata/baseline/FormatSchema/default/description.graphql b/formatter/testdata/baseline/FormatSchema/default/description.graphql
@@ -3,6 +3,12 @@ Cat is best kawaii animal in the world.
 meow!
 """
 type Cat {
-	"""Shiny brillian name."""
+	"""
+	Shiny brillian name.
+	"""
 	name: String
+	"""
+	Only "meow" is allowed.
+	"""
+	speaks: String
 }
diff --git a/formatter/testdata/baseline/FormatSchema/default/schema.graphql b/formatter/testdata/baseline/FormatSchema/default/schema.graphql
@@ -6,36 +6,50 @@ schema {
 type TopMutation {
 	noop: Boolean
 	noop2(
-		"""noop2 foo bar"""
+		"""
+		noop2 foo bar
+		"""
 		arg: String
 	): Boolean
 	noop3(
-		"""noop3 foo bar"""
+		"""
+		noop3 foo bar
+		"""
 		arg: String
 	): Boolean
 }
 type TopQuery {
 	noop: Boolean
 	noop2(
-		"""noop2 foo bar"""
+		"""
+		noop2 foo bar
+		"""
 		arg: String
 	): Boolean
 	noop3(
-		"""noop3 foo bar"""
+		"""
+		noop3 foo bar
+		"""
 		arg: String
 	): Boolean
 }
 type TopSubscription {
 	noop: Boolean
 	noop2(
-		"""noop2 foo bar"""
+		"""
+		noop2 foo bar
+		"""
 		arg: String
 	): Boolean
 	noop3(
-		"""noop3 foo bar"""
+		"""
+		noop3 foo bar
+		"""
 		arg1: String
 
-		"""noop3 foo bar"""
+		"""
+		noop3 foo bar
+		"""
 		arg2: String
 	): Boolean
 }
diff --git a/formatter/testdata/baseline/FormatSchema/spaceIndent/definition.graphql b/formatter/testdata/baseline/FormatSchema/spaceIndent/definition.graphql
@@ -1,4 +1,6 @@
-"""Cat0 description"""
+"""
+Cat0 description
+"""
 scalar Cat0
 type Cat1 {
  name: String

diff --git a/formatter/testdata/baseline/FormatSchema/spaceIndent/description.graphql b/formatter/testdata/baseline/FormatSchema/spaceIndent/description.graphql
@@ -3,6 +3,12 @@ Cat is best kawaii animal in the world.
 meow!
 """
 type Cat {
- """Shiny brillian name."""
+ """
+ Shiny brillian name.
+ """
  name: String
+ """
+ Only "meow" is allowed.
+ """
+ speaks: String
 }
diff --git a/formatter/testdata/baseline/FormatSchema/spaceIndent/schema.graphql b/formatter/testdata/baseline/FormatSchema/spaceIndent/schema.graphql
@@ -6,36 +6,50 @@ schema {
 type TopMutation {
  noop: Boolean
  noop2(
-  """noop2 foo bar"""
+  """
+  noop2 foo bar
+  """
   arg: String
  ): Boolean
  noop3(
-  """noop3 foo bar"""
+  """
+  noop3 foo bar
+  """
   arg: String
  ): Boolean
 }
 type TopQuery {
  noop: Boolean
  noop2(
-  """noop2 foo bar"""
+  """
+  noop2 foo bar
+  """
   arg: String
  ): Boolean
  noop3(
-  """noop3 foo bar"""
+  """
+  noop3 foo bar
+  """
   arg: String
  ): Boolean
 }
 type TopSubscription {
  noop: Boolean
  noop2(
-  """noop2 foo bar"""
+  """
+  noop2 foo bar
+  """
   arg: String
  ): Boolean
  noop3(
-  """noop3 foo bar"""
+  """
+  noop3 foo bar
+  """
   arg1: String
 
-  """noop3 foo bar"""
+  """
+  noop3 foo bar
+  """
   arg2: String
  ): Boolean
 }
diff --git a/formatter/testdata/baseline/FormatSchemaDocument/comments/definition.graphql b/formatter/testdata/baseline/FormatSchemaDocument/comments/definition.graphql
@@ -1,6 +1,8 @@
 # Cat0 comment
 # Cat0 comment 2
-"""Cat0 description"""
+"""
+Cat0 description
+"""
 scalar Cat0
 # Cat1 comment
 type Cat1 {

diff --git a/formatter/testdata/baseline/FormatSchemaDocument/comments/description.graphql b/formatter/testdata/baseline/FormatSchemaDocument/comments/description.graphql
@@ -6,9 +6,15 @@ meow!
 # type comment
 type Cat {
 	# field description comment
-	"""Shiny brillian name."""
+	"""
+	Shiny brillian name.
+	"""
 	# field comment
 	name: String
+	"""
+	Only "meow" is allowed.
+	"""
+	speaks: String
 }
 # end of file comment
 # end of file comment 2
diff --git a/formatter/testdata/baseline/FormatSchemaDocument/comments/schema.graphql b/formatter/testdata/baseline/FormatSchemaDocument/comments/schema.graphql
@@ -1,5 +1,7 @@
 # before schema description comment
-"""schema description"""
+"""
+schema description
+"""
 # after schema description comment
 schema {
 	# before query comment
@@ -13,36 +15,50 @@ schema {
 type TopMutation {
 	noop: Boolean
 	noop2(
-		"""noop2 foo bar"""
+		"""
+		noop2 foo bar
+		"""
 		arg: String
 	): Boolean
 	noop3(
-		"""noop3 foo bar"""
+		"""
+		noop3 foo bar
+		"""
 		arg: String
 	): Boolean
 }
 type TopQuery {
 	noop: Boolean
 	noop2(
-		"""noop2 foo bar"""
+		"""
+		noop2 foo bar
+		"""
 		arg: String
 	): Boolean
 	noop3(
-		"""noop3 foo bar"""
+		"""
+		noop3 foo bar
+		"""
 		arg: String
 	): Boolean
 }
 type TopSubscription {
 	noop: Boolean
 	noop2(
-		"""noop2 foo bar"""
+		"""
+		noop2 foo bar
+		"""
 		arg: String
 	): Boolean
 	noop3(
-		"""noop3 foo bar"""
+		"""
+		noop3 foo bar
+		"""
 		arg1: String
 
-		"""noop3 foo bar"""
+		"""
+		noop3 foo bar
+		"""
 		arg2: String
 	): Boolean
 }

diff --git a/formatter/testdata/baseline/FormatSchemaDocument/default/definition.graphql b/formatter/testdata/baseline/FormatSchemaDocument/default/definition.graphql
@@ -1,4 +1,6 @@
-"""Cat0 description"""
+"""
+Cat0 description
+"""
 scalar Cat0
 type Cat1 {
 	name: String

diff --git a/formatter/testdata/baseline/FormatSchemaDocument/default/description.graphql b/formatter/testdata/baseline/FormatSchemaDocument/default/description.graphql
@@ -3,6 +3,12 @@ Cat is best kawaii animal in the world.
 meow!
 """
 type Cat {
-	"""Shiny brillian name."""
+	"""
+	Shiny brillian name.
+	"""
 	name: String
+	"""
+	Only "meow" is allowed.
+	"""
+	speaks: String
 }