Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix description formatting (possible " character) #289

Merged
merged 1 commit into from
Jan 8, 2024
Merged

Fix description formatting (possible " character) #289

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 4 additions & 7 deletions formatter/formatter.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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()
Expand Down
4 changes: 3 additions & 1 deletion formatter/testdata/baseline/FormatSchema/comments/definition.graphql
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Cat0 comment
# Cat0 comment 2
"""Cat0 description"""
"""
Cat0 description
"""
scalar Cat0
# Cat1 comment
type Cat1 {
Expand Down
8 changes: 7 additions & 1 deletion formatter/testdata/baseline/FormatSchema/comments/description.graphql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
}
28 changes: 21 additions & 7 deletions formatter/testdata/baseline/FormatSchema/comments/schema.graphql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
}
4 changes: 3 additions & 1 deletion formatter/testdata/baseline/FormatSchema/default/definition.graphql
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
"""Cat0 description"""
"""
Cat0 description
"""
scalar Cat0
type Cat1 {
name: String
Expand Down
8 changes: 7 additions & 1 deletion formatter/testdata/baseline/FormatSchema/default/description.graphql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
}
28 changes: 21 additions & 7 deletions formatter/testdata/baseline/FormatSchema/default/schema.graphql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
}
4 changes: 3 additions & 1 deletion formatter/testdata/baseline/FormatSchema/spaceIndent/definition.graphql
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
"""Cat0 description"""
"""
Cat0 description
"""
scalar Cat0
type Cat1 {
name: String
Expand Down
8 changes: 7 additions & 1 deletion formatter/testdata/baseline/FormatSchema/spaceIndent/description.graphql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
}
28 changes: 21 additions & 7 deletions formatter/testdata/baseline/FormatSchema/spaceIndent/schema.graphql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
}
4 changes: 3 additions & 1 deletion formatter/testdata/baseline/FormatSchemaDocument/comments/definition.graphql
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Cat0 comment
# Cat0 comment 2
"""Cat0 description"""
"""
Cat0 description
"""
scalar Cat0
# Cat1 comment
type Cat1 {
Expand Down
8 changes: 7 additions & 1 deletion formatter/testdata/baseline/FormatSchemaDocument/comments/description.graphql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
32 changes: 24 additions & 8 deletions formatter/testdata/baseline/FormatSchemaDocument/comments/schema.graphql
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# before schema description comment
"""schema description"""
"""
schema description
"""
# after schema description comment
schema {
# before query comment
Expand All @@ -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
}
Expand Down
4 changes: 3 additions & 1 deletion formatter/testdata/baseline/FormatSchemaDocument/default/definition.graphql
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
"""Cat0 description"""
"""
Cat0 description
"""
scalar Cat0
type Cat1 {
name: String
Expand Down
8 changes: 7 additions & 1 deletion formatter/testdata/baseline/FormatSchemaDocument/default/description.graphql
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
}
Loading
Loading