Skip to content

Commit d397d1a

Browse files
committed
also run prettier
1 parent 02670fc commit d397d1a

File tree

2 files changed

+100
-35
lines changed

2 files changed

+100
-35
lines changed

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
"build": "./build.sh",
2323
"test:build": "spec-md --metadata spec/metadata.json spec/GraphQL.md > /dev/null",
2424
"watch": "nodemon -e json,md --exec \"npm run build\"",
25-
"update-appendix-c": "node scripts/update-appendix-c.mjs"
25+
"update-appendix-c": "node scripts/update-appendix-c.mjs; prettier --write \"spec/Appendix C -- Built-in Definitions.md\""
2626
},
2727
"devDependencies": {
2828
"cspell": "5.9.1",

spec/Appendix C -- Built-in Definitions.md

Lines changed: 99 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
# C. Appendix: Type System Definitions
32

43
This appendix lists all the type system definitions mentioned throughout this
@@ -12,29 +11,39 @@ for consistency but different descriptions are allowed.
1211
Directs the executor to include this field or fragment only when the `if` argument is true.
1312
"""
1413
directive @include(
15-
"""Included when true."""
14+
"""
15+
Included when true.
16+
"""
1617
if: Boolean!
1718
) on FIELD | FRAGMENT_SPREAD | INLINE_FRAGMENT
1819

1920
"""
2021
Directs the executor to skip this field or fragment when the `if` argument is true.
2122
"""
2223
directive @skip(
23-
"""Skipped when true."""
24+
"""
25+
Skipped when true.
26+
"""
2427
if: Boolean!
2528
) on FIELD | FRAGMENT_SPREAD | INLINE_FRAGMENT
2629

27-
"""Marks an element of a GraphQL schema as no longer supported."""
30+
"""
31+
Marks an element of a GraphQL schema as no longer supported.
32+
"""
2833
directive @deprecated(
2934
"""
3035
Explains why this element was deprecated, usually also including a suggestion for how to access supported similar data. Formatted using the Markdown syntax, as specified by [CommonMark](https://commonmark.org/).
3136
"""
3237
reason: String = "No longer supported"
3338
) on FIELD_DEFINITION | ARGUMENT_DEFINITION | INPUT_FIELD_DEFINITION | ENUM_VALUE
3439

35-
"""Exposes a URL that specifies the behavior of this scalar."""
40+
"""
41+
Exposes a URL that specifies the behavior of this scalar.
42+
"""
3643
directive @specifiedBy(
37-
"""The URL that specifies the behavior of this scalar."""
44+
"""
45+
The URL that specifies the behavior of this scalar.
46+
"""
3847
url: String!
3948
) on SCALAR
4049

@@ -49,10 +58,14 @@ A GraphQL Schema defines the capabilities of a GraphQL server. It exposes all av
4958
type __Schema {
5059
description: String
5160

52-
"""A list of all types supported by this server."""
61+
"""
62+
A list of all types supported by this server.
63+
"""
5364
types: [__Type!]!
5465

55-
"""The type that query operations will be rooted at."""
66+
"""
67+
The type that query operations will be rooted at.
68+
"""
5669
queryType: __Type!
5770

5871
"""
@@ -65,7 +78,9 @@ type __Schema {
6578
"""
6679
subscriptionType: __Type
6780

68-
"""A list of all directives supported by this server."""
81+
"""
82+
A list of all directives supported by this server.
83+
"""
6984
directives: [__Directive!]!
7085
}
7186

@@ -88,9 +103,13 @@ type __Type {
88103
isOneOf: Boolean
89104
}
90105

91-
"""An enum describing what kind of type a given `__Type` is."""
106+
"""
107+
An enum describing what kind of type a given `__Type` is.
108+
"""
92109
enum __TypeKind {
93-
"""Indicates this type is a scalar."""
110+
"""
111+
Indicates this type is a scalar.
112+
"""
94113
SCALAR
95114

96115
"""
@@ -103,21 +122,29 @@ enum __TypeKind {
103122
"""
104123
INTERFACE
105124

106-
"""Indicates this type is a union. `possibleTypes` is a valid field."""
125+
"""
126+
Indicates this type is a union. `possibleTypes` is a valid field.
127+
"""
107128
UNION
108129

109-
"""Indicates this type is an enum. `enumValues` is a valid field."""
130+
"""
131+
Indicates this type is an enum. `enumValues` is a valid field.
132+
"""
110133
ENUM
111134

112135
"""
113136
Indicates this type is an input object. `inputFields` is a valid field.
114137
"""
115138
INPUT_OBJECT
116139

117-
"""Indicates this type is a list. `ofType` is a valid field."""
140+
"""
141+
Indicates this type is a list. `ofType` is a valid field.
142+
"""
118143
LIST
119144

120-
"""Indicates this type is a non-null. `ofType` is a valid field."""
145+
"""
146+
Indicates this type is a non-null. `ofType` is a valid field.
147+
"""
121148
NON_NULL
122149
}
123150

@@ -176,61 +203,99 @@ type __Directive {
176203
A Directive can be adjacent to many parts of the GraphQL language, a __DirectiveLocation describes one such possible adjacencies.
177204
"""
178205
enum __DirectiveLocation {
179-
"""Location adjacent to a query operation."""
206+
"""
207+
Location adjacent to a query operation.
208+
"""
180209
QUERY
181210

182-
"""Location adjacent to a mutation operation."""
211+
"""
212+
Location adjacent to a mutation operation.
213+
"""
183214
MUTATION
184215

185-
"""Location adjacent to a subscription operation."""
216+
"""
217+
Location adjacent to a subscription operation.
218+
"""
186219
SUBSCRIPTION
187220

188-
"""Location adjacent to a field."""
221+
"""
222+
Location adjacent to a field.
223+
"""
189224
FIELD
190225

191-
"""Location adjacent to a fragment definition."""
226+
"""
227+
Location adjacent to a fragment definition.
228+
"""
192229
FRAGMENT_DEFINITION
193230

194-
"""Location adjacent to a fragment spread."""
231+
"""
232+
Location adjacent to a fragment spread.
233+
"""
195234
FRAGMENT_SPREAD
196235

197-
"""Location adjacent to an inline fragment."""
236+
"""
237+
Location adjacent to an inline fragment.
238+
"""
198239
INLINE_FRAGMENT
199240

200-
"""Location adjacent to a variable definition."""
241+
"""
242+
Location adjacent to a variable definition.
243+
"""
201244
VARIABLE_DEFINITION
202245

203-
"""Location adjacent to a schema definition."""
246+
"""
247+
Location adjacent to a schema definition.
248+
"""
204249
SCHEMA
205250

206-
"""Location adjacent to a scalar definition."""
251+
"""
252+
Location adjacent to a scalar definition.
253+
"""
207254
SCALAR
208255

209-
"""Location adjacent to an object type definition."""
256+
"""
257+
Location adjacent to an object type definition.
258+
"""
210259
OBJECT
211260

212-
"""Location adjacent to a field definition."""
261+
"""
262+
Location adjacent to a field definition.
263+
"""
213264
FIELD_DEFINITION
214265

215-
"""Location adjacent to an argument definition."""
266+
"""
267+
Location adjacent to an argument definition.
268+
"""
216269
ARGUMENT_DEFINITION
217270

218-
"""Location adjacent to an interface definition."""
271+
"""
272+
Location adjacent to an interface definition.
273+
"""
219274
INTERFACE
220275

221-
"""Location adjacent to a union definition."""
276+
"""
277+
Location adjacent to a union definition.
278+
"""
222279
UNION
223280

224-
"""Location adjacent to an enum definition."""
281+
"""
282+
Location adjacent to an enum definition.
283+
"""
225284
ENUM
226285

227-
"""Location adjacent to an enum value definition."""
286+
"""
287+
Location adjacent to an enum value definition.
288+
"""
228289
ENUM_VALUE
229290

230-
"""Location adjacent to an input object type definition."""
291+
"""
292+
Location adjacent to an input object type definition.
293+
"""
231294
INPUT_OBJECT
232295

233-
"""Location adjacent to an input object field definition."""
296+
"""
297+
Location adjacent to an input object field definition.
298+
"""
234299
INPUT_FIELD_DEFINITION
235300
}
236301
```

0 commit comments

Comments
 (0)