@swell/cli 2.0.1-alpha.13 → 2.0.1-alpha.17
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/app-command.d.ts +1 -1
- package/dist/app-command.js +8 -8
- package/dist/commands/app/dev.d.ts +18 -0
- package/dist/commands/app/dev.js +31 -0
- package/dist/commands/app/frontend/deploy.d.ts +17 -0
- package/dist/commands/app/frontend/deploy.js +44 -0
- package/dist/commands/app/frontend/dev.d.ts +21 -0
- package/dist/commands/app/frontend/dev.js +111 -0
- package/dist/commands/app/info.js +15 -8
- package/dist/commands/app/init.d.ts +12 -0
- package/dist/commands/app/init.js +34 -0
- package/dist/commands/app/install.d.ts +4 -4
- package/dist/commands/app/install.js +37 -42
- package/dist/commands/app/pull.d.ts +15 -0
- package/dist/commands/app/pull.js +50 -0
- package/dist/commands/app/push.d.ts +11 -14
- package/dist/commands/app/push.js +71 -143
- package/dist/commands/app/release.d.ts +13 -0
- package/dist/commands/app/release.js +150 -0
- package/dist/commands/app/version.d.ts +7 -6
- package/dist/commands/app/version.js +64 -43
- package/dist/commands/app/watch.d.ts +2 -4
- package/dist/commands/app/watch.js +3 -83
- package/dist/commands/create/app.d.ts +35 -11
- package/dist/commands/create/app.js +150 -144
- package/dist/commands/create/content.d.ts +2 -2
- package/dist/commands/create/content.js +10 -10
- package/dist/commands/create/frontend.d.ts +12 -0
- package/dist/commands/create/frontend.js +41 -0
- package/dist/commands/create/function.d.ts +3 -3
- package/dist/commands/create/function.js +22 -22
- package/dist/commands/create/model.d.ts +2 -2
- package/dist/commands/create/model.js +11 -11
- package/dist/commands/create/notification.d.ts +4 -4
- package/dist/commands/create/notification.js +38 -40
- package/dist/commands/login.d.ts +1 -1
- package/dist/commands/login.js +12 -9
- package/dist/commands/logs.js +2 -1
- package/dist/commands/theme/dev.d.ts +23 -0
- package/dist/commands/theme/dev.js +167 -0
- package/dist/commands/theme/init.d.ts +9 -0
- package/dist/commands/theme/init.js +15 -0
- package/dist/commands/theme/pull.d.ts +20 -0
- package/dist/commands/theme/pull.js +65 -0
- package/dist/commands/theme/push.d.ts +19 -0
- package/dist/commands/theme/push.js +92 -0
- package/dist/create-app-command.d.ts +20 -0
- package/dist/create-app-command.js +254 -0
- package/dist/create-collection-command.d.ts +9 -9
- package/dist/create-collection-command.js +23 -23
- package/dist/{create-command.d.ts → create-config-command.d.ts} +1 -1
- package/dist/{create-command.js → create-config-command.js} +9 -7
- package/dist/lib/api.d.ts +6 -4
- package/dist/lib/api.js +58 -29
- package/dist/lib/app-config.d.ts +13 -5
- package/dist/lib/app-config.js +60 -23
- package/dist/lib/apps/app-config.d.ts +22 -8
- package/dist/lib/apps/app-config.js +202 -68
- package/dist/lib/apps/index.d.ts +93 -13
- package/dist/lib/apps/index.js +150 -50
- package/dist/lib/apps/paths.d.ts +14 -7
- package/dist/lib/apps/paths.js +73 -28
- package/dist/lib/bundle.js +4 -5
- package/dist/lib/config.d.ts +5 -1
- package/dist/lib/config.js +14 -0
- package/dist/lib/constants.d.ts +5 -0
- package/dist/lib/constants.js +22 -3
- package/dist/lib/create/content.d.ts +2 -2
- package/dist/lib/create/content.js +1 -1
- package/dist/lib/create/function.d.ts +2 -2
- package/dist/lib/create/function.js +2 -2
- package/dist/lib/create/index.d.ts +1 -1
- package/dist/lib/create/index.js +11 -7
- package/dist/lib/create/model.d.ts +2 -2
- package/dist/lib/create/notification.d.ts +2 -2
- package/dist/lib/info.js +2 -2
- package/dist/lib/sessions.js +2 -2
- package/dist/lib/stores.d.ts +5 -2
- package/dist/lib/stores.js +9 -6
- package/dist/lib/style.d.ts +2 -0
- package/dist/lib/style.js +2 -0
- package/dist/lib/swell-function-wrapper.d.ts +2 -2
- package/dist/lib/swell-function-wrapper.js +2 -2
- package/dist/push-app-command.d.ts +73 -0
- package/dist/push-app-command.js +765 -0
- package/dist/remote-app-command.d.ts +35 -9
- package/dist/remote-app-command.js +436 -164
- package/oclif.manifest.json +841 -125
- package/package.json +13 -1
- package/dist/commands/app/_pull.d.ts +0 -8
- package/dist/commands/app/_pull.js +0 -45
package/oclif.manifest.json
CHANGED
|
@@ -8,6 +8,13 @@
|
|
|
8
8
|
"<%= config.bin %> <%= command.id %>"
|
|
9
9
|
],
|
|
10
10
|
"flags": {
|
|
11
|
+
"force": {
|
|
12
|
+
"char": "f",
|
|
13
|
+
"description": "show all available stores and switch the current session if needed",
|
|
14
|
+
"name": "force",
|
|
15
|
+
"allowNo": false,
|
|
16
|
+
"type": "boolean"
|
|
17
|
+
},
|
|
11
18
|
"store": {
|
|
12
19
|
"char": "s",
|
|
13
20
|
"description": "store to login to",
|
|
@@ -15,13 +22,6 @@
|
|
|
15
22
|
"hasDynamicHelp": false,
|
|
16
23
|
"multiple": false,
|
|
17
24
|
"type": "option"
|
|
18
|
-
},
|
|
19
|
-
"force": {
|
|
20
|
-
"char": "f",
|
|
21
|
-
"description": "show all available stores and switch the current session if needed",
|
|
22
|
-
"name": "force",
|
|
23
|
-
"allowNo": false,
|
|
24
|
-
"type": "boolean"
|
|
25
25
|
}
|
|
26
26
|
},
|
|
27
27
|
"hasDynamicHelp": false,
|
|
@@ -258,92 +258,120 @@
|
|
|
258
258
|
"whoami.js"
|
|
259
259
|
]
|
|
260
260
|
},
|
|
261
|
-
"app:
|
|
261
|
+
"app:_uninstall": {
|
|
262
262
|
"aliases": [],
|
|
263
|
-
"args": {
|
|
264
|
-
|
|
265
|
-
"description": "app id to pull",
|
|
266
|
-
"name": "appId"
|
|
267
|
-
}
|
|
268
|
-
},
|
|
263
|
+
"args": {},
|
|
264
|
+
"description": "Uninstalls an existing App",
|
|
269
265
|
"examples": [
|
|
270
266
|
"<%= config.bin %> <%= command.id %>"
|
|
271
267
|
],
|
|
272
268
|
"flags": {
|
|
273
269
|
"app-path": {
|
|
274
|
-
"description": "path to
|
|
270
|
+
"description": "path to your app directory",
|
|
275
271
|
"name": "app-path",
|
|
276
272
|
"hasDynamicHelp": false,
|
|
277
273
|
"multiple": false,
|
|
278
274
|
"type": "option"
|
|
275
|
+
},
|
|
276
|
+
"env": {
|
|
277
|
+
"description": "environment to uninstall the app from",
|
|
278
|
+
"name": "env",
|
|
279
|
+
"default": "test",
|
|
280
|
+
"hasDynamicHelp": false,
|
|
281
|
+
"multiple": false,
|
|
282
|
+
"type": "option"
|
|
283
|
+
},
|
|
284
|
+
"store": {
|
|
285
|
+
"char": "s",
|
|
286
|
+
"description": "store id to uninstall the app from",
|
|
287
|
+
"name": "store",
|
|
288
|
+
"hasDynamicHelp": false,
|
|
289
|
+
"multiple": false,
|
|
290
|
+
"type": "option"
|
|
279
291
|
}
|
|
280
292
|
},
|
|
281
293
|
"hasDynamicHelp": false,
|
|
282
294
|
"hiddenAliases": [],
|
|
283
|
-
"id": "app:
|
|
295
|
+
"id": "app:_uninstall",
|
|
284
296
|
"pluginAlias": "@swell/cli",
|
|
285
297
|
"pluginName": "@swell/cli",
|
|
286
298
|
"pluginType": "core",
|
|
287
299
|
"strict": true,
|
|
288
|
-
"summary": "Pull app configuration from remote.",
|
|
289
300
|
"enableJsonFlag": false,
|
|
301
|
+
"delayOrientation": false,
|
|
302
|
+
"orientation": {
|
|
303
|
+
"env": "test"
|
|
304
|
+
},
|
|
290
305
|
"isESM": true,
|
|
291
306
|
"relativePath": [
|
|
292
307
|
"dist",
|
|
293
308
|
"commands",
|
|
294
309
|
"app",
|
|
295
|
-
"
|
|
310
|
+
"_uninstall.js"
|
|
296
311
|
]
|
|
297
312
|
},
|
|
298
|
-
"app:
|
|
313
|
+
"app:dev": {
|
|
299
314
|
"aliases": [],
|
|
300
315
|
"args": {},
|
|
301
|
-
"description": "Uninstalls an existing App",
|
|
302
316
|
"examples": [
|
|
303
|
-
"
|
|
317
|
+
"swell app dev",
|
|
318
|
+
"swell app dev --storefront-id <id>",
|
|
319
|
+
"swell app dev --port 3000"
|
|
304
320
|
],
|
|
305
321
|
"flags": {
|
|
306
322
|
"app-path": {
|
|
307
|
-
"description": "path to
|
|
323
|
+
"description": "path to your app directory",
|
|
308
324
|
"name": "app-path",
|
|
309
325
|
"hasDynamicHelp": false,
|
|
310
326
|
"multiple": false,
|
|
311
327
|
"type": "option"
|
|
312
328
|
},
|
|
313
|
-
"
|
|
314
|
-
"
|
|
315
|
-
"
|
|
316
|
-
"
|
|
329
|
+
"port": {
|
|
330
|
+
"char": "p",
|
|
331
|
+
"description": "override the default port to run the app locally",
|
|
332
|
+
"name": "port",
|
|
317
333
|
"hasDynamicHelp": false,
|
|
318
334
|
"multiple": false,
|
|
319
335
|
"type": "option"
|
|
320
336
|
},
|
|
321
|
-
"
|
|
322
|
-
"
|
|
323
|
-
"
|
|
324
|
-
"
|
|
337
|
+
"no-push": {
|
|
338
|
+
"description": "skip pushing app files initially",
|
|
339
|
+
"name": "no-push",
|
|
340
|
+
"allowNo": false,
|
|
341
|
+
"type": "boolean"
|
|
342
|
+
},
|
|
343
|
+
"storefront-id": {
|
|
344
|
+
"description": "for storefront apps, identify a storefront to preview and push theme files to",
|
|
345
|
+
"name": "storefront-id",
|
|
325
346
|
"hasDynamicHelp": false,
|
|
326
347
|
"multiple": false,
|
|
327
348
|
"type": "option"
|
|
349
|
+
},
|
|
350
|
+
"storefront-select": {
|
|
351
|
+
"description": "for storefront apps, prompt to select a storefront to preview",
|
|
352
|
+
"name": "storefront-select",
|
|
353
|
+
"allowNo": false,
|
|
354
|
+
"type": "boolean"
|
|
328
355
|
}
|
|
329
356
|
},
|
|
330
357
|
"hasDynamicHelp": false,
|
|
331
358
|
"hiddenAliases": [],
|
|
332
|
-
"id": "app:
|
|
359
|
+
"id": "app:dev",
|
|
333
360
|
"pluginAlias": "@swell/cli",
|
|
334
361
|
"pluginName": "@swell/cli",
|
|
335
362
|
"pluginType": "core",
|
|
336
363
|
"strict": true,
|
|
337
|
-
"
|
|
364
|
+
"summary": "Run an app in dev mode from your local machine.",
|
|
338
365
|
"orientation": {
|
|
339
366
|
"env": "test"
|
|
340
367
|
},
|
|
368
|
+
"delayOrientation": true,
|
|
341
369
|
"isESM": true,
|
|
342
370
|
"relativePath": [
|
|
343
371
|
"dist",
|
|
344
372
|
"commands",
|
|
345
373
|
"app",
|
|
346
|
-
"
|
|
374
|
+
"dev.js"
|
|
347
375
|
]
|
|
348
376
|
},
|
|
349
377
|
"app:info": {
|
|
@@ -367,7 +395,7 @@
|
|
|
367
395
|
],
|
|
368
396
|
"flags": {
|
|
369
397
|
"app-path": {
|
|
370
|
-
"description": "path to
|
|
398
|
+
"description": "path to your app directory",
|
|
371
399
|
"name": "app-path",
|
|
372
400
|
"hasDynamicHelp": false,
|
|
373
401
|
"multiple": false,
|
|
@@ -383,6 +411,7 @@
|
|
|
383
411
|
"strict": true,
|
|
384
412
|
"summary": "Show information about your Swell app.",
|
|
385
413
|
"enableJsonFlag": false,
|
|
414
|
+
"delayOrientation": false,
|
|
386
415
|
"isESM": true,
|
|
387
416
|
"relativePath": [
|
|
388
417
|
"dist",
|
|
@@ -391,18 +420,81 @@
|
|
|
391
420
|
"info.js"
|
|
392
421
|
]
|
|
393
422
|
},
|
|
423
|
+
"app:init": {
|
|
424
|
+
"aliases": [],
|
|
425
|
+
"args": {
|
|
426
|
+
"id": {
|
|
427
|
+
"default": "",
|
|
428
|
+
"description": "id of the app to create",
|
|
429
|
+
"name": "id"
|
|
430
|
+
}
|
|
431
|
+
},
|
|
432
|
+
"description": "Initialize app swell.json in the current directory.",
|
|
433
|
+
"examples": [
|
|
434
|
+
{
|
|
435
|
+
"command": "swell app init",
|
|
436
|
+
"description": "Initialize app following command prompts."
|
|
437
|
+
},
|
|
438
|
+
{
|
|
439
|
+
"command": "swell app init -y",
|
|
440
|
+
"description": "Initialize app and accept all default values."
|
|
441
|
+
}
|
|
442
|
+
],
|
|
443
|
+
"flags": {
|
|
444
|
+
"yes": {
|
|
445
|
+
"char": "y",
|
|
446
|
+
"description": "accept all default values",
|
|
447
|
+
"name": "yes",
|
|
448
|
+
"allowNo": false,
|
|
449
|
+
"type": "boolean"
|
|
450
|
+
},
|
|
451
|
+
"frontend": {
|
|
452
|
+
"description": "create a starter framework for a hosted frontend",
|
|
453
|
+
"name": "frontend",
|
|
454
|
+
"hasDynamicHelp": false,
|
|
455
|
+
"multiple": false,
|
|
456
|
+
"options": [
|
|
457
|
+
"nextjs",
|
|
458
|
+
"astro"
|
|
459
|
+
],
|
|
460
|
+
"type": "option"
|
|
461
|
+
},
|
|
462
|
+
"storefront-app": {
|
|
463
|
+
"description": "id of an installed storefront app to create a theme for, if applicable",
|
|
464
|
+
"name": "storefront-app",
|
|
465
|
+
"hasDynamicHelp": false,
|
|
466
|
+
"multiple": false,
|
|
467
|
+
"type": "option"
|
|
468
|
+
}
|
|
469
|
+
},
|
|
470
|
+
"hasDynamicHelp": false,
|
|
471
|
+
"hiddenAliases": [],
|
|
472
|
+
"id": "app:init",
|
|
473
|
+
"pluginAlias": "@swell/cli",
|
|
474
|
+
"pluginName": "@swell/cli",
|
|
475
|
+
"pluginType": "core",
|
|
476
|
+
"strict": true,
|
|
477
|
+
"enableJsonFlag": false,
|
|
478
|
+
"isESM": true,
|
|
479
|
+
"relativePath": [
|
|
480
|
+
"dist",
|
|
481
|
+
"commands",
|
|
482
|
+
"app",
|
|
483
|
+
"init.js"
|
|
484
|
+
]
|
|
485
|
+
},
|
|
394
486
|
"app:install": {
|
|
395
487
|
"aliases": [],
|
|
396
488
|
"args": {},
|
|
397
489
|
"description": "Without a version specified, install the latest version of the app.\n\nWithout a store specified, install the app in the Live environment of the current store.",
|
|
398
490
|
"examples": [
|
|
399
|
-
"swell install",
|
|
400
|
-
"swell install -v 3.2.7",
|
|
401
|
-
"swell install -v 1.0.0 -s my-store-id"
|
|
491
|
+
"swell app install",
|
|
492
|
+
"swell app install -v 3.2.7",
|
|
493
|
+
"swell app install -v 1.0.0 -s my-store-id"
|
|
402
494
|
],
|
|
403
495
|
"flags": {
|
|
404
496
|
"app-path": {
|
|
405
|
-
"description": "path to
|
|
497
|
+
"description": "path to your app directory",
|
|
406
498
|
"name": "app-path",
|
|
407
499
|
"hasDynamicHelp": false,
|
|
408
500
|
"multiple": false,
|
|
@@ -442,6 +534,10 @@
|
|
|
442
534
|
"strict": true,
|
|
443
535
|
"summary": "Install an existing app in another store environment.",
|
|
444
536
|
"enableJsonFlag": false,
|
|
537
|
+
"delayOrientation": false,
|
|
538
|
+
"orientation": {
|
|
539
|
+
"env": "test"
|
|
540
|
+
},
|
|
445
541
|
"isESM": true,
|
|
446
542
|
"relativePath": [
|
|
447
543
|
"dist",
|
|
@@ -450,35 +546,91 @@
|
|
|
450
546
|
"install.js"
|
|
451
547
|
]
|
|
452
548
|
},
|
|
453
|
-
"app:
|
|
549
|
+
"app:pull": {
|
|
454
550
|
"aliases": [],
|
|
455
551
|
"args": {
|
|
456
|
-
"
|
|
457
|
-
"
|
|
458
|
-
"
|
|
552
|
+
"appId": {
|
|
553
|
+
"default": "",
|
|
554
|
+
"description": "app id to pull",
|
|
555
|
+
"name": "appId"
|
|
556
|
+
},
|
|
557
|
+
"targetPath": {
|
|
558
|
+
"default": "",
|
|
559
|
+
"description": "path to download app files into",
|
|
560
|
+
"name": "targetPath"
|
|
459
561
|
}
|
|
460
562
|
},
|
|
461
|
-
"description": "
|
|
563
|
+
"description": "Pull all app files, a specific file, or a specific configuration\ntype from an app in your store's test environment to your local machine.\n\nIf APPID is not specified, you will be prompted with a list of apps to choose from.\n\nApp file directories:\nassets/\ncontent/\nfunctions/\nmodels/\nnotifications/\nsettings/\nwebhooks/\nfrontend/\ntheme/\nfrontend/",
|
|
462
564
|
"examples": [
|
|
463
|
-
"swell app
|
|
464
|
-
"swell app
|
|
465
|
-
"swell app
|
|
565
|
+
"swell app pull",
|
|
566
|
+
"swell app pull example_app",
|
|
567
|
+
"swell app pull example_app example-folder",
|
|
568
|
+
"swell app pull --force"
|
|
466
569
|
],
|
|
467
570
|
"flags": {
|
|
468
571
|
"app-path": {
|
|
469
|
-
"description": "path to
|
|
572
|
+
"description": "path to your app directory",
|
|
470
573
|
"name": "app-path",
|
|
471
574
|
"hasDynamicHelp": false,
|
|
472
575
|
"multiple": false,
|
|
473
576
|
"type": "option"
|
|
474
577
|
},
|
|
578
|
+
"force": {
|
|
579
|
+
"description": "force pull all files",
|
|
580
|
+
"name": "force",
|
|
581
|
+
"allowNo": false,
|
|
582
|
+
"type": "boolean"
|
|
583
|
+
}
|
|
584
|
+
},
|
|
585
|
+
"hasDynamicHelp": false,
|
|
586
|
+
"hiddenAliases": [],
|
|
587
|
+
"id": "app:pull",
|
|
588
|
+
"pluginAlias": "@swell/cli",
|
|
589
|
+
"pluginName": "@swell/cli",
|
|
590
|
+
"pluginType": "core",
|
|
591
|
+
"strict": true,
|
|
592
|
+
"summary": "Pull app files from Swell to your local machine.",
|
|
593
|
+
"isESM": true,
|
|
594
|
+
"relativePath": [
|
|
595
|
+
"dist",
|
|
596
|
+
"commands",
|
|
597
|
+
"app",
|
|
598
|
+
"pull.js"
|
|
599
|
+
]
|
|
600
|
+
},
|
|
601
|
+
"app:push": {
|
|
602
|
+
"aliases": [],
|
|
603
|
+
"args": {
|
|
475
604
|
"file": {
|
|
476
|
-
"char": "f",
|
|
477
605
|
"description": "relative path to a configuration file or directory to push",
|
|
478
|
-
"name": "file"
|
|
606
|
+
"name": "file"
|
|
607
|
+
}
|
|
608
|
+
},
|
|
609
|
+
"description": "Push all app files, a specific file, or a specific configuration\ntype to an app in your store's test environment.\n\nIf the app does not exist, it will be created and its global ID saved to a .swellrc file.\n\n- If no file is specified, all configuration files will be pushed to the store.\n This includes the app icon (assets/icon.png) and swell.json.\n- If a file is specified, only that file will be pushed to the store.\n- If a directory is specified, only files in that directory will be pushed.\n\nApp file directories:\nassets/\ncontent/\nfunctions/\nmodels/\nnotifications/\nsettings/\nwebhooks/\nfrontend/\ntheme/",
|
|
610
|
+
"examples": [
|
|
611
|
+
"swell app push",
|
|
612
|
+
"swell app push content",
|
|
613
|
+
"swell app push models/products.json"
|
|
614
|
+
],
|
|
615
|
+
"flags": {
|
|
616
|
+
"app-path": {
|
|
617
|
+
"description": "path to your app directory",
|
|
618
|
+
"name": "app-path",
|
|
479
619
|
"hasDynamicHelp": false,
|
|
480
620
|
"multiple": false,
|
|
481
621
|
"type": "option"
|
|
622
|
+
},
|
|
623
|
+
"force": {
|
|
624
|
+
"description": "force push all configurations",
|
|
625
|
+
"name": "force",
|
|
626
|
+
"allowNo": false,
|
|
627
|
+
"type": "boolean"
|
|
628
|
+
},
|
|
629
|
+
"no-deploy": {
|
|
630
|
+
"description": "skip deploying app frontend",
|
|
631
|
+
"name": "no-deploy",
|
|
632
|
+
"allowNo": false,
|
|
633
|
+
"type": "boolean"
|
|
482
634
|
}
|
|
483
635
|
},
|
|
484
636
|
"hasDynamicHelp": false,
|
|
@@ -488,11 +640,11 @@
|
|
|
488
640
|
"pluginName": "@swell/cli",
|
|
489
641
|
"pluginType": "core",
|
|
490
642
|
"strict": true,
|
|
491
|
-
"summary": "Push
|
|
492
|
-
"enableJsonFlag": false,
|
|
643
|
+
"summary": "Push local files to your Swell app.",
|
|
493
644
|
"orientation": {
|
|
494
645
|
"env": "test"
|
|
495
646
|
},
|
|
647
|
+
"delayOrientation": true,
|
|
496
648
|
"isESM": true,
|
|
497
649
|
"relativePath": [
|
|
498
650
|
"dist",
|
|
@@ -501,6 +653,78 @@
|
|
|
501
653
|
"push.js"
|
|
502
654
|
]
|
|
503
655
|
},
|
|
656
|
+
"app:release": {
|
|
657
|
+
"aliases": [],
|
|
658
|
+
"args": {
|
|
659
|
+
"version": {
|
|
660
|
+
"description": "semver version to release",
|
|
661
|
+
"name": "version"
|
|
662
|
+
}
|
|
663
|
+
},
|
|
664
|
+
"description": "App released are reviewed by the Swell team for quality and functionality before publishing.\n\nIf the version does not exist, you will be prompted to create it.\n\nUse the --amend flag to update the description or release notes of an existing release version.\n\nUse the --supported=false flag to indicate the version is not officially supported by the developer.\n \nThe app must be connected to a partner account with access to publish.",
|
|
665
|
+
"examples": [
|
|
666
|
+
"swell app release",
|
|
667
|
+
"swell app release 2.0.0",
|
|
668
|
+
"swell app release 2.0.0 --amend --release-notes ./releases/v2.0.0.md"
|
|
669
|
+
],
|
|
670
|
+
"flags": {
|
|
671
|
+
"app-path": {
|
|
672
|
+
"description": "path to your app directory",
|
|
673
|
+
"name": "app-path",
|
|
674
|
+
"hasDynamicHelp": false,
|
|
675
|
+
"multiple": false,
|
|
676
|
+
"type": "option"
|
|
677
|
+
},
|
|
678
|
+
"release-notes": {
|
|
679
|
+
"description": "relative path to a file containing release notes",
|
|
680
|
+
"name": "release-notes",
|
|
681
|
+
"hasDynamicHelp": false,
|
|
682
|
+
"multiple": false,
|
|
683
|
+
"type": "option"
|
|
684
|
+
},
|
|
685
|
+
"message": {
|
|
686
|
+
"char": "m",
|
|
687
|
+
"description": "description of the changes in this version for internal use",
|
|
688
|
+
"name": "message",
|
|
689
|
+
"hasDynamicHelp": false,
|
|
690
|
+
"multiple": false,
|
|
691
|
+
"type": "option"
|
|
692
|
+
},
|
|
693
|
+
"amend": {
|
|
694
|
+
"description": "amend the description or release notes of an existing release",
|
|
695
|
+
"name": "amend",
|
|
696
|
+
"allowNo": false,
|
|
697
|
+
"type": "boolean"
|
|
698
|
+
},
|
|
699
|
+
"not-supported": {
|
|
700
|
+
"description": "indicates the version is not officially supported by the developer",
|
|
701
|
+
"name": "not-supported",
|
|
702
|
+
"allowNo": false,
|
|
703
|
+
"type": "boolean"
|
|
704
|
+
},
|
|
705
|
+
"no-git-tag": {
|
|
706
|
+
"description": "if the version is being created, do not create a git tag",
|
|
707
|
+
"name": "no-git-tag",
|
|
708
|
+
"allowNo": false,
|
|
709
|
+
"type": "boolean"
|
|
710
|
+
}
|
|
711
|
+
},
|
|
712
|
+
"hasDynamicHelp": false,
|
|
713
|
+
"hiddenAliases": [],
|
|
714
|
+
"id": "app:release",
|
|
715
|
+
"pluginAlias": "@swell/cli",
|
|
716
|
+
"pluginName": "@swell/cli",
|
|
717
|
+
"pluginType": "core",
|
|
718
|
+
"strict": true,
|
|
719
|
+
"summary": "Release a new version of your an app for publishing to the App Store.",
|
|
720
|
+
"isESM": true,
|
|
721
|
+
"relativePath": [
|
|
722
|
+
"dist",
|
|
723
|
+
"commands",
|
|
724
|
+
"app",
|
|
725
|
+
"release.js"
|
|
726
|
+
]
|
|
727
|
+
},
|
|
504
728
|
"app:version": {
|
|
505
729
|
"aliases": [],
|
|
506
730
|
"args": {
|
|
@@ -509,7 +733,7 @@
|
|
|
509
733
|
"name": "nextVersion"
|
|
510
734
|
}
|
|
511
735
|
},
|
|
512
|
-
"description": "When executed without specifying NEXTVERSION, the command will display the current\nversion of your app.\n\nIf a NEXTVERSION is provided, the command will validate and compute the version\naccording to Semver rules by only allowing incremental updates.\n\nThe version change will be committed to the Git repository using the provided\nmessage or a default similar to the tag, e.g. \"v1.0.1\".\n\nBy default, it creates a Git tag for the specified version. You can disable this\nbehavior by using the --git-tag
|
|
736
|
+
"description": "When executed without specifying NEXTVERSION, the command will display the current\nversion of your app.\n\nIf a NEXTVERSION is provided, the command will validate and compute the version\naccording to Semver rules by only allowing incremental updates.\n\nThe version change will be committed to the Git repository using the provided\nmessage or a default similar to the tag, e.g. \"v1.0.1\".\n\nBy default, it creates a Git tag for the specified version. You can disable this\nbehavior by using the --no-git-tag option.",
|
|
513
737
|
"examples": [
|
|
514
738
|
"swell app version",
|
|
515
739
|
"swell app version minor",
|
|
@@ -517,25 +741,31 @@
|
|
|
517
741
|
],
|
|
518
742
|
"flags": {
|
|
519
743
|
"app-path": {
|
|
520
|
-
"description": "path to
|
|
744
|
+
"description": "path to your app directory",
|
|
521
745
|
"name": "app-path",
|
|
522
746
|
"hasDynamicHelp": false,
|
|
523
747
|
"multiple": false,
|
|
524
748
|
"type": "option"
|
|
525
749
|
},
|
|
526
|
-
"git-tag": {
|
|
527
|
-
"description": "create a git tag for this version (default true)",
|
|
528
|
-
"name": "git-tag",
|
|
529
|
-
"allowNo": false,
|
|
530
|
-
"type": "boolean"
|
|
531
|
-
},
|
|
532
750
|
"message": {
|
|
533
751
|
"char": "m",
|
|
534
|
-
"description": "description of the changes in this version",
|
|
752
|
+
"description": "description of the changes in this version for internal use",
|
|
535
753
|
"name": "message",
|
|
536
754
|
"hasDynamicHelp": false,
|
|
537
755
|
"multiple": false,
|
|
538
756
|
"type": "option"
|
|
757
|
+
},
|
|
758
|
+
"amend": {
|
|
759
|
+
"description": "amend the description an existing version",
|
|
760
|
+
"name": "amend",
|
|
761
|
+
"allowNo": false,
|
|
762
|
+
"type": "boolean"
|
|
763
|
+
},
|
|
764
|
+
"no-git-tag": {
|
|
765
|
+
"description": "do not create a git tag for this version",
|
|
766
|
+
"name": "no-git-tag",
|
|
767
|
+
"allowNo": false,
|
|
768
|
+
"type": "boolean"
|
|
539
769
|
}
|
|
540
770
|
},
|
|
541
771
|
"hasDynamicHelp": false,
|
|
@@ -546,7 +776,6 @@
|
|
|
546
776
|
"pluginType": "core",
|
|
547
777
|
"strict": true,
|
|
548
778
|
"summary": "Increment the version of your Swell app.",
|
|
549
|
-
"enableJsonFlag": false,
|
|
550
779
|
"isESM": true,
|
|
551
780
|
"relativePath": [
|
|
552
781
|
"dist",
|
|
@@ -566,7 +795,7 @@
|
|
|
566
795
|
],
|
|
567
796
|
"flags": {
|
|
568
797
|
"app-path": {
|
|
569
|
-
"description": "path to
|
|
798
|
+
"description": "path to your app directory",
|
|
570
799
|
"name": "app-path",
|
|
571
800
|
"hasDynamicHelp": false,
|
|
572
801
|
"multiple": false,
|
|
@@ -588,7 +817,6 @@
|
|
|
588
817
|
"pluginType": "core",
|
|
589
818
|
"strict": true,
|
|
590
819
|
"summary": "Watch for changes and push app configurations.",
|
|
591
|
-
"enableJsonFlag": false,
|
|
592
820
|
"orientation": {
|
|
593
821
|
"env": "test"
|
|
594
822
|
},
|
|
@@ -609,7 +837,7 @@
|
|
|
609
837
|
"name": "id"
|
|
610
838
|
}
|
|
611
839
|
},
|
|
612
|
-
"description": "
|
|
840
|
+
"description": "Create an app.",
|
|
613
841
|
"examples": [
|
|
614
842
|
{
|
|
615
843
|
"command": "swell create app",
|
|
@@ -629,6 +857,45 @@
|
|
|
629
857
|
}
|
|
630
858
|
],
|
|
631
859
|
"flags": {
|
|
860
|
+
"yes": {
|
|
861
|
+
"char": "y",
|
|
862
|
+
"description": "accept all default values",
|
|
863
|
+
"name": "yes",
|
|
864
|
+
"allowNo": false,
|
|
865
|
+
"type": "boolean"
|
|
866
|
+
},
|
|
867
|
+
"frontend": {
|
|
868
|
+
"description": "create a starter framework for a hosted frontend",
|
|
869
|
+
"name": "frontend",
|
|
870
|
+
"hasDynamicHelp": false,
|
|
871
|
+
"multiple": false,
|
|
872
|
+
"options": [
|
|
873
|
+
"nextjs",
|
|
874
|
+
"astro"
|
|
875
|
+
],
|
|
876
|
+
"type": "option"
|
|
877
|
+
},
|
|
878
|
+
"storefront-app": {
|
|
879
|
+
"description": "id of an installed storefront app to create a theme for, if applicable",
|
|
880
|
+
"name": "storefront-app",
|
|
881
|
+
"hasDynamicHelp": false,
|
|
882
|
+
"multiple": false,
|
|
883
|
+
"type": "option"
|
|
884
|
+
},
|
|
885
|
+
"type": {
|
|
886
|
+
"char": "t",
|
|
887
|
+
"description": "create a specific app type",
|
|
888
|
+
"name": "type",
|
|
889
|
+
"hasDynamicHelp": false,
|
|
890
|
+
"multiple": false,
|
|
891
|
+
"options": [
|
|
892
|
+
"admin",
|
|
893
|
+
"integration",
|
|
894
|
+
"storefront",
|
|
895
|
+
"theme"
|
|
896
|
+
],
|
|
897
|
+
"type": "option"
|
|
898
|
+
},
|
|
632
899
|
"pkg": {
|
|
633
900
|
"char": "p",
|
|
634
901
|
"description": "use npm or yarn to install default dependencies, or none to disable",
|
|
@@ -642,13 +909,6 @@
|
|
|
642
909
|
"none"
|
|
643
910
|
],
|
|
644
911
|
"type": "option"
|
|
645
|
-
},
|
|
646
|
-
"yes": {
|
|
647
|
-
"char": "y",
|
|
648
|
-
"description": "accept all default values",
|
|
649
|
-
"name": "yes",
|
|
650
|
-
"allowNo": false,
|
|
651
|
-
"type": "boolean"
|
|
652
912
|
}
|
|
653
913
|
},
|
|
654
914
|
"hasDynamicHelp": false,
|
|
@@ -697,21 +957,12 @@
|
|
|
697
957
|
],
|
|
698
958
|
"flags": {
|
|
699
959
|
"app-path": {
|
|
700
|
-
"description": "path to
|
|
960
|
+
"description": "path to your app directory",
|
|
701
961
|
"name": "app-path",
|
|
702
962
|
"hasDynamicHelp": false,
|
|
703
963
|
"multiple": false,
|
|
704
964
|
"type": "option"
|
|
705
965
|
},
|
|
706
|
-
"label": {
|
|
707
|
-
"char": "l",
|
|
708
|
-
"description": "content model label",
|
|
709
|
-
"name": "label",
|
|
710
|
-
"default": "",
|
|
711
|
-
"hasDynamicHelp": false,
|
|
712
|
-
"multiple": false,
|
|
713
|
-
"type": "option"
|
|
714
|
-
},
|
|
715
966
|
"description": {
|
|
716
967
|
"char": "d",
|
|
717
968
|
"description": "content model description",
|
|
@@ -730,10 +981,10 @@
|
|
|
730
981
|
"multiple": false,
|
|
731
982
|
"type": "option"
|
|
732
983
|
},
|
|
733
|
-
"
|
|
734
|
-
"char": "
|
|
735
|
-
"description": "
|
|
736
|
-
"name": "
|
|
984
|
+
"label": {
|
|
985
|
+
"char": "l",
|
|
986
|
+
"description": "content model label",
|
|
987
|
+
"name": "label",
|
|
737
988
|
"default": "",
|
|
738
989
|
"hasDynamicHelp": false,
|
|
739
990
|
"multiple": false,
|
|
@@ -744,6 +995,15 @@
|
|
|
744
995
|
"name": "overwrite",
|
|
745
996
|
"allowNo": false,
|
|
746
997
|
"type": "boolean"
|
|
998
|
+
},
|
|
999
|
+
"views": {
|
|
1000
|
+
"char": "v",
|
|
1001
|
+
"description": "list of content model views delimited by commas, i.e. list,edit,new",
|
|
1002
|
+
"name": "views",
|
|
1003
|
+
"default": "",
|
|
1004
|
+
"hasDynamicHelp": false,
|
|
1005
|
+
"multiple": false,
|
|
1006
|
+
"type": "option"
|
|
747
1007
|
}
|
|
748
1008
|
},
|
|
749
1009
|
"hasDynamicHelp": false,
|
|
@@ -761,6 +1021,77 @@
|
|
|
761
1021
|
"content.js"
|
|
762
1022
|
]
|
|
763
1023
|
},
|
|
1024
|
+
"create:frontend": {
|
|
1025
|
+
"aliases": [],
|
|
1026
|
+
"args": {},
|
|
1027
|
+
"description": "Initialize a frontend app framework and folder structure.",
|
|
1028
|
+
"examples": [
|
|
1029
|
+
{
|
|
1030
|
+
"command": "swell create frontend",
|
|
1031
|
+
"description": "Create frontend app following command prompts."
|
|
1032
|
+
},
|
|
1033
|
+
{
|
|
1034
|
+
"command": "swell create frontend -y",
|
|
1035
|
+
"description": "Create frontend app and accept all default values."
|
|
1036
|
+
}
|
|
1037
|
+
],
|
|
1038
|
+
"flags": {
|
|
1039
|
+
"yes": {
|
|
1040
|
+
"char": "y",
|
|
1041
|
+
"description": "accept all default values",
|
|
1042
|
+
"name": "yes",
|
|
1043
|
+
"allowNo": false,
|
|
1044
|
+
"type": "boolean"
|
|
1045
|
+
},
|
|
1046
|
+
"frontend": {
|
|
1047
|
+
"description": "create a starter framework for a hosted frontend",
|
|
1048
|
+
"name": "frontend",
|
|
1049
|
+
"hasDynamicHelp": false,
|
|
1050
|
+
"multiple": false,
|
|
1051
|
+
"options": [
|
|
1052
|
+
"nextjs",
|
|
1053
|
+
"astro"
|
|
1054
|
+
],
|
|
1055
|
+
"type": "option"
|
|
1056
|
+
},
|
|
1057
|
+
"storefront-app": {
|
|
1058
|
+
"description": "id of an installed storefront app to create a theme for, if applicable",
|
|
1059
|
+
"name": "storefront-app",
|
|
1060
|
+
"hasDynamicHelp": false,
|
|
1061
|
+
"multiple": false,
|
|
1062
|
+
"type": "option"
|
|
1063
|
+
},
|
|
1064
|
+
"pkg": {
|
|
1065
|
+
"char": "p",
|
|
1066
|
+
"description": "use npm or yarn to install default dependencies, or none to disable",
|
|
1067
|
+
"name": "pkg",
|
|
1068
|
+
"default": "npm",
|
|
1069
|
+
"hasDynamicHelp": false,
|
|
1070
|
+
"multiple": false,
|
|
1071
|
+
"options": [
|
|
1072
|
+
"npm",
|
|
1073
|
+
"yarn",
|
|
1074
|
+
"none"
|
|
1075
|
+
],
|
|
1076
|
+
"type": "option"
|
|
1077
|
+
}
|
|
1078
|
+
},
|
|
1079
|
+
"hasDynamicHelp": false,
|
|
1080
|
+
"hiddenAliases": [],
|
|
1081
|
+
"id": "create:frontend",
|
|
1082
|
+
"pluginAlias": "@swell/cli",
|
|
1083
|
+
"pluginName": "@swell/cli",
|
|
1084
|
+
"pluginType": "core",
|
|
1085
|
+
"strict": true,
|
|
1086
|
+
"enableJsonFlag": false,
|
|
1087
|
+
"isESM": true,
|
|
1088
|
+
"relativePath": [
|
|
1089
|
+
"dist",
|
|
1090
|
+
"commands",
|
|
1091
|
+
"create",
|
|
1092
|
+
"frontend.js"
|
|
1093
|
+
]
|
|
1094
|
+
},
|
|
764
1095
|
"create:function": {
|
|
765
1096
|
"aliases": [],
|
|
766
1097
|
"args": {
|
|
@@ -799,7 +1130,7 @@
|
|
|
799
1130
|
],
|
|
800
1131
|
"flags": {
|
|
801
1132
|
"app-path": {
|
|
802
|
-
"description": "path to
|
|
1133
|
+
"description": "path to your app directory",
|
|
803
1134
|
"name": "app-path",
|
|
804
1135
|
"hasDynamicHelp": false,
|
|
805
1136
|
"multiple": false,
|
|
@@ -823,6 +1154,12 @@
|
|
|
823
1154
|
"multiple": false,
|
|
824
1155
|
"type": "option"
|
|
825
1156
|
},
|
|
1157
|
+
"overwrite": {
|
|
1158
|
+
"description": "overwrite existing function file",
|
|
1159
|
+
"name": "overwrite",
|
|
1160
|
+
"allowNo": false,
|
|
1161
|
+
"type": "boolean"
|
|
1162
|
+
},
|
|
826
1163
|
"route": {
|
|
827
1164
|
"char": "r",
|
|
828
1165
|
"description": "access type used with route trigger",
|
|
@@ -844,12 +1181,6 @@
|
|
|
844
1181
|
"hasDynamicHelp": false,
|
|
845
1182
|
"multiple": false,
|
|
846
1183
|
"type": "option"
|
|
847
|
-
},
|
|
848
|
-
"overwrite": {
|
|
849
|
-
"description": "overwrite existing function file",
|
|
850
|
-
"name": "overwrite",
|
|
851
|
-
"allowNo": false,
|
|
852
|
-
"type": "boolean"
|
|
853
1184
|
}
|
|
854
1185
|
},
|
|
855
1186
|
"hasDynamicHelp": false,
|
|
@@ -922,21 +1253,12 @@
|
|
|
922
1253
|
],
|
|
923
1254
|
"flags": {
|
|
924
1255
|
"app-path": {
|
|
925
|
-
"description": "path to
|
|
1256
|
+
"description": "path to your app directory",
|
|
926
1257
|
"name": "app-path",
|
|
927
1258
|
"hasDynamicHelp": false,
|
|
928
1259
|
"multiple": false,
|
|
929
1260
|
"type": "option"
|
|
930
1261
|
},
|
|
931
|
-
"label": {
|
|
932
|
-
"char": "l",
|
|
933
|
-
"description": "data model label, i.e. Products",
|
|
934
|
-
"name": "label",
|
|
935
|
-
"default": "",
|
|
936
|
-
"hasDynamicHelp": false,
|
|
937
|
-
"multiple": false,
|
|
938
|
-
"type": "option"
|
|
939
|
-
},
|
|
940
1262
|
"description": {
|
|
941
1263
|
"char": "d",
|
|
942
1264
|
"description": "data model description",
|
|
@@ -946,6 +1268,15 @@
|
|
|
946
1268
|
"multiple": false,
|
|
947
1269
|
"type": "option"
|
|
948
1270
|
},
|
|
1271
|
+
"events": {
|
|
1272
|
+
"char": "e",
|
|
1273
|
+
"description": "list of data model events delimited by commas",
|
|
1274
|
+
"name": "events",
|
|
1275
|
+
"default": "created,updated,deleted",
|
|
1276
|
+
"hasDynamicHelp": false,
|
|
1277
|
+
"multiple": false,
|
|
1278
|
+
"type": "option"
|
|
1279
|
+
},
|
|
949
1280
|
"fields": {
|
|
950
1281
|
"char": "f",
|
|
951
1282
|
"description": "list of data model fields delimited by commas",
|
|
@@ -955,11 +1286,11 @@
|
|
|
955
1286
|
"multiple": false,
|
|
956
1287
|
"type": "option"
|
|
957
1288
|
},
|
|
958
|
-
"
|
|
959
|
-
"char": "
|
|
960
|
-
"description": "
|
|
961
|
-
"name": "
|
|
962
|
-
"default": "
|
|
1289
|
+
"label": {
|
|
1290
|
+
"char": "l",
|
|
1291
|
+
"description": "data model label, i.e. Products",
|
|
1292
|
+
"name": "label",
|
|
1293
|
+
"default": "",
|
|
963
1294
|
"hasDynamicHelp": false,
|
|
964
1295
|
"multiple": false,
|
|
965
1296
|
"type": "option"
|
|
@@ -1015,12 +1346,19 @@
|
|
|
1015
1346
|
],
|
|
1016
1347
|
"flags": {
|
|
1017
1348
|
"app-path": {
|
|
1018
|
-
"description": "path to
|
|
1349
|
+
"description": "path to your app directory",
|
|
1019
1350
|
"name": "app-path",
|
|
1020
1351
|
"hasDynamicHelp": false,
|
|
1021
1352
|
"multiple": false,
|
|
1022
1353
|
"type": "option"
|
|
1023
1354
|
},
|
|
1355
|
+
"admin": {
|
|
1356
|
+
"char": "a",
|
|
1357
|
+
"description": "indicate when the notification is sent to store admins only",
|
|
1358
|
+
"name": "admin",
|
|
1359
|
+
"allowNo": false,
|
|
1360
|
+
"type": "boolean"
|
|
1361
|
+
},
|
|
1024
1362
|
"description": {
|
|
1025
1363
|
"char": "d",
|
|
1026
1364
|
"description": "notification description",
|
|
@@ -1030,15 +1368,6 @@
|
|
|
1030
1368
|
"multiple": false,
|
|
1031
1369
|
"type": "option"
|
|
1032
1370
|
},
|
|
1033
|
-
"subject": {
|
|
1034
|
-
"char": "s",
|
|
1035
|
-
"description": "notification email subject",
|
|
1036
|
-
"name": "subject",
|
|
1037
|
-
"default": "",
|
|
1038
|
-
"hasDynamicHelp": false,
|
|
1039
|
-
"multiple": false,
|
|
1040
|
-
"type": "option"
|
|
1041
|
-
},
|
|
1042
1371
|
"event": {
|
|
1043
1372
|
"char": "e",
|
|
1044
1373
|
"description": "data model event to trigger the notification event, i.e. created",
|
|
@@ -1048,13 +1377,6 @@
|
|
|
1048
1377
|
"multiple": false,
|
|
1049
1378
|
"type": "option"
|
|
1050
1379
|
},
|
|
1051
|
-
"admin": {
|
|
1052
|
-
"char": "a",
|
|
1053
|
-
"description": "indicate when the notification is sent to store admins only",
|
|
1054
|
-
"name": "admin",
|
|
1055
|
-
"allowNo": false,
|
|
1056
|
-
"type": "boolean"
|
|
1057
|
-
},
|
|
1058
1380
|
"once": {
|
|
1059
1381
|
"char": "o",
|
|
1060
1382
|
"description": "indicate the notification should be sent only once when conditions are met, instead of repeating",
|
|
@@ -1067,6 +1389,15 @@
|
|
|
1067
1389
|
"name": "overwrite",
|
|
1068
1390
|
"allowNo": false,
|
|
1069
1391
|
"type": "boolean"
|
|
1392
|
+
},
|
|
1393
|
+
"subject": {
|
|
1394
|
+
"char": "s",
|
|
1395
|
+
"description": "notification email subject",
|
|
1396
|
+
"name": "subject",
|
|
1397
|
+
"default": "",
|
|
1398
|
+
"hasDynamicHelp": false,
|
|
1399
|
+
"multiple": false,
|
|
1400
|
+
"type": "option"
|
|
1070
1401
|
}
|
|
1071
1402
|
},
|
|
1072
1403
|
"hasDynamicHelp": false,
|
|
@@ -1084,7 +1415,392 @@
|
|
|
1084
1415
|
"create",
|
|
1085
1416
|
"notification.js"
|
|
1086
1417
|
]
|
|
1418
|
+
},
|
|
1419
|
+
"theme:dev": {
|
|
1420
|
+
"aliases": [],
|
|
1421
|
+
"args": {},
|
|
1422
|
+
"examples": [
|
|
1423
|
+
"swell theme dev",
|
|
1424
|
+
"swell theme dev --local",
|
|
1425
|
+
"swell theme dev --bundle",
|
|
1426
|
+
"swell theme dev --storefront-select",
|
|
1427
|
+
"swell theme dev --storefront-id <id>"
|
|
1428
|
+
],
|
|
1429
|
+
"flags": {
|
|
1430
|
+
"app-path": {
|
|
1431
|
+
"description": "path to your app directory",
|
|
1432
|
+
"name": "app-path",
|
|
1433
|
+
"hasDynamicHelp": false,
|
|
1434
|
+
"multiple": false,
|
|
1435
|
+
"type": "option"
|
|
1436
|
+
},
|
|
1437
|
+
"storefront-id": {
|
|
1438
|
+
"description": "identify a storefront to preview and push theme files to",
|
|
1439
|
+
"name": "storefront-id",
|
|
1440
|
+
"hasDynamicHelp": false,
|
|
1441
|
+
"multiple": false,
|
|
1442
|
+
"type": "option"
|
|
1443
|
+
},
|
|
1444
|
+
"storefront-select": {
|
|
1445
|
+
"description": "prompt to select a storefront to preview and push theme files to",
|
|
1446
|
+
"name": "storefront-select",
|
|
1447
|
+
"allowNo": false,
|
|
1448
|
+
"type": "boolean"
|
|
1449
|
+
},
|
|
1450
|
+
"local": {
|
|
1451
|
+
"description": "connect to a running local storefront app dev server",
|
|
1452
|
+
"name": "local",
|
|
1453
|
+
"allowNo": false,
|
|
1454
|
+
"type": "boolean"
|
|
1455
|
+
},
|
|
1456
|
+
"bundle": {
|
|
1457
|
+
"description": "bundle assets",
|
|
1458
|
+
"name": "bundle",
|
|
1459
|
+
"allowNo": false,
|
|
1460
|
+
"type": "boolean"
|
|
1461
|
+
},
|
|
1462
|
+
"no-push": {
|
|
1463
|
+
"description": "skip pushing theme files initially",
|
|
1464
|
+
"name": "no-push",
|
|
1465
|
+
"allowNo": false,
|
|
1466
|
+
"type": "boolean"
|
|
1467
|
+
}
|
|
1468
|
+
},
|
|
1469
|
+
"hasDynamicHelp": false,
|
|
1470
|
+
"hiddenAliases": [],
|
|
1471
|
+
"id": "theme:dev",
|
|
1472
|
+
"pluginAlias": "@swell/cli",
|
|
1473
|
+
"pluginName": "@swell/cli",
|
|
1474
|
+
"pluginType": "core",
|
|
1475
|
+
"strict": true,
|
|
1476
|
+
"summary": "Run a theme in dev mode from your local machine.",
|
|
1477
|
+
"orientation": {
|
|
1478
|
+
"env": "test"
|
|
1479
|
+
},
|
|
1480
|
+
"isESM": true,
|
|
1481
|
+
"relativePath": [
|
|
1482
|
+
"dist",
|
|
1483
|
+
"commands",
|
|
1484
|
+
"theme",
|
|
1485
|
+
"dev.js"
|
|
1486
|
+
]
|
|
1487
|
+
},
|
|
1488
|
+
"theme:init": {
|
|
1489
|
+
"aliases": [],
|
|
1490
|
+
"args": {
|
|
1491
|
+
"id": {
|
|
1492
|
+
"default": "",
|
|
1493
|
+
"description": "id of the app to create",
|
|
1494
|
+
"name": "id"
|
|
1495
|
+
}
|
|
1496
|
+
},
|
|
1497
|
+
"description": "Initialize theme swell.json in the current directory.",
|
|
1498
|
+
"examples": [
|
|
1499
|
+
{
|
|
1500
|
+
"command": "swell theme init",
|
|
1501
|
+
"description": "Initialize theme following command prompts."
|
|
1502
|
+
},
|
|
1503
|
+
{
|
|
1504
|
+
"command": "swell theme init -y",
|
|
1505
|
+
"description": "Initialize theme and accept all default values."
|
|
1506
|
+
}
|
|
1507
|
+
],
|
|
1508
|
+
"flags": {
|
|
1509
|
+
"yes": {
|
|
1510
|
+
"char": "y",
|
|
1511
|
+
"description": "accept all default values",
|
|
1512
|
+
"name": "yes",
|
|
1513
|
+
"allowNo": false,
|
|
1514
|
+
"type": "boolean"
|
|
1515
|
+
},
|
|
1516
|
+
"frontend": {
|
|
1517
|
+
"description": "create a starter framework for a hosted frontend",
|
|
1518
|
+
"name": "frontend",
|
|
1519
|
+
"hasDynamicHelp": false,
|
|
1520
|
+
"multiple": false,
|
|
1521
|
+
"options": [
|
|
1522
|
+
"nextjs",
|
|
1523
|
+
"astro"
|
|
1524
|
+
],
|
|
1525
|
+
"type": "option"
|
|
1526
|
+
},
|
|
1527
|
+
"storefront-app": {
|
|
1528
|
+
"description": "id of an installed storefront app to create a theme for, if applicable",
|
|
1529
|
+
"name": "storefront-app",
|
|
1530
|
+
"hasDynamicHelp": false,
|
|
1531
|
+
"multiple": false,
|
|
1532
|
+
"type": "option"
|
|
1533
|
+
}
|
|
1534
|
+
},
|
|
1535
|
+
"hasDynamicHelp": false,
|
|
1536
|
+
"hiddenAliases": [],
|
|
1537
|
+
"id": "theme:init",
|
|
1538
|
+
"pluginAlias": "@swell/cli",
|
|
1539
|
+
"pluginName": "@swell/cli",
|
|
1540
|
+
"pluginType": "core",
|
|
1541
|
+
"strict": true,
|
|
1542
|
+
"enableJsonFlag": false,
|
|
1543
|
+
"isESM": true,
|
|
1544
|
+
"relativePath": [
|
|
1545
|
+
"dist",
|
|
1546
|
+
"commands",
|
|
1547
|
+
"theme",
|
|
1548
|
+
"init.js"
|
|
1549
|
+
]
|
|
1550
|
+
},
|
|
1551
|
+
"theme:pull": {
|
|
1552
|
+
"aliases": [],
|
|
1553
|
+
"args": {
|
|
1554
|
+
"appId": {
|
|
1555
|
+
"default": "",
|
|
1556
|
+
"description": "theme app id to pull",
|
|
1557
|
+
"name": "appId"
|
|
1558
|
+
},
|
|
1559
|
+
"targetPath": {
|
|
1560
|
+
"default": "",
|
|
1561
|
+
"description": "path to download theme files into",
|
|
1562
|
+
"name": "targetPath"
|
|
1563
|
+
}
|
|
1564
|
+
},
|
|
1565
|
+
"description": "Pull all theme files, a specific file, or a specific configuration\ntype from a theme in your store's test environment to your local machine.\n\nIf APPID is not specified, you will be prompted with a list of themes to choose from.\n\nTheme file directories:\nassets/\ntheme/",
|
|
1566
|
+
"examples": [
|
|
1567
|
+
"swell theme pull",
|
|
1568
|
+
"swell theme pull mytheme",
|
|
1569
|
+
"swell theme pull mytheme mytheme-folder",
|
|
1570
|
+
"swell theme pull --force",
|
|
1571
|
+
"swell theme pull --storefront-select",
|
|
1572
|
+
"swell theme pull --storefront-id <id>"
|
|
1573
|
+
],
|
|
1574
|
+
"flags": {
|
|
1575
|
+
"force": {
|
|
1576
|
+
"description": "force pull all theme files",
|
|
1577
|
+
"name": "force",
|
|
1578
|
+
"allowNo": false,
|
|
1579
|
+
"type": "boolean"
|
|
1580
|
+
},
|
|
1581
|
+
"sync-app": {
|
|
1582
|
+
"description": "pull app files in addition to theme files to",
|
|
1583
|
+
"name": "sync-app",
|
|
1584
|
+
"allowNo": false,
|
|
1585
|
+
"type": "boolean"
|
|
1586
|
+
},
|
|
1587
|
+
"storefront-select": {
|
|
1588
|
+
"description": "prompt to select a storefront to pull theme files to",
|
|
1589
|
+
"name": "storefront-select",
|
|
1590
|
+
"allowNo": false,
|
|
1591
|
+
"type": "boolean"
|
|
1592
|
+
},
|
|
1593
|
+
"storefront-id": {
|
|
1594
|
+
"description": "identify a storefront to pull theme files from",
|
|
1595
|
+
"name": "storefront-id",
|
|
1596
|
+
"hasDynamicHelp": false,
|
|
1597
|
+
"multiple": false,
|
|
1598
|
+
"type": "option"
|
|
1599
|
+
}
|
|
1600
|
+
},
|
|
1601
|
+
"hasDynamicHelp": false,
|
|
1602
|
+
"hiddenAliases": [],
|
|
1603
|
+
"id": "theme:pull",
|
|
1604
|
+
"pluginAlias": "@swell/cli",
|
|
1605
|
+
"pluginName": "@swell/cli",
|
|
1606
|
+
"pluginType": "core",
|
|
1607
|
+
"summary": "Pull theme files from Swell to your local machine.",
|
|
1608
|
+
"isESM": true,
|
|
1609
|
+
"relativePath": [
|
|
1610
|
+
"dist",
|
|
1611
|
+
"commands",
|
|
1612
|
+
"theme",
|
|
1613
|
+
"pull.js"
|
|
1614
|
+
],
|
|
1615
|
+
"orientation": {},
|
|
1616
|
+
"delayOrientation": true
|
|
1617
|
+
},
|
|
1618
|
+
"theme:push": {
|
|
1619
|
+
"aliases": [],
|
|
1620
|
+
"args": {
|
|
1621
|
+
"file": {
|
|
1622
|
+
"description": "relative path to a configuration file or directory to push",
|
|
1623
|
+
"name": "file"
|
|
1624
|
+
}
|
|
1625
|
+
},
|
|
1626
|
+
"description": "Push all theme files, a specific file, or a specific configuration\ntype to an theme in your store's test environment.\n\nIf the theme does not exist, it will be created and its global ID saved to a .swellrc file.\n\n- If no file is specified, all configuration files will be pushed to the store.\n This includes the theme icon (assets/icon.png) and swell.json.\n- If a file is specified, only that file will be pushed to the store.\n- If a directory is specified, only files in that directory will be pushed.\n\nTheme file directories:\nassets/\ntheme/",
|
|
1627
|
+
"examples": [
|
|
1628
|
+
"swell theme push",
|
|
1629
|
+
"swell theme push assets",
|
|
1630
|
+
"swell theme push theme/sections",
|
|
1631
|
+
"swell theme push --sync-app",
|
|
1632
|
+
"swell theme push --force",
|
|
1633
|
+
"swell theme push --storefront-select",
|
|
1634
|
+
"swell theme push --storefront-id <id>"
|
|
1635
|
+
],
|
|
1636
|
+
"flags": {
|
|
1637
|
+
"force": {
|
|
1638
|
+
"description": "force push all files",
|
|
1639
|
+
"name": "force",
|
|
1640
|
+
"allowNo": false,
|
|
1641
|
+
"type": "boolean"
|
|
1642
|
+
},
|
|
1643
|
+
"sync-app": {
|
|
1644
|
+
"description": "push app files in addition to theme files",
|
|
1645
|
+
"name": "sync-app",
|
|
1646
|
+
"allowNo": false,
|
|
1647
|
+
"type": "boolean"
|
|
1648
|
+
},
|
|
1649
|
+
"storefront-select": {
|
|
1650
|
+
"description": "prompt to select a storefront to push theme files to",
|
|
1651
|
+
"name": "storefront-select",
|
|
1652
|
+
"allowNo": false,
|
|
1653
|
+
"type": "boolean"
|
|
1654
|
+
},
|
|
1655
|
+
"storefront-id": {
|
|
1656
|
+
"description": "identify a storefront to push theme files to",
|
|
1657
|
+
"name": "storefront-id",
|
|
1658
|
+
"hasDynamicHelp": false,
|
|
1659
|
+
"multiple": false,
|
|
1660
|
+
"type": "option"
|
|
1661
|
+
}
|
|
1662
|
+
},
|
|
1663
|
+
"hasDynamicHelp": false,
|
|
1664
|
+
"hiddenAliases": [],
|
|
1665
|
+
"id": "theme:push",
|
|
1666
|
+
"pluginAlias": "@swell/cli",
|
|
1667
|
+
"pluginName": "@swell/cli",
|
|
1668
|
+
"pluginType": "core",
|
|
1669
|
+
"summary": "Push local files to your Swell theme.",
|
|
1670
|
+
"orientation": {},
|
|
1671
|
+
"delayOrientation": true,
|
|
1672
|
+
"isESM": true,
|
|
1673
|
+
"relativePath": [
|
|
1674
|
+
"dist",
|
|
1675
|
+
"commands",
|
|
1676
|
+
"theme",
|
|
1677
|
+
"push.js"
|
|
1678
|
+
]
|
|
1679
|
+
},
|
|
1680
|
+
"app:frontend:deploy": {
|
|
1681
|
+
"aliases": [],
|
|
1682
|
+
"args": {},
|
|
1683
|
+
"description": "Creates a new build using the relevant command depending on your frontend framework.\nOnce the build succeeds, this command will invoke Cloudflare Wrangler to upload\nbuild assets using your own Cloudflare account. Once complete, Swell will update\nthe app's deployment URL and push the updated frontend files.",
|
|
1684
|
+
"examples": [
|
|
1685
|
+
"swell app frontend deploy",
|
|
1686
|
+
"swell app frontend deploy --force",
|
|
1687
|
+
"swell app frontend deploy --storefront-select",
|
|
1688
|
+
"swell app frontend deploy --storefront-id <id>"
|
|
1689
|
+
],
|
|
1690
|
+
"flags": {
|
|
1691
|
+
"app-path": {
|
|
1692
|
+
"description": "path to your app directory",
|
|
1693
|
+
"name": "app-path",
|
|
1694
|
+
"hasDynamicHelp": false,
|
|
1695
|
+
"multiple": false,
|
|
1696
|
+
"type": "option"
|
|
1697
|
+
},
|
|
1698
|
+
"force": {
|
|
1699
|
+
"description": "force push and build all frontend files",
|
|
1700
|
+
"name": "force",
|
|
1701
|
+
"allowNo": false,
|
|
1702
|
+
"type": "boolean"
|
|
1703
|
+
},
|
|
1704
|
+
"storefront-id": {
|
|
1705
|
+
"description": "identify a storefront to preview deployment with",
|
|
1706
|
+
"name": "storefront-id",
|
|
1707
|
+
"hasDynamicHelp": false,
|
|
1708
|
+
"multiple": false,
|
|
1709
|
+
"type": "option"
|
|
1710
|
+
},
|
|
1711
|
+
"storefront-select": {
|
|
1712
|
+
"description": "prompt to select a storefront to preview deployment with",
|
|
1713
|
+
"name": "storefront-select",
|
|
1714
|
+
"allowNo": false,
|
|
1715
|
+
"type": "boolean"
|
|
1716
|
+
}
|
|
1717
|
+
},
|
|
1718
|
+
"hasDynamicHelp": false,
|
|
1719
|
+
"hiddenAliases": [],
|
|
1720
|
+
"id": "app:frontend:deploy",
|
|
1721
|
+
"pluginAlias": "@swell/cli",
|
|
1722
|
+
"pluginName": "@swell/cli",
|
|
1723
|
+
"pluginType": "core",
|
|
1724
|
+
"strict": true,
|
|
1725
|
+
"summary": "Push frontend files to your Swell app.",
|
|
1726
|
+
"orientation": {
|
|
1727
|
+
"env": "test"
|
|
1728
|
+
},
|
|
1729
|
+
"isESM": true,
|
|
1730
|
+
"relativePath": [
|
|
1731
|
+
"dist",
|
|
1732
|
+
"commands",
|
|
1733
|
+
"app",
|
|
1734
|
+
"frontend",
|
|
1735
|
+
"deploy.js"
|
|
1736
|
+
]
|
|
1737
|
+
},
|
|
1738
|
+
"app:frontend:dev": {
|
|
1739
|
+
"aliases": [],
|
|
1740
|
+
"args": {},
|
|
1741
|
+
"examples": [
|
|
1742
|
+
"swell app frontend dev",
|
|
1743
|
+
"swell app frontend dev --no-push",
|
|
1744
|
+
"swell app frontend dev --port 3000",
|
|
1745
|
+
"swell app frontend dev --storefront-select",
|
|
1746
|
+
"swell app frontend dev --storefront-id <id>"
|
|
1747
|
+
],
|
|
1748
|
+
"flags": {
|
|
1749
|
+
"app-path": {
|
|
1750
|
+
"description": "path to your app directory",
|
|
1751
|
+
"name": "app-path",
|
|
1752
|
+
"hasDynamicHelp": false,
|
|
1753
|
+
"multiple": false,
|
|
1754
|
+
"type": "option"
|
|
1755
|
+
},
|
|
1756
|
+
"port": {
|
|
1757
|
+
"char": "p",
|
|
1758
|
+
"description": "override the default port to run the app locally",
|
|
1759
|
+
"name": "port",
|
|
1760
|
+
"hasDynamicHelp": false,
|
|
1761
|
+
"multiple": false,
|
|
1762
|
+
"type": "option"
|
|
1763
|
+
},
|
|
1764
|
+
"no-push": {
|
|
1765
|
+
"description": "skip pushing app files initially",
|
|
1766
|
+
"name": "no-push",
|
|
1767
|
+
"allowNo": false,
|
|
1768
|
+
"type": "boolean"
|
|
1769
|
+
},
|
|
1770
|
+
"storefront-id": {
|
|
1771
|
+
"description": "identify a storefront to preview with and push theme files to",
|
|
1772
|
+
"name": "storefront-id",
|
|
1773
|
+
"hasDynamicHelp": false,
|
|
1774
|
+
"multiple": false,
|
|
1775
|
+
"type": "option"
|
|
1776
|
+
},
|
|
1777
|
+
"storefront-select": {
|
|
1778
|
+
"description": "prompt to select a storefront to preview with",
|
|
1779
|
+
"name": "storefront-select",
|
|
1780
|
+
"allowNo": false,
|
|
1781
|
+
"type": "boolean"
|
|
1782
|
+
}
|
|
1783
|
+
},
|
|
1784
|
+
"hasDynamicHelp": false,
|
|
1785
|
+
"hiddenAliases": [],
|
|
1786
|
+
"id": "app:frontend:dev",
|
|
1787
|
+
"pluginAlias": "@swell/cli",
|
|
1788
|
+
"pluginName": "@swell/cli",
|
|
1789
|
+
"pluginType": "core",
|
|
1790
|
+
"strict": true,
|
|
1791
|
+
"summary": "Run a frontend app in dev mode from your local machine.",
|
|
1792
|
+
"orientation": {
|
|
1793
|
+
"env": "test"
|
|
1794
|
+
},
|
|
1795
|
+
"isESM": true,
|
|
1796
|
+
"relativePath": [
|
|
1797
|
+
"dist",
|
|
1798
|
+
"commands",
|
|
1799
|
+
"app",
|
|
1800
|
+
"frontend",
|
|
1801
|
+
"dev.js"
|
|
1802
|
+
]
|
|
1087
1803
|
}
|
|
1088
1804
|
},
|
|
1089
|
-
"version": "2.0.1-alpha.
|
|
1805
|
+
"version": "2.0.1-alpha.17"
|
|
1090
1806
|
}
|