pretty_graphql 0.2.3

GraphQL formatter.
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
//! Types about configuration.
//!
//! For detailed documentation of configuration,
//! please read [configuration documentation](https://pretty-graphql.netlify.app/).

#[cfg(feature = "config_serde")]
use serde::{Deserialize, Serialize};

#[derive(Clone, Debug, Default)]
#[cfg_attr(feature = "config_serde", derive(Serialize, Deserialize))]
#[cfg_attr(feature = "config_serde", serde(default))]
/// The whole configuration of Pretty GraphQL.
pub struct FormatOptions {
    #[cfg_attr(feature = "config_serde", serde(flatten))]
    pub layout: LayoutOptions,
    #[cfg_attr(feature = "config_serde", serde(flatten))]
    pub language: LanguageOptions,
}

#[derive(Clone, Debug)]
#[cfg_attr(feature = "config_serde", derive(Serialize, Deserialize))]
#[cfg_attr(feature = "config_serde", serde(default))]
/// Configuration related to layout, such as indentation or print width.
pub struct LayoutOptions {
    #[cfg_attr(feature = "config_serde", serde(alias = "printWidth"))]
    pub print_width: usize,

    #[cfg_attr(feature = "config_serde", serde(alias = "useTabs"))]
    pub use_tabs: bool,

    #[cfg_attr(feature = "config_serde", serde(alias = "indentWidth"))]
    pub indent_width: usize,

    #[cfg_attr(
        feature = "config_serde",
        serde(alias = "lineBreak", alias = "linebreak")
    )]
    pub line_break: LineBreak,
}

impl Default for LayoutOptions {
    fn default() -> Self {
        Self {
            print_width: 80,
            use_tabs: false,
            indent_width: 2,
            line_break: LineBreak::Lf,
        }
    }
}

#[derive(Clone, Debug, Default)]
#[cfg_attr(feature = "config_serde", derive(Serialize, Deserialize))]
#[cfg_attr(feature = "config_serde", serde(rename_all = "kebab-case"))]
pub enum LineBreak {
    #[default]
    Lf,
    Crlf,
}

impl From<LineBreak> for tiny_pretty::LineBreak {
    fn from(value: LineBreak) -> Self {
        match value {
            LineBreak::Lf => tiny_pretty::LineBreak::Lf,
            LineBreak::Crlf => tiny_pretty::LineBreak::Crlf,
        }
    }
}

#[derive(Clone, Debug)]
#[cfg_attr(feature = "config_serde", derive(Serialize, Deserialize))]
#[cfg_attr(feature = "config_serde", serde(default))]
/// Configuration related to syntax.
pub struct LanguageOptions {
    pub comma: Comma,
    #[cfg_attr(feature = "config_serde", serde(alias = "arguments.comma"))]
    pub arguments_comma: Comma,
    #[cfg_attr(
        feature = "config_serde",
        serde(
            rename = "arguments_definition.comma",
            alias = "argumentsDefinition.comma"
        )
    )]
    pub arguments_definition_comma: Comma,
    #[cfg_attr(feature = "config_serde", serde(alias = "directives.comma"))]
    pub directives_comma: Comma,
    #[cfg_attr(
        feature = "config_serde",
        serde(
            rename = "enum_values_definition.comma",
            alias = "enumValuesDefinition.comma"
        )
    )]
    pub enum_values_definition_comma: Comma,
    #[cfg_attr(
        feature = "config_serde",
        serde(rename = "fields_definition.comma", alias = "fieldsDefinition.comma")
    )]
    pub fields_definition_comma: Comma,
    #[cfg_attr(
        feature = "config_serde",
        serde(
            rename = "input_fields_definition.comma",
            alias = "inputFieldsDefinition.comma"
        )
    )]
    pub input_fields_definition_comma: Comma,
    #[cfg_attr(
        feature = "config_serde",
        serde(rename = "list_value.comma", alias = "listValue.comma")
    )]
    pub list_value_comma: Comma,
    #[cfg_attr(
        feature = "config_serde",
        serde(rename = "object_value.comma", alias = "objectValue.comma")
    )]
    pub object_value_comma: Comma,
    #[cfg_attr(
        feature = "config_serde",
        serde(rename = "schema_definition.comma", alias = "schemaDefinition.comma")
    )]
    pub schema_definition_comma: Comma,
    #[cfg_attr(
        feature = "config_serde",
        serde(rename = "schema_extension.comma", alias = "schemaExtension.comma")
    )]
    pub schema_extension_comma: Comma,
    #[cfg_attr(
        feature = "config_serde",
        serde(rename = "selection_set.comma", alias = "selectionSet.comma")
    )]
    pub selection_set_comma: Comma,
    #[cfg_attr(
        feature = "config_serde",
        serde(
            rename = "variable_definitions.comma",
            alias = "variableDefinitions.comma"
        )
    )]
    pub variable_definitions_comma: Comma,

    #[cfg_attr(feature = "config_serde", serde(alias = "singleLine"))]
    pub single_line: SingleLine,
    #[cfg_attr(
        feature = "config_serde",
        serde(rename = "arguments.single_line", alias = "arguments.singleLine")
    )]
    pub arguments_single_line: SingleLine,
    #[cfg_attr(
        feature = "config_serde",
        serde(
            rename = "arguments_definition.single_line",
            alias = "argumentsDefinition.singleLine"
        )
    )]
    pub arguments_definition_single_line: SingleLine,
    #[cfg_attr(
        feature = "config_serde",
        serde(
            rename = "enum_values_definition.single_line",
            alias = "enumValuesDefinition.singleLine"
        )
    )]
    pub enum_values_definition_single_line: SingleLine,
    #[cfg_attr(
        feature = "config_serde",
        serde(
            rename = "directive_locations.single_line",
            alias = "directiveLocations.singleLine"
        )
    )]
    pub directive_locations_single_line: SingleLine,
    #[cfg_attr(
        feature = "config_serde",
        serde(rename = "directives.single_line", alias = "directives.singleLine")
    )]
    pub directives_single_line: SingleLine,
    #[cfg_attr(
        feature = "config_serde",
        serde(
            rename = "fields_definition.single_line",
            alias = "fieldsDefinition.singleLine"
        )
    )]
    pub fields_definition_single_line: SingleLine,
    #[cfg_attr(
        feature = "config_serde",
        serde(
            rename = "implements_interfaces.single_line",
            alias = "implementsInterfaces.singleLine"
        )
    )]
    pub implements_interfaces_single_line: SingleLine,
    #[cfg_attr(
        feature = "config_serde",
        serde(
            rename = "input_fields_definition.single_line",
            alias = "inputFieldsDefinition.singleLine"
        )
    )]
    pub input_fields_definition_single_line: SingleLine,
    #[cfg_attr(
        feature = "config_serde",
        serde(rename = "list_value.single_line", alias = "listValue.singleLine")
    )]
    pub list_value_single_line: SingleLine,
    #[cfg_attr(
        feature = "config_serde",
        serde(rename = "object_value.single_line", alias = "objectValue.singleLine")
    )]
    pub object_value_single_line: SingleLine,
    #[cfg_attr(
        feature = "config_serde",
        serde(
            rename = "schema_definition.single_line",
            alias = "schemaDefinition.singleLine"
        )
    )]
    pub schema_definition_single_line: SingleLine,
    #[cfg_attr(
        feature = "config_serde",
        serde(
            rename = "schema_extension.single_line",
            alias = "schemaExtension.singleLine"
        )
    )]
    pub schema_extension_single_line: SingleLine,
    #[cfg_attr(
        feature = "config_serde",
        serde(
            rename = "selection_set.single_line",
            alias = "selectionSet.singleLine"
        )
    )]
    pub selection_set_single_line: SingleLine,
    #[cfg_attr(
        feature = "config_serde",
        serde(
            rename = "union_member_types.single_line",
            alias = "unionMemberTypes.singleLine"
        )
    )]
    pub union_member_types_single_line: SingleLine,
    #[cfg_attr(
        feature = "config_serde",
        serde(
            rename = "variable_definitions.single_line",
            alias = "variableDefinitions.singleLine"
        )
    )]
    pub variable_definitions_single_line: SingleLine,

    #[cfg_attr(feature = "config_serde", serde(alias = "parenSpacing"))]
    pub paren_spacing: bool,
    #[cfg_attr(
        feature = "config_serde",
        serde(rename = "arguments.paren_spacing", alias = "arguments.parenSpacing")
    )]
    pub arguments_paren_spacing: Option<bool>,
    #[cfg_attr(
        feature = "config_serde",
        serde(
            rename = "arguments_definition.paren_spacing",
            alias = "argumentsDefinition.parenSpacing"
        )
    )]
    pub arguments_definition_paren_spacing: Option<bool>,
    #[cfg_attr(
        feature = "config_serde",
        serde(
            rename = "variable_definitions.paren_spacing",
            alias = "variableDefinitions.parenSpacing"
        )
    )]
    pub variable_definitions_paren_spacing: Option<bool>,

    #[cfg_attr(feature = "config_serde", serde(alias = "bracketSpacing"))]
    pub bracket_spacing: bool,

    #[cfg_attr(feature = "config_serde", serde(alias = "braceSpacing"))]
    pub brace_spacing: bool,
    #[cfg_attr(
        feature = "config_serde",
        serde(
            rename = "enum_values_definition.brace_spacing",
            alias = "enumValuesDefinition.braceSpacing"
        )
    )]
    pub enum_values_definition_brace_spacing: Option<bool>,
    #[cfg_attr(
        feature = "config_serde",
        serde(
            rename = "fields_definition.brace_spacing",
            alias = "fieldsDefinition.braceSpacing"
        )
    )]
    pub fields_definition_brace_spacing: Option<bool>,
    #[cfg_attr(
        feature = "config_serde",
        serde(
            rename = "input_fields_definition.brace_spacing",
            alias = "inputFieldsDefinition.braceSpacing"
        )
    )]
    pub input_fields_definition_brace_spacing: Option<bool>,
    #[cfg_attr(
        feature = "config_serde",
        serde(
            rename = "object_value.brace_spacing",
            alias = "objectValue.braceSpacing"
        )
    )]
    pub object_value_brace_spacing: Option<bool>,
    #[cfg_attr(
        feature = "config_serde",
        serde(
            rename = "schema_definition.brace_spacing",
            alias = "schemaDefinition.braceSpacing"
        )
    )]
    pub schema_definition_brace_spacing: Option<bool>,
    #[cfg_attr(
        feature = "config_serde",
        serde(
            rename = "schema_extension.brace_spacing",
            alias = "schemaExtension.braceSpacing"
        )
    )]
    pub schema_extension_brace_spacing: Option<bool>,
    #[cfg_attr(
        feature = "config_serde",
        serde(
            rename = "selection_set.brace_spacing",
            alias = "selectionSet.braceSpacing"
        )
    )]
    pub selection_set_brace_spacing: Option<bool>,

    #[cfg_attr(feature = "config_serde", serde(alias = "formatComments"))]
    pub format_comments: bool,

    #[cfg_attr(feature = "config_serde", serde(alias = "ignoreCommentDirective"))]
    pub ignore_comment_directive: String,
}

impl Default for LanguageOptions {
    fn default() -> Self {
        LanguageOptions {
            comma: Comma::OnlySingleLine,
            arguments_comma: Comma::Inherit,
            arguments_definition_comma: Comma::Inherit,
            directives_comma: Comma::Never,
            enum_values_definition_comma: Comma::Never,
            fields_definition_comma: Comma::Never,
            input_fields_definition_comma: Comma::Never,
            list_value_comma: Comma::Inherit,
            object_value_comma: Comma::Inherit,
            schema_definition_comma: Comma::Never,
            schema_extension_comma: Comma::Never,
            selection_set_comma: Comma::Never,
            variable_definitions_comma: Comma::Inherit,
            single_line: SingleLine::Smart,
            arguments_single_line: SingleLine::Inherit,
            arguments_definition_single_line: SingleLine::Inherit,
            directive_locations_single_line: SingleLine::Inherit,
            directives_single_line: SingleLine::Inherit,
            enum_values_definition_single_line: SingleLine::Never,
            fields_definition_single_line: SingleLine::Never,
            implements_interfaces_single_line: SingleLine::Inherit,
            input_fields_definition_single_line: SingleLine::Never,
            list_value_single_line: SingleLine::Inherit,
            object_value_single_line: SingleLine::Inherit,
            schema_definition_single_line: SingleLine::Never,
            schema_extension_single_line: SingleLine::Never,
            selection_set_single_line: SingleLine::Never,
            union_member_types_single_line: SingleLine::Inherit,
            variable_definitions_single_line: SingleLine::Inherit,
            paren_spacing: false,
            arguments_paren_spacing: None,
            arguments_definition_paren_spacing: None,
            variable_definitions_paren_spacing: None,
            bracket_spacing: false,
            brace_spacing: true,
            enum_values_definition_brace_spacing: None,
            fields_definition_brace_spacing: None,
            input_fields_definition_brace_spacing: None,
            object_value_brace_spacing: None,
            schema_definition_brace_spacing: None,
            schema_extension_brace_spacing: None,
            selection_set_brace_spacing: None,
            format_comments: false,
            ignore_comment_directive: "pretty-graphql-ignore".into(),
        }
    }
}

#[derive(Clone, Debug)]
#[cfg_attr(feature = "config_serde", derive(Serialize, Deserialize))]
#[cfg_attr(feature = "config_serde", serde(rename_all = "kebab-case"))]
pub enum Comma {
    Always,
    Never,
    #[cfg_attr(feature = "config_serde", serde(alias = "noTrailing"))]
    NoTrailing,
    #[cfg_attr(feature = "config_serde", serde(alias = "onlySingleLine"))]
    OnlySingleLine,
    Inherit,
}

#[derive(Clone, Debug)]
#[cfg_attr(feature = "config_serde", derive(Serialize, Deserialize))]
#[cfg_attr(feature = "config_serde", serde(rename_all = "kebab-case"))]
pub enum SingleLine {
    Prefer,
    Smart,
    Never,
    Inherit,
}