Remove the extra whitespace before the query arguments and fragment name (#362)

git-hulk · web-flow · commit bcc3a70db2f0 · 2025-04-09T17:02:13.000-04:00
* Add the compacted option to opt in the compacted formatter

* Add test case
diff --git a/formatter/formatter.go b/formatter/formatter.go
@@ -47,6 +47,13 @@ func WithoutDescription() FormatterOption {
 	}
 }
 
+// WithCompacted enables compacted output, which removes all unnecessary whitespace.
+func WithCompacted() FormatterOption {
+	return func(f *formatter) {
+		f.compacted = true
+	}
+}
+
 func NewFormatter(w io.Writer, options ...FormatterOption) Formatter {
 	f := &formatter{
 		indent: "\t",
@@ -66,6 +73,7 @@ type formatter struct {
 	emitBuiltin     bool
 	emitComments    bool
 	omitDescription bool
+	compacted       bool
 
 	padNext  bool
 	lineHead bool
@@ -553,6 +561,9 @@ func (f *formatter) FormatOperationDefinition(def *ast.OperationDefinition) {
 	f.WriteWord(string(def.Operation))
 	if def.Name != "" {
 		f.WriteWord(def.Name)
+		if f.compacted {
+			f.NoPadding()
+		}
 	}
 	f.FormatVariableDefinitionList(def.VariableDefinitions)
 	f.FormatDirectiveList(def.Directives)
@@ -707,7 +718,11 @@ func (f *formatter) FormatField(field *ast.Field) {
 func (f *formatter) FormatFragmentSpread(spread *ast.FragmentSpread) {
 	f.FormatCommentGroup(spread.Comment)
 
-	f.WriteWord("...").WriteWord(spread.Name)
+	f.WriteWord("...")
+	if f.compacted {
+		f.NoPadding()
+	}
+	f.WriteWord(spread.Name)
 
 	f.FormatDirectiveList(spread.Directives)
 }
diff --git a/formatter/formatter_test.go b/formatter/formatter_test.go
@@ -26,6 +26,7 @@ var optionSets = []struct {
 	{"spaceIndent", []formatter.FormatterOption{formatter.WithIndent(" ")}},
 	{"comments", []formatter.FormatterOption{formatter.WithComments()}},
 	{"no_description", []formatter.FormatterOption{formatter.WithoutDescription()}},
+	{"compacted", []formatter.FormatterOption{formatter.WithCompacted()}},
 }
 
 func TestFormatter_FormatSchema(t *testing.T) {
diff --git a/formatter/testdata/baseline/FormatQueryDocument/compacted/basic.graphql b/formatter/testdata/baseline/FormatQueryDocument/compacted/basic.graphql
@@ -0,0 +1,7 @@
+query FooBarQuery($after: String!) {
+	fizzList(first: 100, after: $after) {
+		nodes {
+			id
+		}
+	}
+}
diff --git a/formatter/testdata/baseline/FormatQueryDocument/compacted/field.graphql b/formatter/testdata/baseline/FormatQueryDocument/compacted/field.graphql
@@ -0,0 +1,3 @@
+query {
+	bar: foo
+}
diff --git a/formatter/testdata/baseline/FormatQueryDocument/compacted/fragment.graphql b/formatter/testdata/baseline/FormatQueryDocument/compacted/fragment.graphql
@@ -0,0 +1,18 @@
+query FooBarQuery($after: String!) {
+	fizzList(first: 100, after: $after) {
+		nodes {
+			id
+			...FooFragment
+			... on Foo {
+				id
+			}
+			... {
+				id
+			}
+			name
+		}
+	}
+}
+fragment FooFragment on Foo {
+	id
+}
diff --git a/formatter/testdata/baseline/FormatQueryDocument/compacted/variable.graphql b/formatter/testdata/baseline/FormatQueryDocument/compacted/variable.graphql
@@ -0,0 +1,8 @@
+query ($first: Int = 30, $after: String!) {
+	searchCats(first: $first, after: $after) {
+		nodes {
+			id
+			name
+		}
+	}
+}
diff --git a/formatter/testdata/baseline/FormatSchema/compacted/comment.graphql b/formatter/testdata/baseline/FormatSchema/compacted/comment.graphql
diff --git a/formatter/testdata/baseline/FormatSchema/compacted/definition.graphql b/formatter/testdata/baseline/FormatSchema/compacted/definition.graphql
@@ -0,0 +1,27 @@
+"""
+Cat0 description
+"""
+scalar Cat0
+type Cat1 {
+	name: String
+}
+interface Cat2 {
+	name: String
+}
+union Cat3 = Cat3_0 | Cat3_1 | Cat3_2
+type Cat3_0 {
+	name: String
+}
+type Cat3_1 {
+	name: String
+}
+type Cat3_2 {
+	name: String
+}
+enum Cat4 {
+	NFC
+	MAINECOON
+}
+input Cat5 {
+	name: String
+}
diff --git a/formatter/testdata/baseline/FormatSchema/compacted/description.graphql b/formatter/testdata/baseline/FormatSchema/compacted/description.graphql
@@ -0,0 +1,14 @@
+"""
+Cat is best kawaii animal in the world.
+meow!
+"""
+type Cat {
+	"""
+	Shiny brillian name.
+	"""
+	name: String
+	"""
+	Only "meow" is allowed.
+	"""
+	speaks: String
+}
diff --git a/formatter/testdata/baseline/FormatSchema/compacted/directive.graphql b/formatter/testdata/baseline/FormatSchema/compacted/directive.graphql
@@ -0,0 +1,2 @@
+directive @bar repeatable on FIELD | OBJECT
+directive @foo on FIELD | OBJECT
diff --git a/formatter/testdata/baseline/FormatSchema/compacted/directive_locations.graphql b/formatter/testdata/baseline/FormatSchema/compacted/directive_locations.graphql
@@ -0,0 +1,13 @@
+directive @foo on OBJECT | UNION | ENUM
+enum ConnectionStatus @foo {
+	ONLINE
+	OFFLINE
+	ERROR
+}
+interface Named {
+	name: String!
+}
+type Person implements Named @foo {
+	name: String!
+}
+union PersonUnion @foo = Person
diff --git a/formatter/testdata/baseline/FormatSchema/compacted/extensions.graphql b/formatter/testdata/baseline/FormatSchema/compacted/extensions.graphql
@@ -0,0 +1,16 @@
+directive @extends on OBJECT
+directive @key(fields: String!) on OBJECT | INTERFACE
+directive @permission(permission: String!) on FIELD_DEFINITION
+type Dog {
+	name: String!
+	owner: Person! @permission(permission: "admin")
+}
+type Person @key(fields: "name") {
+	name: String!
+}
+type Query @extends {
+	dogs: [Dog!]!
+}
+type Subscription {
+	dogEvents: [Dog!]!
+}
diff --git a/formatter/testdata/baseline/FormatSchema/compacted/field_definition.graphql b/formatter/testdata/baseline/FormatSchema/compacted/field_definition.graphql
@@ -0,0 +1,3 @@
+input CatInput {
+	food: String = "fish & meat"
+}
diff --git a/formatter/testdata/baseline/FormatSchema/compacted/schema.graphql b/formatter/testdata/baseline/FormatSchema/compacted/schema.graphql
@@ -0,0 +1,55 @@
+schema {
+	query: TopQuery
+	mutation: TopMutation
+	subscription: TopSubscription
+}
+type TopMutation {
+	noop: Boolean
+	noop2(
+		"""
+		noop2 foo bar
+		"""
+		arg: String
+	): Boolean
+	noop3(
+		"""
+		noop3 foo bar
+		"""
+		arg: String
+	): Boolean
+}
+type TopQuery {
+	noop: Boolean
+	noop2(
+		"""
+		noop2 foo bar
+		"""
+		arg: String
+	): Boolean
+	noop3(
+		"""
+		noop3 foo bar
+		"""
+		arg: String
+	): Boolean
+}
+type TopSubscription {
+	noop: Boolean
+	noop2(
+		"""
+		noop2 foo bar
+		"""
+		arg: String
+	): Boolean
+	noop3(
+		"""
+		noop3 foo bar
+		"""
+		arg1: String
+
+		"""
+		noop3 foo bar
+		"""
+		arg2: String
+	): Boolean
+}
diff --git a/formatter/testdata/baseline/FormatSchema/compacted/swapi.graphql b/formatter/testdata/baseline/FormatSchema/compacted/swapi.graphql
@@ -0,0 +1,87 @@
+interface Character {
+	id: ID!
+	name: String!
+	friends: [Character]
+	friendsConnection(first: Int, after: ID): FriendsConnection!
+	appearsIn: [Episode]!
+}
+input ColorInput {
+	red: Int!
+	green: Int!
+	blue: Int!
+}
+type Droid implements Character {
+	id: ID!
+	name: String!
+	friends: [Character]
+	friendsConnection(first: Int, after: ID): FriendsConnection!
+	appearsIn: [Episode]!
+	primaryFunction: String
+}
+enum Episode {
+	NEWHOPE
+	EMPIRE
+	JEDI
+}
+type FriendsConnection {
+	totalCount: Int
+	edges: [FriendsEdge]
+	friends: [Character]
+	pageInfo: PageInfo!
+}
+type FriendsEdge {
+	cursor: ID!
+	node: Character
+}
+type Human implements Character {
+	id: ID!
+	name: String!
+	homePlanet: String
+	height(unit: LengthUnit = METER): Float
+	mass: Float
+	friends: [Character]
+	friendsConnection(first: Int, after: ID): FriendsConnection!
+	appearsIn: [Episode]!
+	starships: [Starship]
+}
+enum LengthUnit {
+	METER
+	FOOT
+}
+type Mutation {
+	createReview(episode: Episode, review: ReviewInput!): Review
+}
+type PageInfo {
+	startCursor: ID
+	endCursor: ID
+	hasNextPage: Boolean!
+}
+type Query {
+	hero(episode: Episode): Character
+	reviews(episode: Episode!): [Review]
+	search(text: String): [SearchResult]
+	character(id: ID!): Character
+	droid(id: ID!): Droid
+	human(id: ID!): Human
+	starship(id: ID!): Starship
+}
+type Review {
+	episode: Episode
+	stars: Int!
+	commentary: String
+}
+input ReviewInput {
+	stars: Int!
+	commentary: String
+	favorite_color: ColorInput
+}
+union SearchResult = Human | Droid | Starship
+type Starship {
+	id: ID!
+	name: String!
+	length(unit: LengthUnit = METER): Float
+	coordinates: [[Float!]!]
+}
+type Subscription {
+	reviewAdded(episode: Episode): Review
+}
diff --git a/formatter/testdata/baseline/FormatSchemaDocument/compacted/comment.graphql b/formatter/testdata/baseline/FormatSchemaDocument/compacted/comment.graphql
diff --git a/formatter/testdata/baseline/FormatSchemaDocument/compacted/definition.graphql b/formatter/testdata/baseline/FormatSchemaDocument/compacted/definition.graphql
@@ -0,0 +1,27 @@
+"""
+Cat0 description
+"""
+scalar Cat0
+type Cat1 {
+	name: String
+}
+interface Cat2 {
+	name: String
+}
+type Cat3_0 {
+	name: String
+}
+type Cat3_1 {
+	name: String
+}
+type Cat3_2 {
+	name: String
+}
+union Cat3 = Cat3_0 | Cat3_1 | Cat3_2
+enum Cat4 {
+	NFC
+	MAINECOON
+}
+input Cat5 {
+	name: String
+}
diff --git a/formatter/testdata/baseline/FormatSchemaDocument/compacted/description.graphql b/formatter/testdata/baseline/FormatSchemaDocument/compacted/description.graphql
@@ -0,0 +1,14 @@
+"""
+Cat is best kawaii animal in the world.
+meow!
+"""
+type Cat {
+	"""
+	Shiny brillian name.
+	"""
+	name: String
+	"""
+	Only "meow" is allowed.
+	"""
+	speaks: String
+}
diff --git a/formatter/testdata/baseline/FormatSchemaDocument/compacted/directive.graphql b/formatter/testdata/baseline/FormatSchemaDocument/compacted/directive.graphql
@@ -0,0 +1,2 @@
+directive @foo on FIELD | OBJECT
+directive @bar repeatable on FIELD | OBJECT
diff --git a/formatter/testdata/baseline/FormatSchemaDocument/compacted/directive_locations.graphql b/formatter/testdata/baseline/FormatSchemaDocument/compacted/directive_locations.graphql
@@ -0,0 +1,13 @@
+directive @foo on OBJECT | UNION | ENUM
+interface Named {
+	name: String!
+}
+type Person implements Named @foo {
+	name: String!
+}
+enum ConnectionStatus @foo {
+	ONLINE
+	OFFLINE
+	ERROR
+}
+union PersonUnion @foo = Person
diff --git a/formatter/testdata/baseline/FormatSchemaDocument/compacted/extensions.graphql b/formatter/testdata/baseline/FormatSchemaDocument/compacted/extensions.graphql
diff --git a/formatter/testdata/baseline/FormatSchemaDocument/compacted/field_definition.graphql b/formatter/testdata/baseline/FormatSchemaDocument/compacted/field_definition.graphql
diff --git a/formatter/testdata/baseline/FormatSchemaDocument/compacted/schema.graphql b/formatter/testdata/baseline/FormatSchemaDocument/compacted/schema.graphql
diff --git a/formatter/testdata/baseline/FormatSchemaDocument/compacted/swapi.graphql b/formatter/testdata/baseline/FormatSchemaDocument/compacted/swapi.graphql

Original file line number	Diff line number	Diff line change
`@@ -26,6 +26,7 @@ var optionSets = []struct {`
`26`	`26`	`{"spaceIndent", []formatter.FormatterOption{formatter.WithIndent(" ")}},`
`27`	`27`	`{"comments", []formatter.FormatterOption{formatter.WithComments()}},`
`28`	`28`	`{"no_description", []formatter.FormatterOption{formatter.WithoutDescription()}},`
	`29`	`+ {"compacted", []formatter.FormatterOption{formatter.WithCompacted()}},`
`29`	`30`	`}`
`30`	`31`
`31`	`32`	`func TestFormatter_FormatSchema(t *testing.T) {`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,7 @@ @@
 +query FooBarQuery($after: String!) {
 +	fizzList(first: 100, after: $after) {
 +		nodes {
 +			id
 +		}
 +	}
 +}
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+directive @bar repeatable on FIELD \| OBJECT`
	`2`	`+directive @foo on FIELD \| OBJECT`