@salesforce/plugin-deploy-retrieve 3.7.10 → 3.8.1

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.
@@ -149,6 +149,96 @@
149
149
  "mdapi:convert:project"
150
150
  ]
151
151
  },
152
+ "project:convert:source-behavior": {
153
+ "aliases": [],
154
+ "args": {},
155
+ "description": "Specifically, this command updates the \"sourceBehaviorOption\" option in the \"sfdx-project.json\" file and then converts the associated local source files in your project as needed.\n\nFor example, run this command with the \"--behavior decomposePermissionSetBeta\" flag to start decomposing permission sets when you deploy or retrieve them. Decomposing means breaking up the monolithic metadata API format XML file that corresponds to a metadata component into smaller XML files and directories based on its subtypes. Permission sets are not decomposed by default; you must opt-in to start decomposing them by using this command. When the command finishes, your \"sfdx-project.json\" file is updated to always decompose permission sets, and the existing permission set files in your local package directories are converted into the new decomposed format. You run this command only once for a given behavior change.\n\nFor more information about the possible values for the --behavior flag, see the \"sourceBehaviorOptions\" section in the https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_ws_config.htm topic.",
156
+ "examples": [
157
+ "Update your Salesforce DX project to decompose custom labels:\n<%= config.bin %> <%= command.id %> --behavior decomposeCustomLabelsBeta",
158
+ "Display what the command would do, but don't change any existing files:\n<%= config.bin %> <%= command.id %> --behavior decomposeCustomLabelsBeta --dry-run",
159
+ "Keep the temporary directory that contains the interim metadata API formatted files:\n<%= config.bin %> <%= command.id %> --behavior decomposeCustomLabelsBeta --dry-run --preserve-temp-dir"
160
+ ],
161
+ "flags": {
162
+ "json": {
163
+ "description": "Format output as json.",
164
+ "helpGroup": "GLOBAL",
165
+ "name": "json",
166
+ "allowNo": false,
167
+ "type": "boolean"
168
+ },
169
+ "flags-dir": {
170
+ "helpGroup": "GLOBAL",
171
+ "name": "flags-dir",
172
+ "summary": "Import flag values from a directory.",
173
+ "hasDynamicHelp": false,
174
+ "multiple": false,
175
+ "type": "option"
176
+ },
177
+ "behavior": {
178
+ "char": "b",
179
+ "name": "behavior",
180
+ "required": true,
181
+ "summary": "Behavior to enable; the values correspond to the possible values of the \"sourceBehaviorOption\" option in the \"sfdx-project.json\" file.",
182
+ "hasDynamicHelp": false,
183
+ "multiple": false,
184
+ "options": [
185
+ "decomposeCustomLabelsBeta",
186
+ "decomposePermissionSetBeta",
187
+ "decomposeSharingRulesBeta",
188
+ "decomposeWorkflowBeta"
189
+ ],
190
+ "type": "option"
191
+ },
192
+ "dry-run": {
193
+ "name": "dry-run",
194
+ "summary": "Display what the command would do, but don't make any actual changes.",
195
+ "allowNo": false,
196
+ "type": "boolean"
197
+ },
198
+ "preserve-temp-dir": {
199
+ "name": "preserve-temp-dir",
200
+ "summary": "Don't delete the metadata API format temporary directory that this command creates. Useful for debugging.",
201
+ "allowNo": false,
202
+ "type": "boolean"
203
+ },
204
+ "target-org": {
205
+ "char": "o",
206
+ "name": "target-org",
207
+ "noCacheDefault": true,
208
+ "hasDynamicHelp": true,
209
+ "multiple": false,
210
+ "type": "option"
211
+ }
212
+ },
213
+ "hasDynamicHelp": true,
214
+ "hiddenAliases": [],
215
+ "id": "project:convert:source-behavior",
216
+ "pluginAlias": "@salesforce/plugin-deploy-retrieve",
217
+ "pluginName": "@salesforce/plugin-deploy-retrieve",
218
+ "pluginType": "core",
219
+ "state": "beta",
220
+ "strict": true,
221
+ "summary": "Enable a behavior of your project source files, and then update your Salesforce DX project to implement the behavior.",
222
+ "enableJsonFlag": true,
223
+ "requiresProject": true,
224
+ "isESM": true,
225
+ "relativePath": [
226
+ "lib",
227
+ "commands",
228
+ "project",
229
+ "convert",
230
+ "source-behavior.js"
231
+ ],
232
+ "aliasPermutations": [],
233
+ "permutations": [
234
+ "project:convert:source-behavior",
235
+ "convert:project:source-behavior",
236
+ "convert:source-behavior:project",
237
+ "project:source-behavior:convert",
238
+ "source-behavior:project:convert",
239
+ "source-behavior:convert:project"
240
+ ]
241
+ },
152
242
  "project:convert:source": {
153
243
  "aliases": [
154
244
  "force:source:convert"
@@ -218,7 +308,7 @@
218
308
  "deprecateAliases": true,
219
309
  "name": "output-dir",
220
310
  "summary": "Output directory to store the Metadata API–formatted files in.",
221
- "default": "metadataPackage_1716916525319",
311
+ "default": "metadataPackage_1717025566411",
222
312
  "hasDynamicHelp": false,
223
313
  "multiple": false,
224
314
  "type": "option"
@@ -311,16 +401,18 @@
311
401
  "source:convert:project"
312
402
  ]
313
403
  },
314
- "project:deploy:cancel": {
404
+ "project:delete:source": {
315
405
  "aliases": [
316
- "deploy:metadata:cancel"
406
+ "force:source:delete"
317
407
  ],
318
408
  "args": {},
319
409
  "deprecateAliases": true,
320
- "description": "Use this command to cancel a deploy operation that hasn't yet completed in the org. Deploy operations include standard deploys, quick deploys, deploy validations, and deploy cancellations.\n\nRun this command by either passing it a job ID or specifying the --use-most-recent flag to use the job ID of the most recent deploy operation.",
410
+ "description": "Use this command to delete components from orgs that don’t have source tracking. To remove deleted items from orgs that have source tracking enabled, \"sf project deploy start\".\n\nWhen you run this command, both the local source file and the metadata component in the org are deleted.\n\nTo delete multiple metadata components, either set multiple --metadata <name> flags or a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --manifest and --source-dir.",
321
411
  "examples": [
322
- "Cancel a deploy operation using a job ID:\nsf <%= command.id %> --job-id 0Af0x000017yLUFCA2",
323
- "Cancel the most recent deploy operation:\nsf <%= command.id %> --use-most-recent"
412
+ "Delete all local Apex source files and all Apex classes from the org with alias \"my-scratch\":\nsf <%= command.id %> --metadata ApexClass --target-org my-scratch",
413
+ "Delete a specific Apex class and a Profile that has a space in it from your default org; don't prompt for confirmation:\nsf <%= command.id %> --metadata ApexClass:MyFabulousApexClass --metadata \"Profile: My Profile\" --no-prompt",
414
+ "Run the tests that aren’t in any managed packages as part of the deletion; if the delete succeeds, and the org has source-tracking enabled, update the source tracking information:\nsf <%= command.id %> --metadata ApexClass --test-level RunLocalTests --track-source",
415
+ "Delete the Apex source files in a directory and the corresponding components from your default org:\nsf <%= command.id %> --source-dir force-app/main/default/classes"
324
416
  ],
325
417
  "flags": {
326
418
  "json": {
@@ -338,86 +430,431 @@
338
430
  "multiple": false,
339
431
  "type": "option"
340
432
  },
433
+ "api-version": {
434
+ "aliases": [
435
+ "apiversion"
436
+ ],
437
+ "deprecateAliases": true,
438
+ "description": "Override the api version used for api requests made by this command",
439
+ "name": "api-version",
440
+ "hasDynamicHelp": false,
441
+ "multiple": false,
442
+ "type": "option"
443
+ },
444
+ "loglevel": {
445
+ "deprecated": {
446
+ "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
447
+ },
448
+ "hidden": true,
449
+ "name": "loglevel",
450
+ "hasDynamicHelp": false,
451
+ "multiple": false,
452
+ "type": "option"
453
+ },
341
454
  "target-org": {
455
+ "aliases": [
456
+ "targetusername",
457
+ "u"
458
+ ],
342
459
  "char": "o",
343
- "description": "Overrides your default org.",
460
+ "deprecateAliases": true,
344
461
  "name": "target-org",
345
462
  "noCacheDefault": true,
346
- "summary": "Login username or alias for the target org.",
463
+ "required": true,
464
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
347
465
  "hasDynamicHelp": true,
348
466
  "multiple": false,
349
467
  "type": "option"
350
468
  },
351
- "async": {
352
- "description": "The command immediately returns the control of the terminal to you. This way, you can continue to use the CLI. To resume watching the cancellation, run \"sf project deploy resume\". To check the status of the cancellation, run \"sf project deploy report\".",
353
- "exclusive": [
354
- "wait"
469
+ "check-only": {
470
+ "aliases": [
471
+ "checkonly"
355
472
  ],
356
- "name": "async",
357
- "summary": "Run the command asynchronously.",
473
+ "char": "c",
474
+ "deprecateAliases": true,
475
+ "description": "IMPORTANT: Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.\n\nValidates the deleted metadata and runs all Apex tests, but prevents the deletion from being saved to the org.\n\nIf you change a field type from Master-Detail to Lookup or vice versa, that change isn’t supported when using the --check-only parameter to test a deletion (validation). This kind of change isn’t supported for test deletions to avoid the risk of data loss or corruption. If a change that isn’t supported for test deletions is included in a deletion package, the test deletion fails and issues an error.\n\nIf your deletion package changes a field type from Master-Detail to Lookup or vice versa, you can still validate the changes prior to deploying to Production by performing a full deletion to another test Sandbox. A full deletion includes a validation of the changes as part of the deletion process.\n\nNote: A Metadata API deletion that includes Master-Detail relationships deletes all detail records in the Recycle Bin in the following cases.\n\n 1. For a deletion with a new Master-Detail field, soft delete (send to the Recycle Bin) all detail records before proceeding to delete the Master-Detail field, or the deletion fails. During the deletion, detail records are permanently deleted from the Recycle Bin and cannot be recovered.\n\n 2. For a deletion that converts a Lookup field relationship to a Master-Detail relationship, detail records must reference a master record or be soft-deleted (sent to the Recycle Bin) for the deletion to succeed. However, a successful deletion permanently deletes any detail records in the Recycle Bin.",
476
+ "name": "check-only",
477
+ "summary": "Validate delete command but don't delete anything from the org or the local project.",
358
478
  "allowNo": false,
359
479
  "type": "boolean"
360
480
  },
361
- "job-id": {
362
- "char": "i",
363
- "description": "These commands return a job ID if they time out or you specified the --async flag:\n\n- sf project deploy start\n- sf project deploy validate\n- sf project deploy quick\n- sf project deploy cancel\n\nThe job ID is valid for 10 days from when you started the deploy operation.",
364
- "name": "job-id",
365
- "summary": "Job ID of the deploy operation you want to cancel.",
481
+ "wait": {
482
+ "char": "w",
483
+ "description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you.",
484
+ "name": "wait",
485
+ "summary": "Number of minutes to wait for the command to finish.",
486
+ "hasDynamicHelp": true,
487
+ "multiple": false,
488
+ "type": "option"
489
+ },
490
+ "tests": {
491
+ "description": "If a test name contains a space, enclose it in double quotes.\nFor multiple test names, use one of the following formats:\n\n- Repeat the flag for multiple test names: --tests Test1 --tests Test2 --tests \"Test With Space\"\n- Separate the test names with spaces: --tests Test1 Test2 \"Test With Space\"",
492
+ "helpGroup": "Test",
493
+ "name": "tests",
494
+ "summary": "Apex tests to run when --test-level is RunSpecifiedTests.",
495
+ "hasDynamicHelp": false,
496
+ "multiple": true,
497
+ "type": "option"
498
+ },
499
+ "test-level": {
500
+ "aliases": [
501
+ "testlevel"
502
+ ],
503
+ "char": "l",
504
+ "deprecateAliases": true,
505
+ "description": "Valid values are:\n\n- NoTestRun — No tests are run. This test level applies only to deployments to development environments, such as sandbox, Developer Edition, or trial orgs. This test level is the default for development environments.\n\n- RunSpecifiedTests — Runs only the tests that you specify with the --tests flag. Code coverage requirements differ from the default coverage requirements when using this test level. Executed tests must comprise a minimum of 75% code coverage for each class and trigger in the deployment package. This coverage is computed for each class and trigger individually and is different than the overall coverage percentage.\n\n- RunLocalTests — All tests in your org are run, except the ones that originate from installed managed and unlocked packages. This test level is the default for production deployments that include Apex classes or triggers.\n\n- RunAllTestsInOrg — All tests in your org are run, including tests of managed packages.\n\nIf you don’t specify a test level, the default behavior depends on the contents of your deployment package and target org. For more information, see “Running Tests in a Deployment” in the Metadata API Developer Guide.",
506
+ "helpGroup": "Test",
507
+ "name": "test-level",
508
+ "summary": "Deployment Apex testing level.",
366
509
  "hasDynamicHelp": false,
367
510
  "multiple": false,
511
+ "options": [
512
+ "NoTestRun",
513
+ "RunSpecifiedTests",
514
+ "RunLocalTests",
515
+ "RunAllTestsInOrg"
516
+ ],
368
517
  "type": "option"
369
518
  },
370
- "use-most-recent": {
519
+ "no-prompt": {
520
+ "aliases": [
521
+ "noprompt"
522
+ ],
371
523
  "char": "r",
372
- "description": "For performance reasons, this flag uses job IDs for deploy operations that started only in the past 3 days or less. If your most recent deploy operations was more than 3 days ago, this flag won't find a job ID.",
373
- "name": "use-most-recent",
374
- "summary": "Use the job ID of the most recent deploy operation.",
524
+ "deprecateAliases": true,
525
+ "name": "no-prompt",
526
+ "summary": "Don't prompt for delete confirmation.",
375
527
  "allowNo": false,
376
528
  "type": "boolean"
377
529
  },
378
- "wait": {
379
- "char": "w",
380
- "description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you. To resume watching the cancellation, run \"sf project deploy resume\". To check the status of the cancellation, run \"sf project deploy report\".",
381
- "exclusive": [
382
- "async"
530
+ "metadata": {
531
+ "char": "m",
532
+ "description": "If you specify this parameter, don’t specify --source-dir.",
533
+ "name": "metadata",
534
+ "summary": "Metadata components to delete.",
535
+ "delimiter": ",",
536
+ "hasDynamicHelp": false,
537
+ "multiple": true,
538
+ "type": "option"
539
+ },
540
+ "source-dir": {
541
+ "aliases": [
542
+ "sourcepath"
383
543
  ],
384
- "name": "wait",
385
- "summary": "Number of minutes to wait for the command to complete and display results.",
386
- "hasDynamicHelp": true,
387
- "helpValue": "<minutes>",
388
- "multiple": false,
544
+ "char": "p",
545
+ "deprecateAliases": true,
546
+ "description": "The supplied paths can be a single file (in which case the operation is applied to only one file) or a folder (in which case the operation is applied to all metadata types in the directory and its sub-directories).\n\nIf you specify this parameter, don’t specify --metadata.",
547
+ "name": "source-dir",
548
+ "summary": "Source file paths to delete.",
549
+ "delimiter": ",",
550
+ "hasDynamicHelp": false,
551
+ "multiple": true,
389
552
  "type": "option"
553
+ },
554
+ "track-source": {
555
+ "aliases": [
556
+ "tracksource"
557
+ ],
558
+ "char": "t",
559
+ "deprecateAliases": true,
560
+ "exclusive": [
561
+ "check-only"
562
+ ],
563
+ "name": "track-source",
564
+ "summary": "If the delete succeeds, update the source tracking information.",
565
+ "allowNo": false,
566
+ "type": "boolean"
567
+ },
568
+ "force-overwrite": {
569
+ "aliases": [
570
+ "forceoverwrite"
571
+ ],
572
+ "char": "f",
573
+ "dependsOn": [
574
+ "track-source"
575
+ ],
576
+ "deprecateAliases": true,
577
+ "name": "force-overwrite",
578
+ "summary": "Ignore conflict warnings and overwrite changes to the org.",
579
+ "allowNo": false,
580
+ "type": "boolean"
581
+ },
582
+ "verbose": {
583
+ "name": "verbose",
584
+ "summary": "Verbose output of the delete result.",
585
+ "allowNo": false,
586
+ "type": "boolean"
390
587
  }
391
588
  },
392
589
  "hasDynamicHelp": true,
393
590
  "hiddenAliases": [],
394
- "id": "project:deploy:cancel",
591
+ "id": "project:delete:source",
395
592
  "pluginAlias": "@salesforce/plugin-deploy-retrieve",
396
593
  "pluginName": "@salesforce/plugin-deploy-retrieve",
397
594
  "pluginType": "core",
398
595
  "strict": true,
399
- "summary": "Cancel a deploy operation.",
596
+ "summary": "Delete source from your project and from a non-source-tracked org.",
400
597
  "enableJsonFlag": true,
598
+ "requiresProject": true,
401
599
  "isESM": true,
402
600
  "relativePath": [
403
601
  "lib",
404
602
  "commands",
405
603
  "project",
406
- "deploy",
407
- "cancel.js"
604
+ "delete",
605
+ "source.js"
408
606
  ],
409
607
  "aliasPermutations": [
410
- "deploy:metadata:cancel",
411
- "metadata:deploy:cancel",
412
- "metadata:cancel:deploy",
413
- "deploy:cancel:metadata",
414
- "cancel:deploy:metadata",
415
- "cancel:metadata:deploy"
608
+ "force:source:delete",
609
+ "source:force:delete",
610
+ "source:delete:force",
611
+ "force:delete:source",
612
+ "delete:force:source",
613
+ "delete:source:force"
416
614
  ],
417
615
  "permutations": [
418
- "project:deploy:cancel",
419
- "deploy:project:cancel",
420
- "deploy:cancel:project",
616
+ "project:delete:source",
617
+ "delete:project:source",
618
+ "delete:source:project",
619
+ "project:source:delete",
620
+ "source:project:delete",
621
+ "source:delete:project"
622
+ ]
623
+ },
624
+ "project:delete:tracking": {
625
+ "aliases": [
626
+ "force:source:tracking:clear"
627
+ ],
628
+ "args": {},
629
+ "deprecateAliases": true,
630
+ "description": "WARNING: This command deletes or overwrites all existing source tracking files. Use with extreme caution.\n\nDeletes all local source tracking information. When you next run 'project deploy preview', Salesforce CLI displays all local and remote files as changed, and any files with the same name are listed as conflicts.",
631
+ "examples": [
632
+ "Delete local source tracking for the org with alias \"my-scratch\":\n$ sf <%= command.id %> --target-org my-scratch"
633
+ ],
634
+ "flags": {
635
+ "json": {
636
+ "description": "Format output as json.",
637
+ "helpGroup": "GLOBAL",
638
+ "name": "json",
639
+ "allowNo": false,
640
+ "type": "boolean"
641
+ },
642
+ "flags-dir": {
643
+ "helpGroup": "GLOBAL",
644
+ "name": "flags-dir",
645
+ "summary": "Import flag values from a directory.",
646
+ "hasDynamicHelp": false,
647
+ "multiple": false,
648
+ "type": "option"
649
+ },
650
+ "api-version": {
651
+ "aliases": [
652
+ "apiversion"
653
+ ],
654
+ "deprecateAliases": true,
655
+ "description": "Override the api version used for api requests made by this command",
656
+ "name": "api-version",
657
+ "hasDynamicHelp": false,
658
+ "multiple": false,
659
+ "type": "option"
660
+ },
661
+ "loglevel": {
662
+ "deprecated": {
663
+ "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
664
+ },
665
+ "hidden": true,
666
+ "name": "loglevel",
667
+ "hasDynamicHelp": false,
668
+ "multiple": false,
669
+ "type": "option"
670
+ },
671
+ "target-org": {
672
+ "aliases": [
673
+ "targetusername",
674
+ "u"
675
+ ],
676
+ "char": "o",
677
+ "deprecateAliases": true,
678
+ "name": "target-org",
679
+ "noCacheDefault": true,
680
+ "required": true,
681
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
682
+ "hasDynamicHelp": true,
683
+ "multiple": false,
684
+ "type": "option"
685
+ },
686
+ "no-prompt": {
687
+ "aliases": [
688
+ "noprompt"
689
+ ],
690
+ "char": "p",
691
+ "deprecateAliases": true,
692
+ "name": "no-prompt",
693
+ "summary": "Don't prompt for source tracking override confirmation.",
694
+ "allowNo": false,
695
+ "type": "boolean"
696
+ }
697
+ },
698
+ "hasDynamicHelp": true,
699
+ "hiddenAliases": [],
700
+ "id": "project:delete:tracking",
701
+ "pluginAlias": "@salesforce/plugin-deploy-retrieve",
702
+ "pluginName": "@salesforce/plugin-deploy-retrieve",
703
+ "pluginType": "core",
704
+ "strict": true,
705
+ "summary": "Delete all local source tracking information.",
706
+ "enableJsonFlag": true,
707
+ "requiresProject": true,
708
+ "isESM": true,
709
+ "relativePath": [
710
+ "lib",
711
+ "commands",
712
+ "project",
713
+ "delete",
714
+ "tracking.js"
715
+ ],
716
+ "aliasPermutations": [
717
+ "force:source:tracking:clear",
718
+ "source:force:tracking:clear",
719
+ "source:tracking:force:clear",
720
+ "source:tracking:clear:force",
721
+ "force:tracking:source:clear",
722
+ "tracking:force:source:clear",
723
+ "tracking:source:force:clear",
724
+ "tracking:source:clear:force",
725
+ "force:tracking:clear:source",
726
+ "tracking:force:clear:source",
727
+ "tracking:clear:force:source",
728
+ "tracking:clear:source:force",
729
+ "force:source:clear:tracking",
730
+ "source:force:clear:tracking",
731
+ "source:clear:force:tracking",
732
+ "source:clear:tracking:force",
733
+ "force:clear:source:tracking",
734
+ "clear:force:source:tracking",
735
+ "clear:source:force:tracking",
736
+ "clear:source:tracking:force",
737
+ "force:clear:tracking:source",
738
+ "clear:force:tracking:source",
739
+ "clear:tracking:force:source",
740
+ "clear:tracking:source:force"
741
+ ],
742
+ "permutations": [
743
+ "project:delete:tracking",
744
+ "delete:project:tracking",
745
+ "delete:tracking:project",
746
+ "project:tracking:delete",
747
+ "tracking:project:delete",
748
+ "tracking:delete:project"
749
+ ]
750
+ },
751
+ "project:deploy:cancel": {
752
+ "aliases": [
753
+ "deploy:metadata:cancel"
754
+ ],
755
+ "args": {},
756
+ "deprecateAliases": true,
757
+ "description": "Use this command to cancel a deploy operation that hasn't yet completed in the org. Deploy operations include standard deploys, quick deploys, deploy validations, and deploy cancellations.\n\nRun this command by either passing it a job ID or specifying the --use-most-recent flag to use the job ID of the most recent deploy operation.",
758
+ "examples": [
759
+ "Cancel a deploy operation using a job ID:\nsf <%= command.id %> --job-id 0Af0x000017yLUFCA2",
760
+ "Cancel the most recent deploy operation:\nsf <%= command.id %> --use-most-recent"
761
+ ],
762
+ "flags": {
763
+ "json": {
764
+ "description": "Format output as json.",
765
+ "helpGroup": "GLOBAL",
766
+ "name": "json",
767
+ "allowNo": false,
768
+ "type": "boolean"
769
+ },
770
+ "flags-dir": {
771
+ "helpGroup": "GLOBAL",
772
+ "name": "flags-dir",
773
+ "summary": "Import flag values from a directory.",
774
+ "hasDynamicHelp": false,
775
+ "multiple": false,
776
+ "type": "option"
777
+ },
778
+ "target-org": {
779
+ "char": "o",
780
+ "description": "Overrides your default org.",
781
+ "name": "target-org",
782
+ "noCacheDefault": true,
783
+ "summary": "Login username or alias for the target org.",
784
+ "hasDynamicHelp": true,
785
+ "multiple": false,
786
+ "type": "option"
787
+ },
788
+ "async": {
789
+ "description": "The command immediately returns the control of the terminal to you. This way, you can continue to use the CLI. To resume watching the cancellation, run \"sf project deploy resume\". To check the status of the cancellation, run \"sf project deploy report\".",
790
+ "exclusive": [
791
+ "wait"
792
+ ],
793
+ "name": "async",
794
+ "summary": "Run the command asynchronously.",
795
+ "allowNo": false,
796
+ "type": "boolean"
797
+ },
798
+ "job-id": {
799
+ "char": "i",
800
+ "description": "These commands return a job ID if they time out or you specified the --async flag:\n\n- sf project deploy start\n- sf project deploy validate\n- sf project deploy quick\n- sf project deploy cancel\n\nThe job ID is valid for 10 days from when you started the deploy operation.",
801
+ "name": "job-id",
802
+ "summary": "Job ID of the deploy operation you want to cancel.",
803
+ "hasDynamicHelp": false,
804
+ "multiple": false,
805
+ "type": "option"
806
+ },
807
+ "use-most-recent": {
808
+ "char": "r",
809
+ "description": "For performance reasons, this flag uses job IDs for deploy operations that started only in the past 3 days or less. If your most recent deploy operations was more than 3 days ago, this flag won't find a job ID.",
810
+ "name": "use-most-recent",
811
+ "summary": "Use the job ID of the most recent deploy operation.",
812
+ "allowNo": false,
813
+ "type": "boolean"
814
+ },
815
+ "wait": {
816
+ "char": "w",
817
+ "description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you. To resume watching the cancellation, run \"sf project deploy resume\". To check the status of the cancellation, run \"sf project deploy report\".",
818
+ "exclusive": [
819
+ "async"
820
+ ],
821
+ "name": "wait",
822
+ "summary": "Number of minutes to wait for the command to complete and display results.",
823
+ "hasDynamicHelp": true,
824
+ "helpValue": "<minutes>",
825
+ "multiple": false,
826
+ "type": "option"
827
+ }
828
+ },
829
+ "hasDynamicHelp": true,
830
+ "hiddenAliases": [],
831
+ "id": "project:deploy:cancel",
832
+ "pluginAlias": "@salesforce/plugin-deploy-retrieve",
833
+ "pluginName": "@salesforce/plugin-deploy-retrieve",
834
+ "pluginType": "core",
835
+ "strict": true,
836
+ "summary": "Cancel a deploy operation.",
837
+ "enableJsonFlag": true,
838
+ "isESM": true,
839
+ "relativePath": [
840
+ "lib",
841
+ "commands",
842
+ "project",
843
+ "deploy",
844
+ "cancel.js"
845
+ ],
846
+ "aliasPermutations": [
847
+ "deploy:metadata:cancel",
848
+ "metadata:deploy:cancel",
849
+ "metadata:cancel:deploy",
850
+ "deploy:cancel:metadata",
851
+ "cancel:deploy:metadata",
852
+ "cancel:metadata:deploy"
853
+ ],
854
+ "permutations": [
855
+ "project:deploy:cancel",
856
+ "deploy:project:cancel",
857
+ "deploy:cancel:project",
421
858
  "project:cancel:deploy",
422
859
  "cancel:project:deploy",
423
860
  "cancel:deploy:project"
@@ -1809,353 +2246,6 @@
1809
2246
  "validate:deploy:project"
1810
2247
  ]
1811
2248
  },
1812
- "project:delete:source": {
1813
- "aliases": [
1814
- "force:source:delete"
1815
- ],
1816
- "args": {},
1817
- "deprecateAliases": true,
1818
- "description": "Use this command to delete components from orgs that don’t have source tracking. To remove deleted items from orgs that have source tracking enabled, \"sf project deploy start\".\n\nWhen you run this command, both the local source file and the metadata component in the org are deleted.\n\nTo delete multiple metadata components, either set multiple --metadata <name> flags or a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --manifest and --source-dir.",
1819
- "examples": [
1820
- "Delete all local Apex source files and all Apex classes from the org with alias \"my-scratch\":\nsf <%= command.id %> --metadata ApexClass --target-org my-scratch",
1821
- "Delete a specific Apex class and a Profile that has a space in it from your default org; don't prompt for confirmation:\nsf <%= command.id %> --metadata ApexClass:MyFabulousApexClass --metadata \"Profile: My Profile\" --no-prompt",
1822
- "Run the tests that aren’t in any managed packages as part of the deletion; if the delete succeeds, and the org has source-tracking enabled, update the source tracking information:\nsf <%= command.id %> --metadata ApexClass --test-level RunLocalTests --track-source",
1823
- "Delete the Apex source files in a directory and the corresponding components from your default org:\nsf <%= command.id %> --source-dir force-app/main/default/classes"
1824
- ],
1825
- "flags": {
1826
- "json": {
1827
- "description": "Format output as json.",
1828
- "helpGroup": "GLOBAL",
1829
- "name": "json",
1830
- "allowNo": false,
1831
- "type": "boolean"
1832
- },
1833
- "flags-dir": {
1834
- "helpGroup": "GLOBAL",
1835
- "name": "flags-dir",
1836
- "summary": "Import flag values from a directory.",
1837
- "hasDynamicHelp": false,
1838
- "multiple": false,
1839
- "type": "option"
1840
- },
1841
- "api-version": {
1842
- "aliases": [
1843
- "apiversion"
1844
- ],
1845
- "deprecateAliases": true,
1846
- "description": "Override the api version used for api requests made by this command",
1847
- "name": "api-version",
1848
- "hasDynamicHelp": false,
1849
- "multiple": false,
1850
- "type": "option"
1851
- },
1852
- "loglevel": {
1853
- "deprecated": {
1854
- "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
1855
- },
1856
- "hidden": true,
1857
- "name": "loglevel",
1858
- "hasDynamicHelp": false,
1859
- "multiple": false,
1860
- "type": "option"
1861
- },
1862
- "target-org": {
1863
- "aliases": [
1864
- "targetusername",
1865
- "u"
1866
- ],
1867
- "char": "o",
1868
- "deprecateAliases": true,
1869
- "name": "target-org",
1870
- "noCacheDefault": true,
1871
- "required": true,
1872
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
1873
- "hasDynamicHelp": true,
1874
- "multiple": false,
1875
- "type": "option"
1876
- },
1877
- "check-only": {
1878
- "aliases": [
1879
- "checkonly"
1880
- ],
1881
- "char": "c",
1882
- "deprecateAliases": true,
1883
- "description": "IMPORTANT: Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.\n\nValidates the deleted metadata and runs all Apex tests, but prevents the deletion from being saved to the org.\n\nIf you change a field type from Master-Detail to Lookup or vice versa, that change isn’t supported when using the --check-only parameter to test a deletion (validation). This kind of change isn’t supported for test deletions to avoid the risk of data loss or corruption. If a change that isn’t supported for test deletions is included in a deletion package, the test deletion fails and issues an error.\n\nIf your deletion package changes a field type from Master-Detail to Lookup or vice versa, you can still validate the changes prior to deploying to Production by performing a full deletion to another test Sandbox. A full deletion includes a validation of the changes as part of the deletion process.\n\nNote: A Metadata API deletion that includes Master-Detail relationships deletes all detail records in the Recycle Bin in the following cases.\n\n 1. For a deletion with a new Master-Detail field, soft delete (send to the Recycle Bin) all detail records before proceeding to delete the Master-Detail field, or the deletion fails. During the deletion, detail records are permanently deleted from the Recycle Bin and cannot be recovered.\n\n 2. For a deletion that converts a Lookup field relationship to a Master-Detail relationship, detail records must reference a master record or be soft-deleted (sent to the Recycle Bin) for the deletion to succeed. However, a successful deletion permanently deletes any detail records in the Recycle Bin.",
1884
- "name": "check-only",
1885
- "summary": "Validate delete command but don't delete anything from the org or the local project.",
1886
- "allowNo": false,
1887
- "type": "boolean"
1888
- },
1889
- "wait": {
1890
- "char": "w",
1891
- "description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you.",
1892
- "name": "wait",
1893
- "summary": "Number of minutes to wait for the command to finish.",
1894
- "hasDynamicHelp": true,
1895
- "multiple": false,
1896
- "type": "option"
1897
- },
1898
- "tests": {
1899
- "description": "If a test name contains a space, enclose it in double quotes.\nFor multiple test names, use one of the following formats:\n\n- Repeat the flag for multiple test names: --tests Test1 --tests Test2 --tests \"Test With Space\"\n- Separate the test names with spaces: --tests Test1 Test2 \"Test With Space\"",
1900
- "helpGroup": "Test",
1901
- "name": "tests",
1902
- "summary": "Apex tests to run when --test-level is RunSpecifiedTests.",
1903
- "hasDynamicHelp": false,
1904
- "multiple": true,
1905
- "type": "option"
1906
- },
1907
- "test-level": {
1908
- "aliases": [
1909
- "testlevel"
1910
- ],
1911
- "char": "l",
1912
- "deprecateAliases": true,
1913
- "description": "Valid values are:\n\n- NoTestRun — No tests are run. This test level applies only to deployments to development environments, such as sandbox, Developer Edition, or trial orgs. This test level is the default for development environments.\n\n- RunSpecifiedTests — Runs only the tests that you specify with the --tests flag. Code coverage requirements differ from the default coverage requirements when using this test level. Executed tests must comprise a minimum of 75% code coverage for each class and trigger in the deployment package. This coverage is computed for each class and trigger individually and is different than the overall coverage percentage.\n\n- RunLocalTests — All tests in your org are run, except the ones that originate from installed managed and unlocked packages. This test level is the default for production deployments that include Apex classes or triggers.\n\n- RunAllTestsInOrg — All tests in your org are run, including tests of managed packages.\n\nIf you don’t specify a test level, the default behavior depends on the contents of your deployment package and target org. For more information, see “Running Tests in a Deployment” in the Metadata API Developer Guide.",
1914
- "helpGroup": "Test",
1915
- "name": "test-level",
1916
- "summary": "Deployment Apex testing level.",
1917
- "hasDynamicHelp": false,
1918
- "multiple": false,
1919
- "options": [
1920
- "NoTestRun",
1921
- "RunSpecifiedTests",
1922
- "RunLocalTests",
1923
- "RunAllTestsInOrg"
1924
- ],
1925
- "type": "option"
1926
- },
1927
- "no-prompt": {
1928
- "aliases": [
1929
- "noprompt"
1930
- ],
1931
- "char": "r",
1932
- "deprecateAliases": true,
1933
- "name": "no-prompt",
1934
- "summary": "Don't prompt for delete confirmation.",
1935
- "allowNo": false,
1936
- "type": "boolean"
1937
- },
1938
- "metadata": {
1939
- "char": "m",
1940
- "description": "If you specify this parameter, don’t specify --source-dir.",
1941
- "name": "metadata",
1942
- "summary": "Metadata components to delete.",
1943
- "delimiter": ",",
1944
- "hasDynamicHelp": false,
1945
- "multiple": true,
1946
- "type": "option"
1947
- },
1948
- "source-dir": {
1949
- "aliases": [
1950
- "sourcepath"
1951
- ],
1952
- "char": "p",
1953
- "deprecateAliases": true,
1954
- "description": "The supplied paths can be a single file (in which case the operation is applied to only one file) or a folder (in which case the operation is applied to all metadata types in the directory and its sub-directories).\n\nIf you specify this parameter, don’t specify --metadata.",
1955
- "name": "source-dir",
1956
- "summary": "Source file paths to delete.",
1957
- "delimiter": ",",
1958
- "hasDynamicHelp": false,
1959
- "multiple": true,
1960
- "type": "option"
1961
- },
1962
- "track-source": {
1963
- "aliases": [
1964
- "tracksource"
1965
- ],
1966
- "char": "t",
1967
- "deprecateAliases": true,
1968
- "exclusive": [
1969
- "check-only"
1970
- ],
1971
- "name": "track-source",
1972
- "summary": "If the delete succeeds, update the source tracking information.",
1973
- "allowNo": false,
1974
- "type": "boolean"
1975
- },
1976
- "force-overwrite": {
1977
- "aliases": [
1978
- "forceoverwrite"
1979
- ],
1980
- "char": "f",
1981
- "dependsOn": [
1982
- "track-source"
1983
- ],
1984
- "deprecateAliases": true,
1985
- "name": "force-overwrite",
1986
- "summary": "Ignore conflict warnings and overwrite changes to the org.",
1987
- "allowNo": false,
1988
- "type": "boolean"
1989
- },
1990
- "verbose": {
1991
- "name": "verbose",
1992
- "summary": "Verbose output of the delete result.",
1993
- "allowNo": false,
1994
- "type": "boolean"
1995
- }
1996
- },
1997
- "hasDynamicHelp": true,
1998
- "hiddenAliases": [],
1999
- "id": "project:delete:source",
2000
- "pluginAlias": "@salesforce/plugin-deploy-retrieve",
2001
- "pluginName": "@salesforce/plugin-deploy-retrieve",
2002
- "pluginType": "core",
2003
- "strict": true,
2004
- "summary": "Delete source from your project and from a non-source-tracked org.",
2005
- "enableJsonFlag": true,
2006
- "requiresProject": true,
2007
- "isESM": true,
2008
- "relativePath": [
2009
- "lib",
2010
- "commands",
2011
- "project",
2012
- "delete",
2013
- "source.js"
2014
- ],
2015
- "aliasPermutations": [
2016
- "force:source:delete",
2017
- "source:force:delete",
2018
- "source:delete:force",
2019
- "force:delete:source",
2020
- "delete:force:source",
2021
- "delete:source:force"
2022
- ],
2023
- "permutations": [
2024
- "project:delete:source",
2025
- "delete:project:source",
2026
- "delete:source:project",
2027
- "project:source:delete",
2028
- "source:project:delete",
2029
- "source:delete:project"
2030
- ]
2031
- },
2032
- "project:delete:tracking": {
2033
- "aliases": [
2034
- "force:source:tracking:clear"
2035
- ],
2036
- "args": {},
2037
- "deprecateAliases": true,
2038
- "description": "WARNING: This command deletes or overwrites all existing source tracking files. Use with extreme caution.\n\nDeletes all local source tracking information. When you next run 'project deploy preview', Salesforce CLI displays all local and remote files as changed, and any files with the same name are listed as conflicts.",
2039
- "examples": [
2040
- "Delete local source tracking for the org with alias \"my-scratch\":\n$ sf <%= command.id %> --target-org my-scratch"
2041
- ],
2042
- "flags": {
2043
- "json": {
2044
- "description": "Format output as json.",
2045
- "helpGroup": "GLOBAL",
2046
- "name": "json",
2047
- "allowNo": false,
2048
- "type": "boolean"
2049
- },
2050
- "flags-dir": {
2051
- "helpGroup": "GLOBAL",
2052
- "name": "flags-dir",
2053
- "summary": "Import flag values from a directory.",
2054
- "hasDynamicHelp": false,
2055
- "multiple": false,
2056
- "type": "option"
2057
- },
2058
- "api-version": {
2059
- "aliases": [
2060
- "apiversion"
2061
- ],
2062
- "deprecateAliases": true,
2063
- "description": "Override the api version used for api requests made by this command",
2064
- "name": "api-version",
2065
- "hasDynamicHelp": false,
2066
- "multiple": false,
2067
- "type": "option"
2068
- },
2069
- "loglevel": {
2070
- "deprecated": {
2071
- "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
2072
- },
2073
- "hidden": true,
2074
- "name": "loglevel",
2075
- "hasDynamicHelp": false,
2076
- "multiple": false,
2077
- "type": "option"
2078
- },
2079
- "target-org": {
2080
- "aliases": [
2081
- "targetusername",
2082
- "u"
2083
- ],
2084
- "char": "o",
2085
- "deprecateAliases": true,
2086
- "name": "target-org",
2087
- "noCacheDefault": true,
2088
- "required": true,
2089
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
2090
- "hasDynamicHelp": true,
2091
- "multiple": false,
2092
- "type": "option"
2093
- },
2094
- "no-prompt": {
2095
- "aliases": [
2096
- "noprompt"
2097
- ],
2098
- "char": "p",
2099
- "deprecateAliases": true,
2100
- "name": "no-prompt",
2101
- "summary": "Don't prompt for source tracking override confirmation.",
2102
- "allowNo": false,
2103
- "type": "boolean"
2104
- }
2105
- },
2106
- "hasDynamicHelp": true,
2107
- "hiddenAliases": [],
2108
- "id": "project:delete:tracking",
2109
- "pluginAlias": "@salesforce/plugin-deploy-retrieve",
2110
- "pluginName": "@salesforce/plugin-deploy-retrieve",
2111
- "pluginType": "core",
2112
- "strict": true,
2113
- "summary": "Delete all local source tracking information.",
2114
- "enableJsonFlag": true,
2115
- "requiresProject": true,
2116
- "isESM": true,
2117
- "relativePath": [
2118
- "lib",
2119
- "commands",
2120
- "project",
2121
- "delete",
2122
- "tracking.js"
2123
- ],
2124
- "aliasPermutations": [
2125
- "force:source:tracking:clear",
2126
- "source:force:tracking:clear",
2127
- "source:tracking:force:clear",
2128
- "source:tracking:clear:force",
2129
- "force:tracking:source:clear",
2130
- "tracking:force:source:clear",
2131
- "tracking:source:force:clear",
2132
- "tracking:source:clear:force",
2133
- "force:tracking:clear:source",
2134
- "tracking:force:clear:source",
2135
- "tracking:clear:force:source",
2136
- "tracking:clear:source:force",
2137
- "force:source:clear:tracking",
2138
- "source:force:clear:tracking",
2139
- "source:clear:force:tracking",
2140
- "source:clear:tracking:force",
2141
- "force:clear:source:tracking",
2142
- "clear:force:source:tracking",
2143
- "clear:source:force:tracking",
2144
- "clear:source:tracking:force",
2145
- "force:clear:tracking:source",
2146
- "clear:force:tracking:source",
2147
- "clear:tracking:force:source",
2148
- "clear:tracking:source:force"
2149
- ],
2150
- "permutations": [
2151
- "project:delete:tracking",
2152
- "delete:project:tracking",
2153
- "delete:tracking:project",
2154
- "project:tracking:delete",
2155
- "tracking:project:delete",
2156
- "tracking:delete:project"
2157
- ]
2158
- },
2159
2249
  "project:generate:manifest": {
2160
2250
  "aliases": [
2161
2251
  "force:source:manifest:create"
@@ -2936,5 +3026,5 @@
2936
3026
  ]
2937
3027
  }
2938
3028
  },
2939
- "version": "3.7.10"
3029
+ "version": "3.8.1"
2940
3030
  }