forked from withfig/autocomplete
-
Notifications
You must be signed in to change notification settings - Fork 0
/
ionic.ts
1737 lines (1736 loc) · 49.1 KB
/
ionic.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 completionSpec = {
name: "ionic",
description:
"The Ionic command-line interface (CLI) is the go-to tool for developing Ionic apps.",
subcommands: [
{
name: "build",
options: [
{
name: "--engine",
description: "Target engine (e.g. browser, cordova)",
args: {
name: "engine",
suggestions: ["browser", "cordova"],
},
},
{
name: "--platform",
description: "Target platform on chosen engine (e.g. ios, android)",
args: {
name: "platform",
suggestions: ["ios", "android"],
},
},
{
name: "--prod",
description: "Flag to use the production configuration",
},
{
name: ["--configuration", "-c"],
description: "Specify the configuration to use",
args: {
name: "conf",
template: ["filepaths", "folders"],
},
},
{
name: "--source-map",
description: "Output source maps",
},
{
name: "--watch",
description: "Rebuild when files change",
},
],
description:
"Build web assets and prepare your app for any platform targets",
},
{
name: "completion",
description: "Enables tab-completion for Ionic CLI commands.",
},
{
name: "docs",
options: [
{
name: ["--browser", "-w"],
description:
"Specifies the browser to use (safari, firefox, google chrome)",
args: {
name: "browser",
suggestions: ["safari", "firefox", "google chrome"],
},
},
],
description: "Open the Ionic documentation website",
},
{
name: "info",
options: [
{
name: "--json",
description: "Print system/environment info in JSON format",
},
],
description: "Print project, system, and environment information",
},
{
name: "init",
options: [
{
name: "--type",
description: "Type of project (e.g. angular, react, vue, custom)",
args: {
name: "type",
suggestions: ["angular", "react", "vue", "custom"],
},
},
{
name: ["--force", "-f"],
description: "Initialize even if a project already exists",
},
{
name: "--multi-app",
description: "Initialize a multi-app project",
},
{
name: "--project-id",
description: "Specify a slug for your app",
args: {
name: "slug",
},
},
{
name: "--default",
description: "Mark the initialized app as the default project",
},
],
args: {
name: "name",
description: 'The name of your project (e.g. myApp, "My App")',
isOptional: true,
},
description: "Initialize existing projects with Ionic",
},
{
name: "link",
args: {
name: "id",
description: "The Appflow ID of the app to link (e.g. a1b2c3d4)",
isOptional: true,
},
description: "Connect local apps to Ionic",
},
{
name: "login",
args: [
{
name: "email",
description: "Your email address",
isOptional: true,
},
{
name: "password",
description: "Your password",
isOptional: true,
},
],
description: "Log in to Ionic",
},
{
name: "logout",
description: "Log out of Ionic",
},
{
name: "repair",
options: [
{
name: "--cordova",
description:
"Only perform the repair steps for Cordova platforms and plugins.",
},
],
description: "Remove and recreate dependencies and generated files",
},
{
name: "serve",
options: [
{
name: "--external",
description:
"Host dev server on all network interfaces (i.e. --host=0.0.0.0)",
},
{
name: "--host",
description: "Use specific host for the dev server",
args: {
name: "host",
},
},
{
name: ["--port", "-p"],
description: "Use specific port for the dev server",
args: {
name: "port",
default: 8100,
},
},
{
name: "--public-host",
description: "The host used for the browser or web view",
args: {
name: "host",
default: "localhost",
},
},
{
name: "--no-livereload",
description: "Do not spin up dev server--just serve files",
},
{
name: "--lab-host",
description: "Use specific host for Ionic Lab server",
args: {
name: "host",
default: 8200,
},
},
{
name: "--lab-port",
description: "Use specific port for Ionic Lab server",
args: {
name: "port",
},
},
{
name: "--no-open",
description: "Do not open a browser window",
},
{
name: ["--browser", "-w"],
description:
"Specifies the browser to use (safari, firefox, google chrome)",
args: {
name: "browser",
suggestions: ["safari", "firefox", "google chrome"],
},
},
{
name: ["--browseroption", "-o"],
description: "Specifies a path to open to (/#/tab/dash)",
args: {
name: "path",
},
},
{
name: ["--lab", "-l"],
description:
"Test your apps on multiple platform types in the browser",
},
{
name: "--ssl",
description: "Use HTTPS for the dev server",
},
{
name: "--prod",
description: "Flag to use the production configuration",
},
{
name: "--consolelogs",
description: "Print app console logs to the terminal",
},
{
name: "--consolelogs-port",
description: "Use specific port for console logs server",
args: {
name: "port",
},
},
{
name: ["--configuration", "-c"],
description: "Specify the configuration to use",
args: {
name: "conf",
template: ["filepaths", "folders"],
},
},
{
name: "--source-map",
description: "Output sourcemaps",
},
],
description: "Start a local dev server for app dev/testing",
},
{
name: "signup",
description: "Create an Ionic account",
},
{
name: "start",
options: [
{
name: ["--list", "-l"],
description: "List available starter templates",
},
{
name: "--type",
description:
"Type of project to start (e.g. vue, angular, react, ionic-angular, ionic1)",
args: {
name: "type",
suggestions: ["vue", "angular", "react", "ionic-angular", "ionic1"],
},
},
{
name: "--cordova",
description: "Include Cordova integration",
},
{
name: "--capacitor",
description: "Include Capacitor integration",
},
{
name: "--no-deps",
description: "Do not install npm/yarn dependencies",
},
{
name: "--no-git",
description: "Do not initialize a git repo",
},
{
name: "--link",
description: "Connect your new app to Ionic",
},
{
name: "--id",
description: "Specify an Ionic App ID to link",
args: {
name: "id",
},
},
{
name: "--project-id",
description:
"Specify a slug for your app (used for the directory name and package name)",
args: {
name: "slug",
},
},
{
name: "--package-id",
description:
"Specify the bundle ID/application ID for your app (reverse-DNS notation)",
args: {
name: "id",
},
},
],
args: [
{
name: "name",
description: 'The name of your new project (e.g. myApp, "My App")',
isOptional: false,
},
// Hard to do suggestions for template b/c different templates exist for different --types
{
name: "template",
description:
"The starter template to use (e.g. blank, tabs; use --list to see all)",
isOptional: false,
},
],
description: "Create a new project",
},
{
name: "config",
description: "Config commands for Ionic",
subcommands: [
{
name: "get",
options: [
{
name: ["--global", "-g"],
description: "Use global CLI config",
},
{
name: "--json",
description: "Output config values in JSON",
},
{
name: "--root",
description: "Operate on root of ionic.config.json",
},
],
args: {
name: "property",
description: "The property name you wish to get",
isOptional: true,
},
description: "Print config values",
},
{
name: "set",
options: [
{
name: ["--global", "-g"],
description: "Use global CLI config",
},
{
name: "--json",
description: "Always interpret value as JSON",
},
{
name: "--force",
description: "Always overwrite existing values",
},
{
name: "--root",
description: "Operate on root of ./ionic.config.json",
},
],
args: [
{
name: "property",
description: "The property name you wish to set",
isOptional: false,
},
{
name: "value",
description: "The new value of the given property",
isOptional: false,
},
],
description: "Set config values",
},
{
name: "unset",
options: [
{
name: ["--global", "-g"],
description: "Use global CLI config",
},
{
name: "--root",
description: "Operate on root of ./ionic.config.json",
},
],
args: {
name: "property",
description: "The property name you wish to delete",
isOptional: false,
},
description: "Delete config values",
},
],
},
{
name: "capacitor",
description: "Capacitor commands Ionic",
subcommands: [
{
name: "add",
args: {
name: "platform",
description: "The platform to add (e.g. android, ios)",
isOptional: false,
suggestions: ["ios", "android"],
},
description: "Add a native platform to your Ionic project",
},
{
name: "build",
options: [
{
name: "--no-build",
description: "Do not invoke Ionic build",
},
{
name: "--no-open",
description: "Do not invoke Capacitor open",
},
{
name: "--prod",
description: "Flag to use the production configuration",
},
{
name: ["configuration", "-c"],
description: "Specify the configuration to use",
},
{
name: "--source-map",
description: "Output source maps",
},
{
name: "--watch",
description: "Rebuild when files change",
},
],
args: {
name: "platform",
description: "The platform to build for (e.g. android, ios)",
isOptional: false,
suggestions: ["ios", "android"],
},
description: "Build an Ionic project for a given platform",
},
{
name: "copy",
options: [
{
name: "--no-build",
description: "Do not invoke an Ionic build",
},
{
name: "--prod",
description: "Flag to use the production configuration",
},
{
name: ["configuration", "-c"],
description: "Specify the configuration to use",
},
{
name: "--source-map",
description: "Output source maps",
},
{
name: "--watch",
description: "Rebuild when files change",
},
],
args: {
name: "platform",
description: "The platform to copy (e.g. android, ios)",
isOptional: true,
},
description: "Copy web assets to native platforms",
},
{
name: "open",
args: {
name: "platform",
description: "The platform to open (e.g. android, ios)",
isOptional: false,
suggestions: ["ios", "android"],
},
description: "Open the IDE for a given native platform project",
},
{
name: "run",
options: [
{
name: "--list",
description: "List all available targets",
},
{
name: "--target",
description:
"Deploy to a specific device by its ID (use --list to see all)",
args: {
name: "target",
},
},
{
name: "--open",
description: "Open native IDE instead of using capacitor run",
},
{
name: "--no-build",
description: "Do not invoke Ionic build",
},
{
name: "--external",
description:
"Host dev server on all network interfaces (i.e. --host=0.0.0.0)",
},
{
name: "--host",
description: "Use specific host for the dev server",
args: {
name: "host",
default: "localhost",
},
},
{
name: ["--port", "-p"],
description: "Use specific port for the dev server",
args: {
name: "port",
default: 8100,
},
},
{
name: "--public-host",
description: "The host used for the browser or web view",
args: {
name: "host",
},
},
{
name: ["--livereload", "-l"],
description: "Spin up dev server to live-reload www files",
},
{
name: "--livereload-url",
description: "Provide a custom URL to the dev server",
args: {
name: "url",
},
},
{
name: "--prod",
description: "Flag to use the production configuration",
},
{
name: ["--configuration", "-c"],
description: "Specify the configuration to use",
args: {
name: "conf",
template: ["filepaths", "folders"],
},
},
{
name: "--source-map",
description: "Output source maps",
},
{
name: "--watch",
description: "Rebuild when files change",
},
],
args: {
name: "platform",
description: "The platform to run (e.g. android, ios)",
isOptional: false,
suggestions: ["ios", "android"],
},
description: "Run an Ionic project on a connected device",
},
{
name: "sync",
options: [
{
name: "--no-build",
description: "Do not invoke an Ionic build",
},
{
name: "--prod",
description: "Flag to use the production configuration",
},
{
name: ["--configuration", "-c"],
description: "Specify the configuration to use",
args: {
name: "conf",
template: ["filepaths", "folders"],
},
},
{
name: "--source-map",
description: "Output source maps",
},
{
name: "--watch",
description: "Rebuild when files change",
},
],
args: {
name: "platform",
description: "The platform to sync (e.g. android, ios)",
isOptional: true,
suggestions: ["ios", "android"],
},
description: "Sync (copy + update) an Ionic project",
},
{
name: "update",
args: {
name: "platform",
description: "The platform to update (e.g. android, ios)",
isOptional: true,
suggestions: ["ios", "android"],
},
description:
"Update Capacitor native platforms, install Capacitor/Cordova plugins",
},
],
},
{
name: "deploy",
description: "AppFlow deploy commands for Ionic",
subcommands: [
{
name: "add",
options: [
{
name: "--app-id",
description: "Your Appflow app ID",
args: {
name: "id",
},
},
{
name: "--channel-name",
description: "The channel to check for updates from",
args: {
name: "name",
},
},
{
name: "--update-method",
description:
"The update method that dictates the behavior of the plugin",
args: {
name: "name",
},
},
{
name: "--max-store",
description:
"The maximum number of downloaded versions to store on the device",
args: {
name: "quantity",
default: 2,
},
},
{
name: "--min-background-duration",
description:
"The minimum duration after which the app checks for an update in the background",
args: {
name: "seconds",
default: 30,
},
},
],
description: "Adds Appflow Deploy to the project",
},
{
name: "build",
options: [
{
name: "--environment",
description:
"The group of environment variables exposed to your build",
args: {
name: "name",
},
},
{
name: "--channel",
description:
"The channel you want to auto deploy the build to. This can be repeated multiple times if multiple channels need to be specified.",
args: {
name: "name",
},
},
{
name: "--commit",
description: "Commit (defaults to HEAD)",
args: {
name: "sha1",
},
},
{
name: "--skip-download",
description:
"Skip downloading build artifacts after command succeeds.",
},
],
description: "Create a deploy build on Appflow",
},
{
name: "configure",
options: [
{
name: "--app-id",
description: "Your Appflow app ID",
args: {
name: "id",
},
},
{
name: "--channel-name",
description: "The channel to check for updates from",
args: {
name: "name",
},
},
{
name: "--update-method",
description:
"The update method that dictates the behavior of the plugin",
args: {
name: "name",
},
},
{
name: "--max-store",
description:
"The maximum number of downloaded versions to store on the device",
args: {
name: "quantity",
},
},
{
name: "--min-background-duration",
description:
"The minimum duration after which the app checks for an update in the background",
args: {
name: "seconds",
},
},
],
args: {
name: "platform",
description: "The native platform (e.g. ios, android)",
isOptional: true,
},
description: "Overrides Appflow Deploy configuration",
},
{
name: "manifest",
description:
"Generates a manifest file for the deploy service from a built app directory",
},
],
},
{
name: "git",
description: "Git commands for Ionic",
subcommands: [
{
name: "remote",
description:
"Adds/updates the Appflow git remote to your local Ionic app",
},
],
},
{
name: "package",
description: "Package commands for Ionic",
subcommands: [
{
name: "build",
options: [
{
name: "--signing-certificate",
description: "Signing certificate",
args: {
name: "name",
},
},
{
name: "--environment",
description:
"The group of environment variables exposed to your build",
args: {
name: "name",
},
},
{
name: "--native-config",
description:
"The group of native config variables exposed to your build",
args: {
name: "name",
},
},
{
name: "--destination",
description:
"The configuration to deploy the build artifact to the app store",
args: {
name: "name",
},
},
{
name: "--commit",
description: "Commit (defaults to HEAD)",
args: {
name: "sha1",
},
},
{
name: "--build-stack",
description:
'Target platform ("Android", "iOS - Xcode 11 (Preferred)", "iOS - Xcode 10")',
args: {
name: "name",
suggestions: [
"Android",
"iOS - Xcode 11 (Preferred)",
"iOS - Xcode 10",
],
},
},
{
name: "--build-file-name",
description: "The name for the downloaded build file",
args: {
name: "name",
},
},
{
name: "--ipa-name",
description: "The name for the downloaded ipa file",
args: {
name: "name",
},
},
{
name: "--dsym-name",
description: "The name for the downloaded dsym file",
args: {
name: "name",
},
},
{
name: "--apk-name",
description: "The name for the downloaded apk file",
args: {
name: "name",
},
},
{
name: "--aab-name",
description: "The name for the downloaded aab file",
args: {
name: "name",
},
},
{
name: "--artifact-type",
description: "The artifact type (aab, apk, ipa, dsym)",
args: {
name: "name",
suggestions: ["aab", "apl", "ipa", "dysm"],
},
},
{
name: "--skip-download",
description:
"Skip downloading build artifacts after command succeeds.",
},
],
args: [
{
name: "platform",
description: "The platform to package (android, ios)",
isOptional: false,
suggestions: ["ios", "android"],
},
{
name: "type",
description:
"The build type (debug, release, development, ad-hoc, app-store, enterprise)",
isOptional: false,
suggestions: [
"debug",
"release",
"development",
"ad-hoc",
"app-stpre",
"enterprise",
],
},
],
description: "Create a package build on Appflow",
},
{
name: "deploy",
args: [
{
name: "build-id",
description:
"The build id of the desired successful package build",
isOptional: false,
},
{
name: "destination",
description:
"The destination to deploy the build artifact to the app store",
isOptional: false,
},
],
description:
"Deploys a binary to a destination, such as an app store using Appflow",
},
],
},
{
name: "ssl",
description: "SSL commands for Ionic",
subcommands: [
{
name: "generate",
options: [
{
name: "--key-path",
description: "Destination of private key file",
args: {
name: "path",
default: "./.ionic/ssl/key.pem",
},
},
{
name: "--cert-path",
description: "Destination of certificate file",
args: {
name: "path",
default: "./.ionic/ssl/cert.pem",
},
},
{
name: "--country-name",
description: "The country name (C) of the SSL certificate",
args: {
name: "C",
default: "US",
},
},
{
name: "--state-or-province-name",
description:
"The state or province name (ST) of the SSL certificate",
args: {
name: "ST",
default: "Wisconsin",
},
},