/
help-options.js.snap
654 lines (422 loc) · 17.6 KB
/
help-options.js.snap
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
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
// Jest Snapshot v1, https://goo.gl/fbAQLP
exports[`show detailed usage with --help arrow-parens (stderr) 1`] = `""`;
exports[`show detailed usage with --help arrow-parens (stdout) 1`] = `
"--arrow-parens <always|avoid>
Include parentheses around a sole arrow function parameter.
Valid options:
always Always include parens. Example: \`(x) => x\`
avoid Omit parens when possible. Example: \`x => x\`
Default: always
"
`;
exports[`show detailed usage with --help arrow-parens (write) 1`] = `Array []`;
exports[`show detailed usage with --help bracket-spacing (stderr) 1`] = `""`;
exports[`show detailed usage with --help bracket-spacing (stdout) 1`] = `
"--bracket-spacing
Print spaces between brackets.
Default: true
"
`;
exports[`show detailed usage with --help bracket-spacing (write) 1`] = `Array []`;
exports[`show detailed usage with --help check (stderr) 1`] = `""`;
exports[`show detailed usage with --help check (stdout) 1`] = `
"-c, --check
Check if the given files are formatted, print a human-friendly summary
message and paths to unformatted files (see also --list-different).
"
`;
exports[`show detailed usage with --help check (write) 1`] = `Array []`;
exports[`show detailed usage with --help color (stderr) 1`] = `""`;
exports[`show detailed usage with --help color (stdout) 1`] = `
"--color
Colorize error messages.
Default: true
"
`;
exports[`show detailed usage with --help color (write) 1`] = `Array []`;
exports[`show detailed usage with --help config (stderr) 1`] = `""`;
exports[`show detailed usage with --help config (stdout) 1`] = `
"--config <path>
Path to a Prettier configuration file (.prettierrc, package.json, prettier.config.js).
"
`;
exports[`show detailed usage with --help config (write) 1`] = `Array []`;
exports[`show detailed usage with --help config-precedence (stderr) 1`] = `""`;
exports[`show detailed usage with --help config-precedence (stdout) 1`] = `
"--config-precedence <cli-override|file-override|prefer-file>
Define in which order config files and CLI options should be evaluated.
Valid options:
cli-override CLI options take precedence over config file
file-override Config file take precedence over CLI options
prefer-file If a config file is found will evaluate it and ignore other CLI options.
If no config file is found CLI options will evaluate as normal.
Default: cli-override
"
`;
exports[`show detailed usage with --help config-precedence (write) 1`] = `Array []`;
exports[`show detailed usage with --help cursor-offset (stderr) 1`] = `""`;
exports[`show detailed usage with --help cursor-offset (stdout) 1`] = `
"--cursor-offset <int>
Print (to stderr) where a cursor at the given position would move to after formatting.
This option cannot be used with --range-start and --range-end.
Default: -1
"
`;
exports[`show detailed usage with --help cursor-offset (write) 1`] = `Array []`;
exports[`show detailed usage with --help editorconfig (stderr) 1`] = `""`;
exports[`show detailed usage with --help editorconfig (stdout) 1`] = `
"--editorconfig
Take .editorconfig into account when parsing configuration.
Default: true
"
`;
exports[`show detailed usage with --help editorconfig (write) 1`] = `Array []`;
exports[`show detailed usage with --help embedded-language-formatting (stderr) 1`] = `""`;
exports[`show detailed usage with --help embedded-language-formatting (stdout) 1`] = `
"--embedded-language-formatting <auto|off>
Control how Prettier formats quoted code embedded in the file.
Valid options:
auto Format embedded code if Prettier can automatically identify it.
off Never automatically format embedded code.
Default: auto
"
`;
exports[`show detailed usage with --help embedded-language-formatting (write) 1`] = `Array []`;
exports[`show detailed usage with --help end-of-line (stderr) 1`] = `""`;
exports[`show detailed usage with --help end-of-line (stdout) 1`] = `
"--end-of-line <lf|crlf|cr|auto>
Which end of line characters to apply.
Valid options:
lf Line Feed only (\\\\n), common on Linux and macOS as well as inside git repos
crlf Carriage Return + Line Feed characters (\\\\r\\\\n), common on Windows
cr Carriage Return character only (\\\\r), used very rarely
auto Maintain existing
(mixed values within one file are normalised by looking at what's used after the first line)
Default: lf
"
`;
exports[`show detailed usage with --help end-of-line (write) 1`] = `Array []`;
exports[`show detailed usage with --help file-info (stderr) 1`] = `""`;
exports[`show detailed usage with --help file-info (stdout) 1`] = `
"--file-info <path>
Extract the following info (as JSON) for a given file path. Reported fields:
* ignored (boolean) - true if file path is filtered by --ignore-path
* inferredParser (string | null) - name of parser inferred from file path
"
`;
exports[`show detailed usage with --help file-info (write) 1`] = `Array []`;
exports[`show detailed usage with --help find-config-path (stderr) 1`] = `""`;
exports[`show detailed usage with --help find-config-path (stdout) 1`] = `
"--find-config-path <path>
Find and print the path to a configuration file for the given input file.
"
`;
exports[`show detailed usage with --help find-config-path (write) 1`] = `Array []`;
exports[`show detailed usage with --help help (stderr) 1`] = `""`;
exports[`show detailed usage with --help help (stdout) 1`] = `
"-h, --help <flag>
Show CLI usage, or details about the given flag.
Example: --help write
"
`;
exports[`show detailed usage with --help help (write) 1`] = `Array []`;
exports[`show detailed usage with --help html-whitespace-sensitivity (stderr) 1`] = `""`;
exports[`show detailed usage with --help html-whitespace-sensitivity (stdout) 1`] = `
"--html-whitespace-sensitivity <css|strict|ignore>
How to handle whitespaces in HTML.
Valid options:
css Respect the default value of CSS display property.
strict Whitespaces are considered sensitive.
ignore Whitespaces are considered insensitive.
Default: css
"
`;
exports[`show detailed usage with --help html-whitespace-sensitivity (write) 1`] = `Array []`;
exports[`show detailed usage with --help ignore-path (stderr) 1`] = `""`;
exports[`show detailed usage with --help ignore-path (stdout) 1`] = `
"--ignore-path <path>
Path to a file with patterns describing files to ignore.
Default: .prettierignore
"
`;
exports[`show detailed usage with --help ignore-path (write) 1`] = `Array []`;
exports[`show detailed usage with --help ignore-unknown (stderr) 1`] = `""`;
exports[`show detailed usage with --help ignore-unknown (stdout) 1`] = `
"-u, --ignore-unknown
Ignore unknown files.
"
`;
exports[`show detailed usage with --help ignore-unknown (write) 1`] = `Array []`;
exports[`show detailed usage with --help insert-pragma (stderr) 1`] = `""`;
exports[`show detailed usage with --help insert-pragma (stdout) 1`] = `
"--insert-pragma
Insert @format pragma into file's first docblock comment.
Default: false
"
`;
exports[`show detailed usage with --help insert-pragma (write) 1`] = `Array []`;
exports[`show detailed usage with --help jsx-bracket-same-line (stderr) 1`] = `""`;
exports[`show detailed usage with --help jsx-bracket-same-line (stdout) 1`] = `
"--jsx-bracket-same-line
Put > on the last line instead of at a new line.
Default: false
"
`;
exports[`show detailed usage with --help jsx-bracket-same-line (write) 1`] = `Array []`;
exports[`show detailed usage with --help jsx-single-quote (stderr) 1`] = `""`;
exports[`show detailed usage with --help jsx-single-quote (stdout) 1`] = `
"--jsx-single-quote
Use single quotes in JSX.
Default: false
"
`;
exports[`show detailed usage with --help jsx-single-quote (write) 1`] = `Array []`;
exports[`show detailed usage with --help list-different (stderr) 1`] = `""`;
exports[`show detailed usage with --help list-different (stdout) 1`] = `
"-l, --list-different
Print the names of files that are different from Prettier's formatting (see also --check).
"
`;
exports[`show detailed usage with --help list-different (write) 1`] = `Array []`;
exports[`show detailed usage with --help loglevel (stderr) 1`] = `""`;
exports[`show detailed usage with --help loglevel (stdout) 1`] = `
"--loglevel <silent|error|warn|log|debug>
What level of logs to report.
Valid options:
silent
error
warn
log
debug
Default: log
"
`;
exports[`show detailed usage with --help loglevel (write) 1`] = `Array []`;
exports[`show detailed usage with --help no-bracket-spacing (stderr) 1`] = `""`;
exports[`show detailed usage with --help no-bracket-spacing (stdout) 1`] = `
"--no-bracket-spacing
Do not print spaces between brackets.
"
`;
exports[`show detailed usage with --help no-bracket-spacing (write) 1`] = `Array []`;
exports[`show detailed usage with --help no-color (stderr) 1`] = `""`;
exports[`show detailed usage with --help no-color (stdout) 1`] = `
"--no-color
Do not colorize error messages.
"
`;
exports[`show detailed usage with --help no-color (write) 1`] = `Array []`;
exports[`show detailed usage with --help no-config (stderr) 1`] = `""`;
exports[`show detailed usage with --help no-config (stdout) 1`] = `
"--no-config
Do not look for a configuration file.
"
`;
exports[`show detailed usage with --help no-config (write) 1`] = `Array []`;
exports[`show detailed usage with --help no-editorconfig (stderr) 1`] = `""`;
exports[`show detailed usage with --help no-editorconfig (stdout) 1`] = `
"--no-editorconfig
Don't take .editorconfig into account when parsing configuration.
"
`;
exports[`show detailed usage with --help no-editorconfig (write) 1`] = `Array []`;
exports[`show detailed usage with --help no-semi (stderr) 1`] = `""`;
exports[`show detailed usage with --help no-semi (stdout) 1`] = `
"--no-semi
Do not print semicolons, except at the beginning of lines which may need them.
"
`;
exports[`show detailed usage with --help no-semi (write) 1`] = `Array []`;
exports[`show detailed usage with --help parser (stderr) 1`] = `""`;
exports[`show detailed usage with --help parser (stdout) 1`] = `
"--parser <flow|babel|babel-flow|babel-ts|typescript|css|less|scss|json|json5|json-stringify|graphql|markdown|mdx|vue|yaml|html|angular|lwc>
Which parser to use.
Valid options:
flow Flow
babel JavaScript
babel-flow Flow
babel-ts TypeScript
typescript TypeScript
css CSS
less Less
scss SCSS
json JSON
json5 JSON5
json-stringify JSON.stringify
graphql GraphQL
markdown Markdown
mdx MDX
vue Vue
yaml YAML
html HTML
angular Angular
lwc Lightning Web Components
"
`;
exports[`show detailed usage with --help parser (write) 1`] = `Array []`;
exports[`show detailed usage with --help plugin (stderr) 1`] = `""`;
exports[`show detailed usage with --help plugin (stdout) 1`] = `
"--plugin <path>
Add a plugin. Multiple plugins can be passed as separate \`--plugin\`s.
Default: []
"
`;
exports[`show detailed usage with --help plugin (write) 1`] = `Array []`;
exports[`show detailed usage with --help plugin-search-dir (stderr) 1`] = `""`;
exports[`show detailed usage with --help plugin-search-dir (stdout) 1`] = `
"--plugin-search-dir <path>
Custom directory that contains prettier plugins in node_modules subdirectory.
Overrides default behavior when plugins are searched relatively to the location of Prettier.
Multiple values are accepted.
Default: []
"
`;
exports[`show detailed usage with --help plugin-search-dir (write) 1`] = `Array []`;
exports[`show detailed usage with --help print-width (stderr) 1`] = `""`;
exports[`show detailed usage with --help print-width (stdout) 1`] = `
"--print-width <int>
The line length where Prettier will try wrap.
Default: 80
"
`;
exports[`show detailed usage with --help print-width (write) 1`] = `Array []`;
exports[`show detailed usage with --help prose-wrap (stderr) 1`] = `""`;
exports[`show detailed usage with --help prose-wrap (stdout) 1`] = `
"--prose-wrap <always|never|preserve>
How to wrap prose.
Valid options:
always Wrap prose if it exceeds the print width.
never Do not wrap prose.
preserve Wrap prose as-is.
Default: preserve
"
`;
exports[`show detailed usage with --help prose-wrap (write) 1`] = `Array []`;
exports[`show detailed usage with --help quote-props (stderr) 1`] = `""`;
exports[`show detailed usage with --help quote-props (stdout) 1`] = `
"--quote-props <as-needed|consistent|preserve>
Change when properties in objects are quoted.
Valid options:
as-needed Only add quotes around object properties where required.
consistent If at least one property in an object requires quotes, quote all properties.
preserve Respect the input use of quotes in object properties.
Default: as-needed
"
`;
exports[`show detailed usage with --help quote-props (write) 1`] = `Array []`;
exports[`show detailed usage with --help range-end (stderr) 1`] = `""`;
exports[`show detailed usage with --help range-end (stdout) 1`] = `
"--range-end <int>
Format code ending at a given character offset (exclusive).
The range will extend forwards to the end of the selected statement.
This option cannot be used with --cursor-offset.
Default: Infinity
"
`;
exports[`show detailed usage with --help range-end (write) 1`] = `Array []`;
exports[`show detailed usage with --help range-start (stderr) 1`] = `""`;
exports[`show detailed usage with --help range-start (stdout) 1`] = `
"--range-start <int>
Format code starting at a given character offset.
The range will extend backwards to the start of the first line containing the selected statement.
This option cannot be used with --cursor-offset.
Default: 0
"
`;
exports[`show detailed usage with --help range-start (write) 1`] = `Array []`;
exports[`show detailed usage with --help require-pragma (stderr) 1`] = `""`;
exports[`show detailed usage with --help require-pragma (stdout) 1`] = `
"--require-pragma
Require either '@prettier' or '@format' to be present in the file's first docblock comment
in order for it to be formatted.
Default: false
"
`;
exports[`show detailed usage with --help require-pragma (write) 1`] = `Array []`;
exports[`show detailed usage with --help semi (stderr) 1`] = `""`;
exports[`show detailed usage with --help semi (stdout) 1`] = `
"--semi
Print semicolons.
Default: true
"
`;
exports[`show detailed usage with --help semi (write) 1`] = `Array []`;
exports[`show detailed usage with --help single-quote (stderr) 1`] = `""`;
exports[`show detailed usage with --help single-quote (stdout) 1`] = `
"--single-quote
Use single quotes instead of double quotes.
Default: false
"
`;
exports[`show detailed usage with --help single-quote (write) 1`] = `Array []`;
exports[`show detailed usage with --help stdin-filepath (stderr) 1`] = `""`;
exports[`show detailed usage with --help stdin-filepath (stdout) 1`] = `
"--stdin-filepath <path>
Path to the file to pretend that stdin comes from.
"
`;
exports[`show detailed usage with --help stdin-filepath (write) 1`] = `Array []`;
exports[`show detailed usage with --help support-info (stderr) 1`] = `""`;
exports[`show detailed usage with --help support-info (stdout) 1`] = `
"--support-info
Print support information as JSON.
"
`;
exports[`show detailed usage with --help support-info (write) 1`] = `Array []`;
exports[`show detailed usage with --help tab-width (stderr) 1`] = `""`;
exports[`show detailed usage with --help tab-width (stdout) 1`] = `
"--tab-width <int>
Number of spaces per indentation level.
Default: 2
"
`;
exports[`show detailed usage with --help tab-width (write) 1`] = `Array []`;
exports[`show detailed usage with --help trailing-comma (stderr) 1`] = `""`;
exports[`show detailed usage with --help trailing-comma (stdout) 1`] = `
"--trailing-comma <es5|none|all>
Print trailing commas wherever possible when multi-line.
Valid options:
es5 Trailing commas where valid in ES5 (objects, arrays, etc.)
none No trailing commas.
all Trailing commas wherever possible (including function arguments).
Default: es5
"
`;
exports[`show detailed usage with --help trailing-comma (write) 1`] = `Array []`;
exports[`show detailed usage with --help use-tabs (stderr) 1`] = `""`;
exports[`show detailed usage with --help use-tabs (stdout) 1`] = `
"--use-tabs
Indent with tabs instead of spaces.
Default: false
"
`;
exports[`show detailed usage with --help use-tabs (write) 1`] = `Array []`;
exports[`show detailed usage with --help version (stderr) 1`] = `""`;
exports[`show detailed usage with --help version (stdout) 1`] = `
"-v, --version
Print Prettier version.
"
`;
exports[`show detailed usage with --help version (write) 1`] = `Array []`;
exports[`show detailed usage with --help vue-indent-script-and-style (stderr) 1`] = `""`;
exports[`show detailed usage with --help vue-indent-script-and-style (stdout) 1`] = `
"--vue-indent-script-and-style
Indent script and style tags in Vue files.
Default: false
"
`;
exports[`show detailed usage with --help vue-indent-script-and-style (write) 1`] = `Array []`;
exports[`show detailed usage with --help with-node-modules (stderr) 1`] = `""`;
exports[`show detailed usage with --help with-node-modules (stdout) 1`] = `
"--with-node-modules
Process files inside 'node_modules' directory.
"
`;
exports[`show detailed usage with --help with-node-modules (write) 1`] = `Array []`;
exports[`show detailed usage with --help write (stderr) 1`] = `""`;
exports[`show detailed usage with --help write (stdout) 1`] = `
"-w, --write
Edit files in-place. (Beware!)
"
`;
exports[`show detailed usage with --help write (write) 1`] = `Array []`;