forked from withfig/autocomplete
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathfirebase.ts
1451 lines (1448 loc) · 37.7 KB
/
firebase.ts
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
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
const projectAliasesGenerator: Fig.Generator = {
script: "firebase projects:list", // this calls to a firebase server and is therefore slow
postProcess: (out) => {
const getAliasRegex = /^│ (\w.*?)│/gm;
const aliasesRaw = Array.from(out.matchAll(getAliasRegex));
aliasesRaw.shift(); // first element is the table header
return aliasesRaw.map((alias) => {
return { name: alias[1].trim(), description: "ProjectAlias" };
});
},
};
const completionSpec: Fig.Spec = {
name: "firebase",
description: "",
subcommands: [
{
name: "appdistribution:distribute",
description: "Upload a distribution",
args: {
name: "distribution-file",
},
options: [
{
name: "--app",
description: "The app id of your Firebase app",
args: {},
},
{
name: "--release-notes",
description: "Release notes to include with this distribution",
},
{
name: "--release-notes-file",
description:
"Path to file with release notes to include with this distribution",
args: {},
},
{
name: "--testers",
description:
"A comma separated list of tester emails to distribute to",
args: {
isVariadic: true,
},
},
{
name: "--testers-file",
description:
"Path to file with a comma separated list of tester emails to distribute to",
args: {},
},
{
name: "--groups",
description:
"A comma separated list of group aliases to distribute to",
args: {
isVariadic: true,
},
},
{
name: "--groups-file",
description:
"Path to file with a comma separated list of group aliases to distribute to",
args: {
isVariadic: true,
},
},
{
name: ["-h", "--help"],
description: "Output usage information",
},
],
},
{
name: "apps:android:sha:create",
description: "Add a SHA certificate hash for a given app id",
args: [
{
name: "appId",
},
{
name: "shaHash",
},
],
options: [
{
name: ["-h", "--help"],
description: "Output usage information",
},
],
},
{
name: "apps:android:sha:delete",
description: "Delete a SHA certificate hash for a given app id",
args: [
{
name: "appId",
},
{
name: "shaId",
},
],
options: [
{
name: ["-h", "--help"],
description: "Output usage information",
},
],
},
{
name: "apps:create",
description: "Create a new Firebase app",
args: [
{
name: "platform",
},
{
name: "displayName",
},
],
options: [
{
name: ["-a", "--package-name"],
description: "Required package name for the Android app",
args: {},
},
{
name: ["-b", "--bundle-id"],
description: "Required bundle id for the iOS app",
args: {},
},
{
name: ["-s", "--app-store-id"],
description: "(optional) app store id for the iOS app",
args: {},
},
{
name: ["-h", "--help"],
description: "Output usage information",
},
],
},
{
name: "auth:export",
description:
"Export accounts from your Firebase project into a data file",
args: {
name: "dataFile",
template: "filepaths",
},
options: [
{
name: "--format",
description:
"Format of exported data (csv, json). Ignored if [dataFile] has format extension",
args: {
suggestions: [
{
name: "csv",
},
{
name: "json",
},
],
},
},
{
name: ["-h", "--help"],
description: "Output usage information",
},
],
},
{
name: "auth:import",
description:
"Import users into your Firebase project from a data file(.csv or .json)",
args: {
name: "dataFile",
template: "filepaths",
},
options: [
{
name: "--hash-algo",
description:
"Specify the hash algorithm used in password for these accounts",
args: {},
},
{
name: "--hash-key",
description: "Specify the key used in hash algorithm",
args: {},
},
{
name: "--salt-separator",
description:
"Specify the salt separator which will be appended to salt when verifying password. only used by SCRYPT now",
args: {},
},
{
name: "--rounds",
description: "Specify how many rounds for hash calculation",
args: {},
},
{
name: "--mem-cost",
description:
"Specify the memory cost for firebase scrypt, or cpu/memory cost for standard scrypt",
args: {},
},
{
name: "--parallelization",
description: "Specify the parallelization for standard scrypt",
args: {},
},
{
name: "--block-size",
description:
"Specify the block size (normally is 8) for standard scrypt",
args: {},
},
{
name: "--dk-len",
description: "Specify derived key length for standard scrypt",
args: {},
},
{
name: "--hash-input-order",
description:
"Specify the order of password and salt. Possible values are SALT_FIRST and PASSWORD_FIRST. MD5, SHA1, SHA256, SHA512, HMAC_MD5, HMAC_SHA1, HMAC_SHA256, HMAC_SHA512 support this flag",
args: {},
},
{
name: ["-h", "--help"],
description: "Output usage information",
},
],
},
{
name: "database:get",
description: "Fetch and print JSON data at the specified path",
args: {
name: "path",
},
},
{
name: "database:instances:create",
description: "Create a realtime database instance",
args: {
name: "instanceName",
},
options: [
{
name: ["-l", "--location"],
description:
"(optional) location for the database instance, defaults to us-central1",
args: {},
},
{
name: ["-h", "--help"],
description: "Output usage information",
},
],
},
{
name: "database:instances:list",
description:
"List realtime database instances, optionally filtered by a specified location",
options: [
{
name: ["-h", "--help"],
description: "Output usage information",
},
],
},
{
name: "database:profile",
description: "Profile the Realtime Database and generate a usage report",
options: [
{
name: ["-o", "--output"],
description: "Save the output to the specified file",
args: {},
},
{
name: ["-d", "--duration"],
description:
"Collect database usage information for the specified number of seconds",
args: {},
},
{
name: "--raw",
description:
"Output the raw stats collected as newline delimited json",
args: {},
},
{
name: "--no-collapse",
description:
"Prevent collapsing similar paths into $wildcard locations",
},
{
name: ["-i", "--input"],
description:
"Generate the report based on the specified file instead of streaming logs from the database",
args: {},
},
{
name: "--instance",
description:
"Use the database <instance>.firebaseio.com (if omitted, use default database instance)",
args: {},
},
{
name: ["-h", "--help"],
description: "Output usage information",
},
],
},
{
name: "database:push",
description: "Add a new JSON object to a list of data in your Firebase",
args: {
name: "path",
template: "filepaths",
},
options: [
{
name: ["-d", "--data"],
description: "Specify escaped JSON directly",
args: {},
},
{
name: "--instance",
description:
"Use the database <instance>.firebaseio.com (if omitted, use default database instance)",
args: {},
},
{
name: ["-h", "--help"],
description: "Output usage information",
},
],
},
{
name: "database:remove",
description: "Remove data from your Firebase at the specified path",
args: {
name: "path",
template: "filepaths",
},
options: [
{
name: ["-y", "--confirm"],
description: "Pass this option to bypass confirmation prompt",
},
{
name: "--instance",
description:
"Use the database <instance>.firebaseio.com (if omitted, use default database instance)",
args: {},
},
{
name: ["-h", "--help"],
description: "Output usage information",
},
],
},
{
name: "database:set",
description:
"Store JSON data at the specified path via STDIN, arg, or file",
args: {
name: "path",
template: "filepaths",
},
options: [
{
name: ["-d", "--data"],
description: "Specify escaped JSON directly",
args: {},
},
{
name: ["-y", "--confirm"],
description: "Pass this option to bypass confirmation prompt",
},
{
name: "--instance",
description:
"Use the database <instance>.firebaseio.com (if omitted, use default database instance)",
args: {},
},
{
name: ["-h", "--help"],
description: "Output usage information",
},
],
},
{
name: "database:settings:get",
description:
"Store JSON data at the specified path via STDIN, arg, or file",
args: {
name: "path",
template: "filepaths",
},
options: [
{
name: "--instance",
description:
"Use the database <instance>.firebaseio.com (if omitted, uses default database instance)",
args: {},
},
{
name: ["-h", "--help"],
description: "Output usage information",
},
],
},
{
name: "database:settings:set",
description: "Set the realtime database setting at path",
args: [
{
name: "path",
},
{
name: "value",
},
],
options: [
{
name: "--instance",
description:
"Use the database <instance>.firebaseio.com (if omitted, use default database instance)",
args: {},
},
{
name: ["-h", "--help"],
description: "Output usage information",
},
],
},
{
name: "database:update",
description:
"Update some of the keys for the defined path in your Firebase",
args: {
name: "path",
template: "filepaths",
},
options: [
{
name: ["-d", "--data"],
description: "Specify escaped JSON directly",
args: {},
},
{
name: ["-y", "--confirm"],
description: "Pass this option to bypass confirmation prompt",
},
{
name: "--instance",
description:
"Use the database <instance>.firebaseio.com (if omitted, use default database instance)",
args: {},
},
{
name: ["-h", "--help"],
description: "Output usage information",
},
],
},
{
name: "deploy",
description: "Deploy code and assets to your Firebase project",
options: [
{
name: ["-p", "--public"],
description:
"Override the Hosting public directory specified in firebase.json",
},
{
name: ["-m", "--message"],
description: "An optional message describing this deploy",
args: {},
},
{
name: ["-f", "--force"],
description:
"Delete Cloud Functions missing from the current working directory without confirmation",
},
{
name: "--only",
description:
'Only deploy to specified, comma-separated targets (e.g. "hosting,storage"). For functions, can specify filters with colons to scope function deploys to only those functions (e.g. "--only functions:func1,functions:func2"). When filtering based on export groups (the exported module object keys), use dots to specify group names (e.g. "--only functions:group1.subgroup1,functions:group2)"',
},
{
name: "--except",
description:
'Deploy to all targets except specified (e.g. "database")',
args: {},
},
{
name: ["-h", "--help"],
description: "Output usage information",
},
],
},
{
name: "emulators:exec",
description:
"Start the local Firebase emulators, run a test script, then shut down the emulators",
args: {
name: "script",
},
options: [
{
name: "--only",
description:
'Only specific emulators. This is a comma separated list of emulator names. Valid options are: ["auth","functions","firestore","database","hosting","pubsub"]',
args: {},
},
{
name: "--inspect-functions",
description:
"Emulate Cloud Functions in debug mode with the node inspector on the given port (9229 if not specified)",
},
{
name: "--import",
description:
"Import emulator data from a previous export (see emulators:export)",
args: {},
},
{
name: "--export-on-exit",
description:
"Automatically export emulator data (emulators:export) when the emulators make a clean exit (SIGINT), when no dir is provided the location of --import [dir] is used",
},
{
name: "--ui",
description: "Run the Emulator UI",
},
{
name: ["-h", "--help"],
description: "Output usage information",
},
],
},
{
name: "emulators:export",
description: "Export data from running emulators",
args: {
name: "path",
template: "filepaths",
},
options: [
{
name: "--only",
description:
'Only specific emulators. This is a comma separated list of emulator names. Valid options are: ["auth","functions","firestore","database","hosting","pubsub"]',
args: {},
},
{
name: "--force",
description: "Overwrite any export data in the target directory",
},
{
name: ["-h", "--help"],
description: "Output usage information",
},
],
},
{
name: "emulators:start",
description: "Start the local Firebase emulators",
options: [
{
name: "--only",
description:
'Only specific emulators. This is a comma separated list of emulator names. Valid options are: ["auth","functions","firestore","database","hosting","pubsub"]',
args: {},
},
{
name: "--inspect-functions",
description:
"Emulate Cloud Functions in debug mode with the node inspector on the given port (9229 if not specified)",
args: {},
},
{
name: "--import",
description:
"Import emulator data from a previous export (see emulators:export)",
},
{
name: "--export-on-exit",
description:
"Automatically export emulator data (emulators:export) when the emulators make a clean exit (SIGINT), when no dir is provided the location of --import [dir] is used",
},
{
name: ["-h", "--help"],
description: "Output usage information",
},
],
},
{
name: "experimental:functions:shell",
description: "Launch full Node shell with emulated functions",
options: [
{
name: ["-p", "--port"],
description:
"The port on which to emulate functions (default: 5000) (default: 5000)",
args: {},
},
{
name: ["-h", "--help"],
description: "Output usage information",
},
],
},
{
name: "ext:configure",
description: "Configure an existing extension instance",
args: {
name: "extensionInstanceId",
},
options: [
{
name: "--params",
description: "Path of params file with .env format",
args: {},
},
{
name: ["-h", "--help"],
description: "Output usage information",
},
],
},
{
name: "ext:info",
description:
"List all the extensions that are installed in your Firebase project",
args: {
name: "extensionName",
},
options: [
{
name: "--markdown",
description:
"Output info in Markdown suitable for constructing a README file",
},
{
name: ["-h", "--help"],
description: "Output usage information",
},
],
},
{
name: "ext:uninstall",
description:
"Uninstall an extension that is installed in your Firebase project by instance ID",
args: {
name: "extensionInstanceId",
},
options: [
{
name: ["-f", "--force"],
description:
"No confirmation. Otherwise, a confirmation prompt will appear",
},
{
name: ["-h", "--help"],
description: "Output usage information",
},
],
},
{
name: "ext:update",
description:
"Update an existing extension instance to the latest version",
args: {
name: "extensionInstanceId",
},
options: [
{
name: ["-h", "--help"],
description: "Output usage information",
},
],
},
{
name: "firestore:delete",
description: "Delete data from Cloud Firestore",
args: {
name: "path",
},
options: [
{
name: ["-r", "--recursive"],
description:
"Recursive. Delete all documents and subcollections at and under the specified level. May not be passed along with",
},
{
name: "--shallow",
description:
"Shallow. Delete only documents at the specified level and ignore documents in subcollections. This action can potentially orphan documents nested in subcollections. May not be passed along with -r",
},
{
name: "--all-collections",
description:
"Delete all. Deletes the entire Firestore database, including all collections and documents. Any other flags or arguments will be ignored",
},
{
name: ["-y", "--yes"],
description:
"No confirmation. Otherwise, a confirmation prompt will appear",
},
{
name: ["-h", "--help"],
description: "Output usage information",
},
],
},
{
name: "firestore:indexes",
description: "List indexes in your project's Cloud Firestore database",
options: [
{
name: "--pretty",
description:
"Pretty print. When not specified the indexes are printed in the JSON specification format",
},
{
name: ["-h", "--help"],
description: "Output usage information",
},
],
},
{
name: "functions:config:clone",
description: "Clone environment config from another project",
options: [
{
name: "--from",
description: "The project from which to clone configuration",
args: {},
},
{
name: "--only",
description: "A comma-separated list of keys to clone",
args: {},
},
{
name: "--except",
description: "A comma-separated list of keys to not clone",
args: {},
},
{
name: ["-h", "--help"],
description: "Output usage information",
},
],
},
{
name: "functions:config:get",
description: "Fetch environment config stored at the given path",
args: {
name: "path",
},
options: [
{
name: ["-h", "--help"],
description: "Output usage information",
},
],
},
{
name: "functions:config:set",
description: "Set environment config with key=value syntax",
args: {
name: "values",
isVariadic: true,
description: "Key=value",
},
options: [
{
name: ["-h", "--help"],
description: "Output usage information",
},
],
},
{
name: "functions:log",
description: "Read logs from deployed functions",
options: [
{
name: "--only",
description:
'Only show logs of specified, comma-seperated functions (e.g. "funcA,funcB")',
args: {},
},
{
name: ["-n", "--lines"],
description: "Specify number of log lines to fetch",
args: {},
},
{
name: "--open",
description: "Open logs page in web browser",
},
{
name: ["-h", "--help"],
description: "Output usage information",
},
],
},
{
name: "functions:shell",
description: "Launch full Node shell with emulated functions",
options: [
{
name: ["-p", "--port"],
description: "The port on which to emulate functions",
args: {},
},
{
name: "--inspect-functions",
description:
"Emulate Cloud Functions in debug mode with the node inspector on the given port (9229 if not specified)",
args: {},
},
{
name: ["-h", "--help"],
description: "Output usage information",
},
],
},
{
name: "help",
description: "Display help information",
options: [
{
name: ["-h", "--help"],
description: "Output usage information",
},
],
},
{
name: "hosting:channel:create",
description: "Create a Firebase Hosting channel",
args: {
name: "channelId",
},
options: [
{
name: ["-e", "--expires"],
description:
"Duration string (e.g. 12h or 30d) for channel expiration, max 30d",
args: {},
},
{
name: "--site",
description: "Site for which to create the channel",
args: {},
},
{
name: ["-h", "--help"],
description: "Output usage information",
},
],
},
{
name: "hosting:channel:delete",
description: "Delete a Firebase Hosting channel",
args: {
name: "channelId",
},
options: [
{
name: "--site",
description: "Site in which the channel exists",
args: {},
},
{
name: ["-f", "--force"],
description: "Delete without confirmation",
},
{
name: ["-h", "--help"],
description: "Output usage information",
},
],
},
{
name: "hosting:channel:deploy",
description: "Deploy to a specific Firebase Hosting channel",
args: {
name: "channelId",
},
options: [
{
name: ["-e", "--expires"],
description:
"Duration string (e.g. 12h, 30d) for channel expiration, max 30d; defaults to 7d",
args: {},
},
{
name: "--only",
description: "Only create previews for specified targets",
},
{
name: "--open",
description: "Open a browser to the channel after deploying",
},
{
name: "--no-authorized-domains",
description: "Do not sync channel domains with Firebase Auth",
},
{
name: ["-h", "--help"],
description: "Output usage information",
},
],
},
{
name: "hosting:channel:list",
description: "List all Firebase Hosting channels for your project",
options: [
{
name: "--site",
description: "List channels for the specified site",
args: {},
},
{
name: ["-h", "--help"],
description: "Output usage information",
},
],
},
{
name: "hosting:channel:open",
description: "Opens the URL for a Firebase Hosting channel",
args: {
name: "channelId",
},
options: [
{
name: "--site",
description: "The site to which the channel belongs",
args: {},
},
{
name: ["-h", "--help"],
description: "Output usage information",
},
],
},
{
name: "hosting:clone",
description: "Clone a version from one site to another",
args: [
{
name: "source",
},
{
name: "targetChannel",
},
],
options: [
{
name: ["-h", "--help"],
description: "Output usage information",
},
],
},
{
name: "hosting:disable",
description: "Stop serving web traffic to your Firebase Hosting site",
options: [
{
name: ["-y", "--confirm"],
description: "Skip confirmation",
},
{
name: ["-s", "--site"],
description: "The site to disable",
args: {},
},
{
name: ["-h", "--help"],
description: "Output usage information",
},
],
},
{
name: "hosting:sites:create",
description: "Create a Firebase Hosting site",
args: {