@salesforce/plugin-deploy-retrieve 1.8.5-beta.6 → 1.8.5-beta.8

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.
Files changed (42) hide show
  1. package/lib/commands/project/deploy/cancel.js +1 -1
  2. package/lib/commands/project/deploy/cancel.js.map +1 -1
  3. package/lib/commands/project/deploy/quick.js +1 -1
  4. package/lib/commands/project/deploy/quick.js.map +1 -1
  5. package/lib/commands/project/deploy/report.d.ts +0 -3
  6. package/lib/commands/project/deploy/report.js +10 -11
  7. package/lib/commands/project/deploy/report.js.map +1 -1
  8. package/lib/commands/project/deploy/resume.js +4 -4
  9. package/lib/commands/project/deploy/resume.js.map +1 -1
  10. package/lib/commands/project/deploy/start.js +10 -10
  11. package/lib/commands/project/deploy/start.js.map +1 -1
  12. package/lib/commands/project/deploy/validate.js +2 -2
  13. package/lib/commands/project/deploy/validate.js.map +1 -1
  14. package/lib/commands/project/list/ignored.js +2 -2
  15. package/lib/commands/project/list/ignored.js.map +1 -1
  16. package/lib/commands/project/retrieve/start.js +1 -1
  17. package/lib/commands/project/retrieve/start.js.map +1 -1
  18. package/lib/formatters/asyncDeployCancelResultFormatter.d.ts +2 -1
  19. package/lib/formatters/asyncDeployCancelResultFormatter.js +4 -3
  20. package/lib/formatters/asyncDeployCancelResultFormatter.js.map +1 -1
  21. package/lib/formatters/asyncDeployResultFormatter.d.ts +2 -1
  22. package/lib/formatters/asyncDeployResultFormatter.js +5 -4
  23. package/lib/formatters/asyncDeployResultFormatter.js.map +1 -1
  24. package/lib/utils/deploy.d.ts +1 -1
  25. package/lib/utils/deploy.js +2 -2
  26. package/lib/utils/deploy.js.map +1 -1
  27. package/messages/convert.mdapi.md +4 -2
  28. package/messages/convert.source.md +4 -2
  29. package/messages/delete.source.md +5 -3
  30. package/messages/deploy.async.md +3 -3
  31. package/messages/deploy.md +1 -1
  32. package/messages/deploy.metadata.cancel.md +2 -2
  33. package/messages/deploy.metadata.md +17 -17
  34. package/messages/deploy.metadata.preview.md +5 -5
  35. package/messages/deploy.metadata.report.md +6 -14
  36. package/messages/deploy.metadata.resume.md +6 -6
  37. package/messages/list.ignored.md +17 -5
  38. package/messages/manifest.generate.md +7 -5
  39. package/messages/retrieve.metadata.md +4 -4
  40. package/messages/retrieve.metadata.preview.md +4 -4
  41. package/oclif.manifest.json +48 -64
  42. package/package.json +3 -3
@@ -1,10 +1,10 @@
1
1
  {
2
- "version": "1.8.5-beta.6",
2
+ "version": "1.8.5-beta.8",
3
3
  "commands": {
4
4
  "deploy": {
5
5
  "id": "deploy",
6
6
  "summary": "Deploy a project interactively to any Salesforce environment.",
7
- "description": "This command must be run from within a project.\n\nThe command first analyzes your project, your active or logged-into environments, and local defaults to determine what to deploy and where to deploy it. The command then prompts you for information about this particular deployment and provides intelligent choices based on its analysis.\n\nFor example, if your local project contains a source directory with metadata files in source format, the command asks if you want to deploy that Salesforce app to an org. The command lists your connected orgs and asks which one you want to deploy to. The list of orgs starts with scratch orgs, ordered by expiration date with the most recently created one first, and then Dev Hub and production orgs ordered by name. If the command finds Apex tests, it asks if you want to run them and at which level.\n\nThe command stores your responses in the \"deploy-options.json\" file in your local project directory and uses them as defaults when you rerun the command. Specify --interactive to force the command to reprompt.\n\nUse this command for quick and simple deploys. For more complicated deployments, use the environment-specific commands, such as \"sf project deploy start\", that provide additional flags.",
7
+ "description": "This command must be run from within a project.\n\nThe command first analyzes your project, your active or logged-into environments, and local defaults to determine what to deploy and where to deploy it. The command then prompts you for information about this particular deployment and provides intelligent choices based on its analysis.\n\nFor example, if your local project contains a source directory with metadata files in source format, the command asks if you want to deploy that Salesforce app to an org. The command lists your connected orgs and asks which one you want to deploy to. The list of orgs starts with scratch orgs, ordered by expiration date with the most recently created one first, and then Dev Hub and production orgs ordered by name. If the command finds Apex tests, it asks if you want to run them and at which level.\n\nThe command stores your responses in the \"deploy-options.json\" file in your local project directory and uses them as defaults when you rerun the command. Specify --interactive to force the command to reprompt.\n\nUse this command for quick and simple deploys. For more complicated deployments, use the environment-specific commands, such as \"<%= config.bin %> project deploy start\", that provide additional flags.",
8
8
  "strict": true,
9
9
  "pluginName": "@salesforce/plugin-deploy-retrieve",
10
10
  "pluginAlias": "@salesforce/plugin-deploy-retrieve",
@@ -32,7 +32,7 @@
32
32
  "project:convert:mdapi": {
33
33
  "id": "project:convert:mdapi",
34
34
  "summary": "Convert metadata retrieved via Metadata API into the source format used in Salesforce DX projects.",
35
- "description": "To use Salesforce CLI to work with components that you retrieved via Metadata API, first convert your files from the metadata format to the source format using this command.\n\nTo convert files from the source format back to the metadata format, run \"<%= config.bin %> project convert source\".",
35
+ "description": "To use Salesforce CLI to work with components that you retrieved via Metadata API, first convert your files from the metadata format to the source format using this command.\n\nTo convert files from the source format back to the metadata format, run \"<%= config.bin %> project convert source\".\n\nTo convert 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.",
36
36
  "strict": true,
37
37
  "pluginName": "@salesforce/plugin-deploy-retrieve",
38
38
  "pluginAlias": "@salesforce/plugin-deploy-retrieve",
@@ -110,7 +110,7 @@
110
110
  "name": "metadata-dir",
111
111
  "type": "option",
112
112
  "char": "p",
113
- "summary": "Comma-separated list of paths to the local metadata files to convert.",
113
+ "summary": "Root of directory or zip file of metadata formatted files to convert.",
114
114
  "description": "The supplied paths can be to a single file (in which case the operation is applied to only one file) or to 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 flag, don’t specify --manifest or --metadata. If the comma-separated list you’re supplying contains spaces, enclose the entire comma-separated list in one set of double quotes.",
115
115
  "multiple": true,
116
116
  "exclusive": [
@@ -127,7 +127,7 @@
127
127
  "name": "metadata",
128
128
  "type": "option",
129
129
  "char": "m",
130
- "summary": "Comma-separated list of metadata component names to convert.",
130
+ "summary": "Metadata component names to convert.",
131
131
  "multiple": true,
132
132
  "exclusive": [
133
133
  "manifest",
@@ -143,7 +143,7 @@
143
143
  "project:convert:source": {
144
144
  "id": "project:convert:source",
145
145
  "summary": "Convert source-formatted files into metadata that you can deploy using Metadata API.",
146
- "description": "To convert source-formatted files into the metadata format, so that you can deploy them using Metadata API, run this command. Then deploy the metadata using \"<%= config.bin %> project deploy\".\n\nTo convert Metadata API–formatted files into the source format, run \"<%= config.bin %> project convert mdapi\".\n\nTo specify a package name that includes spaces, enclose the name in single quotes.",
146
+ "description": "To convert source-formatted files into the metadata format, so that you can deploy them using Metadata API, run this command. Then deploy the metadata using \"<%= config.bin %> project deploy\".\n\nTo convert Metadata API–formatted files into the source format, run \"<%= config.bin %> project convert mdapi\".\n\nTo specify a package name that includes spaces, enclose the name in single quotes.\n\nTo convert multiple 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.",
147
147
  "strict": true,
148
148
  "pluginName": "@salesforce/plugin-deploy-retrieve",
149
149
  "pluginAlias": "@salesforce/plugin-deploy-retrieve",
@@ -203,7 +203,7 @@
203
203
  "char": "d",
204
204
  "summary": "Output directory to store the Metadata API–formatted files in.",
205
205
  "multiple": false,
206
- "default": "metadataPackage_1679932843039",
206
+ "default": "metadataPackage_1680035676827",
207
207
  "deprecateAliases": true,
208
208
  "aliases": [
209
209
  "outputdir"
@@ -233,7 +233,7 @@
233
233
  "name": "source-dir",
234
234
  "type": "option",
235
235
  "char": "p",
236
- "summary": "Comma-separated list of paths to the local source files to convert.",
236
+ "summary": "Paths to the local source files to convert.",
237
237
  "description": "The supplied paths can be to a single file (in which case the operation is applied to only one file) or to 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 --manifest or --metadata.",
238
238
  "multiple": true,
239
239
  "exclusive": [
@@ -250,7 +250,7 @@
250
250
  "name": "metadata",
251
251
  "type": "option",
252
252
  "char": "m",
253
- "summary": "Comma-separated list of metadata component names to convert.",
253
+ "summary": "Metadata component names to convert.",
254
254
  "multiple": true,
255
255
  "exclusive": [
256
256
  "manifest",
@@ -266,7 +266,7 @@
266
266
  "project:delete:source": {
267
267
  "id": "project:delete:source",
268
268
  "summary": "Delete source from your project and from a non-source-tracked org.",
269
- "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.",
269
+ "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, \"<%= config.bin %> 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.",
270
270
  "strict": true,
271
271
  "pluginName": "@salesforce/plugin-deploy-retrieve",
272
272
  "pluginAlias": "@salesforce/plugin-deploy-retrieve",
@@ -382,7 +382,7 @@
382
382
  "name": "metadata",
383
383
  "type": "option",
384
384
  "char": "m",
385
- "summary": "Comma-separated list of names of metadata components to delete.",
385
+ "summary": "Metadata components to delete.",
386
386
  "description": "If you specify this parameter, don’t specify --source-dir.",
387
387
  "multiple": true,
388
388
  "deprecateAliases": true,
@@ -392,7 +392,7 @@
392
392
  "name": "source-dir",
393
393
  "type": "option",
394
394
  "char": "p",
395
- "summary": "Comma-separated list of source file paths to delete.",
395
+ "summary": "Source file paths to delete.",
396
396
  "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.",
397
397
  "multiple": true,
398
398
  "deprecateAliases": true,
@@ -541,7 +541,7 @@
541
541
  "name": "async",
542
542
  "type": "boolean",
543
543
  "summary": "Run the command asynchronously.",
544
- "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 \"<%= config.bin %> project deploy report\".",
544
+ "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 \"<%= config.bin %> project deploy resume\". To check the status of the cancellation, run \"<%= config.bin %> project deploy report\".",
545
545
  "allowNo": false,
546
546
  "exclusive": [
547
547
  "wait"
@@ -571,7 +571,7 @@
571
571
  "type": "option",
572
572
  "char": "w",
573
573
  "summary": "Number of minutes to wait for the command to complete and display results.",
574
- "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 \"<%= config.bin %> project deploy report\".",
574
+ "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 \"<%= config.bin %> project deploy resume\". To check the status of the cancellation, run \"<%= config.bin %> project deploy report\".",
575
575
  "helpValue": "<minutes>",
576
576
  "multiple": false,
577
577
  "exclusive": [
@@ -596,8 +596,8 @@
596
596
  ],
597
597
  "examples": [
598
598
  "NOTE: The commands to preview a deployment and actually deploy it use similar flags. We provide a few preview examples here, but see the help for \"<%= config.bin %> project deploy start\" for more examples that you can adapt for previewing.",
599
- "Preview the deployment of source files in a directory, such as force-app:\n<%= config.bin %> <%= command.id %> --source-dir force-app",
600
- "Preview the deployment of all Apex classes:\n<%= config.bin %> <%= command.id %> --metadata ApexClass",
599
+ "Preview the deployment of source files in a directory, such as force-app, to your default org:\n<%= config.bin %> <%= command.id %> --source-dir force-app",
600
+ "Preview the deployment of all Apex classes to an org with alias \"my-scratch\":\n<%= config.bin %> <%= command.id %> --metadata ApexClass --target-org my-scratch",
601
601
  "Preview deployment of a specific Apex class:\n<%= config.bin %> <%= command.id %> --metadata ApexClass:MyApexClass",
602
602
  "Preview deployment of all components listed in a manifest:\n<%= config.bin %> <%= command.id %> --manifest path/to/package.xml"
603
603
  ],
@@ -615,7 +615,7 @@
615
615
  "name": "ignore-conflicts",
616
616
  "type": "boolean",
617
617
  "char": "c",
618
- "summary": "Ignore conflicts and deploy local files, even if they overwrite changes in the org.",
618
+ "summary": "Don't display conflicts in preview of the deployment.",
619
619
  "description": "This flag applies only to orgs that allow source tracking. It has no effect on orgs that don't allow it, such as production orgs.",
620
620
  "allowNo": false,
621
621
  "deprecateAliases": true
@@ -845,22 +845,6 @@
845
845
  "allowNo": false,
846
846
  "deprecateAliases": true
847
847
  },
848
- "target-org": {
849
- "name": "target-org",
850
- "type": "option",
851
- "char": "o",
852
- "summary": "Login username or alias for the target org.",
853
- "required": true,
854
- "multiple": false,
855
- "deprecateAliases": true
856
- },
857
- "api-version": {
858
- "name": "api-version",
859
- "type": "option",
860
- "description": "Override the api version used for api requests made by this command",
861
- "multiple": false,
862
- "deprecateAliases": true
863
- },
864
848
  "job-id": {
865
849
  "name": "job-id",
866
850
  "type": "option",
@@ -882,7 +866,7 @@
882
866
  "coverage-formatters": {
883
867
  "name": "coverage-formatters",
884
868
  "type": "option",
885
- "summary": "format of the code coverage results",
869
+ "summary": "Format of the code coverage results",
886
870
  "helpValue": "clover,cobertura,html-spa,html,json,json-summary,lcovonly,none,teamcity,text,text-summary",
887
871
  "multiple": true,
888
872
  "options": [
@@ -903,14 +887,14 @@
903
887
  "junit": {
904
888
  "name": "junit",
905
889
  "type": "boolean",
906
- "summary": "output JUnit test results",
890
+ "summary": "Output JUnit test results.",
907
891
  "allowNo": false,
908
892
  "deprecateAliases": true
909
893
  },
910
894
  "results-dir": {
911
895
  "name": "results-dir",
912
896
  "type": "option",
913
- "summary": "output directory for code coverage and JUnit results; defaults to the deploy ID",
897
+ "summary": "Output directory for code coverage and JUnit results; defaults to the deploy ID.",
914
898
  "multiple": false,
915
899
  "dependsOn": [
916
900
  "junit",
@@ -920,8 +904,7 @@
920
904
  }
921
905
  },
922
906
  "args": {},
923
- "requiresProject": true,
924
- "hasDynamicHelp": true
907
+ "requiresProject": true
925
908
  },
926
909
  "project:deploy:resume": {
927
910
  "id": "project:deploy:resume",
@@ -999,7 +982,7 @@
999
982
  "coverage-formatters": {
1000
983
  "name": "coverage-formatters",
1001
984
  "type": "option",
1002
- "summary": "format of the code coverage results",
985
+ "summary": "Format of the code coverage results.",
1003
986
  "helpValue": "clover,cobertura,html-spa,html,json,json-summary,lcovonly,none,teamcity,text,text-summary",
1004
987
  "multiple": true,
1005
988
  "options": [
@@ -1020,14 +1003,14 @@
1020
1003
  "junit": {
1021
1004
  "name": "junit",
1022
1005
  "type": "boolean",
1023
- "summary": "output JUnit test results",
1006
+ "summary": "Output JUnit test results.",
1024
1007
  "allowNo": false,
1025
1008
  "deprecateAliases": true
1026
1009
  },
1027
1010
  "results-dir": {
1028
1011
  "name": "results-dir",
1029
1012
  "type": "option",
1030
- "summary": "output directory for code coverage and JUnit results; defaults to the deploy ID",
1013
+ "summary": "Output directory for code coverage and JUnit results; defaults to the deploy ID.",
1031
1014
  "multiple": false,
1032
1015
  "dependsOn": [
1033
1016
  "junit",
@@ -1126,7 +1109,7 @@
1126
1109
  "name": "async",
1127
1110
  "type": "boolean",
1128
1111
  "summary": "Run the command asynchronously.",
1129
- "description": "The command immediately returns the job ID and control of the terminal to you. This way, you can continue to use the CLI. To resume the deployment, run \"sf project deploy resume\". To check the status of the deployment, run \"sf project deploy report\".",
1112
+ "description": "The command immediately returns the job ID and control of the terminal to you. This way, you can continue to use the CLI. To resume the deployment, run \"<%= config.bin %> project deploy resume\". To check the status of the deployment, run \"<%= config.bin %> project deploy report\".",
1130
1113
  "allowNo": false,
1131
1114
  "exclusive": [
1132
1115
  "wait"
@@ -1290,7 +1273,7 @@
1290
1273
  "type": "option",
1291
1274
  "char": "w",
1292
1275
  "summary": "Number of minutes to wait for command to complete and display results.",
1293
- "description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you and returns the job ID. To resume the deployment, run \"sf project deploy resume\". To check the status of the deployment, run \"sf project deploy report\".",
1276
+ "description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you and returns the job ID. To resume the deployment, run \"<%= config.bin %> project deploy resume\". To check the status of the deployment, run \"<%= config.bin %> project deploy report\".",
1294
1277
  "helpValue": "<minutes>",
1295
1278
  "multiple": false,
1296
1279
  "exclusive": [
@@ -1301,7 +1284,7 @@
1301
1284
  "purge-on-delete": {
1302
1285
  "name": "purge-on-delete",
1303
1286
  "type": "boolean",
1304
- "summary": "specify that deleted components in the destructive changes manifest file are immediately eligible for deletion rather than being stored in the Recycle Bin",
1287
+ "summary": "Specify that deleted components in the destructive changes manifest file are immediately eligible for deletion rather than being stored in the Recycle Bin.",
1305
1288
  "allowNo": false,
1306
1289
  "dependsOn": [
1307
1290
  "manifest"
@@ -1320,7 +1303,7 @@
1320
1303
  "pre-destructive-changes": {
1321
1304
  "name": "pre-destructive-changes",
1322
1305
  "type": "option",
1323
- "summary": "file path for a manifest (destructiveChangesPre.xml) of components to delete before the deploy",
1306
+ "summary": "File path for a manifest (destructiveChangesPre.xml) of components to delete before the deploy",
1324
1307
  "multiple": false,
1325
1308
  "dependsOn": [
1326
1309
  "manifest"
@@ -1330,7 +1313,7 @@
1330
1313
  "post-destructive-changes": {
1331
1314
  "name": "post-destructive-changes",
1332
1315
  "type": "option",
1333
- "summary": "file path for a manifest (destructiveChangesPost.xml) of components to delete after the deploy",
1316
+ "summary": "File path for a manifest (destructiveChangesPost.xml) of components to delete after the deploy.",
1334
1317
  "multiple": false,
1335
1318
  "dependsOn": [
1336
1319
  "manifest"
@@ -1340,7 +1323,7 @@
1340
1323
  "coverage-formatters": {
1341
1324
  "name": "coverage-formatters",
1342
1325
  "type": "option",
1343
- "summary": "format of the code coverage results",
1326
+ "summary": "Format of the code coverage results.",
1344
1327
  "helpValue": "clover,cobertura,html-spa,html,json,json-summary,lcovonly,none,teamcity,text,text-summary",
1345
1328
  "multiple": true,
1346
1329
  "options": [
@@ -1361,7 +1344,7 @@
1361
1344
  "junit": {
1362
1345
  "name": "junit",
1363
1346
  "type": "boolean",
1364
- "summary": "output JUnit test results",
1347
+ "summary": "Output JUnit test results.",
1365
1348
  "allowNo": false,
1366
1349
  "dependsOn": [
1367
1350
  "coverage-formatters"
@@ -1371,7 +1354,7 @@
1371
1354
  "results-dir": {
1372
1355
  "name": "results-dir",
1373
1356
  "type": "option",
1374
- "summary": "output directory for code coverage and JUnit results; defaults to the deploy ID",
1357
+ "summary": "Output directory for code coverage and JUnit results; defaults to the deploy ID.",
1375
1358
  "multiple": false,
1376
1359
  "dependsOn": [
1377
1360
  "coverage-formatters"
@@ -1659,7 +1642,7 @@
1659
1642
  "project:generate:manifest": {
1660
1643
  "id": "project:generate:manifest",
1661
1644
  "summary": "Create a project manifest that lists the metadata components you want to deploy or retrieve.",
1662
- "description": "Create a manifest from a list of metadata components (--metadata) or from one or more local directories that contain source files (--source-dir). You can specify either of these parameters, not both.\n\nUse --type to specify the type of manifest you want to create. The resulting manifest files have specific names, such as the standard package.xml or destructiveChanges.xml to delete metadata. Valid values for this parameter, and their respective file names, are:\n\n * package : package.xml (default)\n * pre : destructiveChangesPre.xml\n * post : destructiveChangesPost.xml\n * destroy : destructiveChanges.xml\n\nSee https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy_deleting_files.htm for information about these destructive manifest files.\n\nUse --name to specify a custom name for the generated manifest if the pre-defined ones don’t suit your needs. You can specify either --type or --name, but not both.",
1645
+ "description": "Create a manifest from a list of metadata components (--metadata) or from one or more local directories that contain source files (--source-dir). You can specify either of these parameters, not both.\n\nUse --type to specify the type of manifest you want to create. The resulting manifest files have specific names, such as the standard package.xml or destructiveChanges.xml to delete metadata. Valid values for this parameter, and their respective file names, are:\n\n * package : package.xml (default)\n * pre : destructiveChangesPre.xml\n * post : destructiveChangesPost.xml\n * destroy : destructiveChanges.xml\n\nSee https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy_deleting_files.htm for information about these destructive manifest files.\n\nUse --name to specify a custom name for the generated manifest if the pre-defined ones don’t suit your needs. You can specify either --type or --name, but not both.\n\nTo include 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 --include-packages and --source-dir.",
1663
1646
  "strict": true,
1664
1647
  "pluginName": "@salesforce/plugin-deploy-retrieve",
1665
1648
  "pluginAlias": "@salesforce/plugin-deploy-retrieve",
@@ -1668,7 +1651,7 @@
1668
1651
  "force:source:manifest:create"
1669
1652
  ],
1670
1653
  "examples": [
1671
- "Create a manifest for deploying or retrieving all Apex classes:\n$ <%= config.bin %> <%= command.id %> --metadata ApexClass",
1654
+ "Create a manifest for deploying or retrieving all Apex classes and custom objects:\n$ <%= config.bin %> <%= command.id %> --metadata ApexClass --metadata CustomObject",
1672
1655
  "Create a manifest for deleting the specified Apex class:\n$ <%= config.bin %> <%= command.id %> --metadata ApexClass:MyApexClass --type destroy",
1673
1656
  "Create a manifest for deploying or retrieving all the metadata components in the specified local directory; name the file myNewManifest.xml:\n$ <%= config.bin %> <%= command.id %> --source-dir force-app --name myNewManifest",
1674
1657
  "Create a manifest from the metadata components in the specified org and include metadata in any unlocked packages:\n$ <%= config.bin %> <%= command.id %> --from-org test@myorg.com --include-packages unlocked"
@@ -1707,7 +1690,7 @@
1707
1690
  "name": "metadata",
1708
1691
  "type": "option",
1709
1692
  "char": "m",
1710
- "summary": "Comma-separated list of names of metadata components to include in the manifest.",
1693
+ "summary": "Names of metadata components to include in the manifest.",
1711
1694
  "multiple": true,
1712
1695
  "deprecateAliases": true,
1713
1696
  "delimiter": ","
@@ -1716,7 +1699,7 @@
1716
1699
  "name": "source-dir",
1717
1700
  "type": "option",
1718
1701
  "char": "p",
1719
- "summary": "Comma-separated list of paths to the local source files to include in the manifest.",
1702
+ "summary": "Paths to the local source files to include in the manifest.",
1720
1703
  "multiple": true,
1721
1704
  "deprecateAliases": true,
1722
1705
  "aliases": [
@@ -1762,7 +1745,7 @@
1762
1745
  "name": "include-packages",
1763
1746
  "type": "option",
1764
1747
  "char": "c",
1765
- "summary": "Comma-separated list of package types (managed, unlocked) whose metadata is included in the manifest; by default, metadata in packages is ignored.",
1748
+ "summary": "Package types (managed, unlocked) whose metadata is included in the manifest; by default, metadata in packages is ignored.",
1766
1749
  "multiple": true,
1767
1750
  "options": [
1768
1751
  "managed",
@@ -1805,8 +1788,8 @@
1805
1788
  },
1806
1789
  "project:list:ignored": {
1807
1790
  "id": "project:list:ignored",
1808
- "summary": "check your local project package directories for forceignored files",
1809
- "description": "check your local project package directories for forceignored files",
1791
+ "summary": "Check your local project package directories for forceignored files.",
1792
+ "description": "When deploying or retrieving metadata between your local project and an org, you can specify the source files you want to exclude with a .forceignore file. The .forceignore file structure mimics the .gitignore structure. Each line in .forceignore specifies a pattern that corresponds to one or more files. The files typically represent metadata components, but can be any files you want to exclude, such as LWC configuration JSON files or tests.",
1810
1793
  "strict": true,
1811
1794
  "pluginName": "@salesforce/plugin-deploy-retrieve",
1812
1795
  "pluginAlias": "@salesforce/plugin-deploy-retrieve",
@@ -1815,8 +1798,9 @@
1815
1798
  "force:source:ignored:list"
1816
1799
  ],
1817
1800
  "examples": [
1818
- "$ <%= config.bin %> <%= command.id %>",
1819
- "$ <%= config.bin %> <%= command.id %> --source-dir force-app"
1801
+ "List all the files in all package directories that are ignored:\n<%= config.bin %> <%= command.id %>",
1802
+ "List all the files in a specific directory that are ignored:\n<%= config.bin %> <%= command.id %> --source-dir force-app",
1803
+ "Check if a particular file is ignored:\n<%= config.bin %> <%= command.id %> --source-dir package.xml"
1820
1804
  ],
1821
1805
  "deprecateAliases": true,
1822
1806
  "flags": {
@@ -1832,7 +1816,7 @@
1832
1816
  "name": "source-dir",
1833
1817
  "type": "option",
1834
1818
  "char": "p",
1835
- "summary": "file or directory of files that the command checks for foreceignored files",
1819
+ "summary": "File or directory of files that the command checks for foreceignored files.",
1836
1820
  "multiple": false,
1837
1821
  "deprecateAliases": true,
1838
1822
  "aliases": [
@@ -1934,8 +1918,8 @@
1934
1918
  "retrieve:metadata:preview"
1935
1919
  ],
1936
1920
  "examples": [
1937
- "Preview the retrieve of all changes from the org:\n<%= config.bin %> <%= command.id %>",
1938
- "Preview the retrieve when ignoring any conflicts:\n<%= config.bin %> <%= command.id %> --ignore-conflicts"
1921
+ "Preview the retrieve of all changes from your default org:\n<%= config.bin %> <%= command.id %>",
1922
+ "Preview the retrieve when ignoring any conflicts from an org with alias \"my-scratch\":\n<%= config.bin %> <%= command.id %> --ignore-conflicts --target-org my-scratch"
1939
1923
  ],
1940
1924
  "deprecateAliases": true,
1941
1925
  "flags": {
@@ -1951,7 +1935,7 @@
1951
1935
  "name": "ignore-conflicts",
1952
1936
  "type": "boolean",
1953
1937
  "char": "c",
1954
- "summary": "Ignore conflicts and preview the retrieve of remote components, even if they will overwrite local changes.",
1938
+ "summary": "Don't display conflicts in the preview of the retrieval.",
1955
1939
  "description": "This flag applies only to orgs that allow source tracking. It has no effect on orgs that don't allow it, such as production orgs.",
1956
1940
  "allowNo": false,
1957
1941
  "deprecateAliases": true
@@ -1983,8 +1967,8 @@
1983
1967
  "retrieve:metadata"
1984
1968
  ],
1985
1969
  "examples": [
1986
- "Retrieve remote changes:\n<%= config.bin %> <%= command.id %>",
1987
- "Retrieve the source files in a directory:\n<%= config.bin %> <%= command.id %> --source-dir path/to/source",
1970
+ "Retrieve remote changes from your default org:\n<%= config.bin %> <%= command.id %>",
1971
+ "Retrieve the source files in a directory from an org with alias \"my-scratch\":\n<%= config.bin %> <%= command.id %> --source-dir path/to/source --target-org my-scratch",
1988
1972
  "Retrieve a specific Apex class and the objects whose source is in a directory (both examples are equivalent):\n<%= config.bin %> <%= command.id %> --source-dir path/to/apex/classes/MyClass.cls path/to/source/objects\n<%= config.bin %> <%= command.id %> --source-dir path/to/apex/classes/MyClass.cls --source-dir path/to/source/objects",
1989
1973
  "Retrieve all Apex classes:\n<%= config.bin %> <%= command.id %> --metadata ApexClass",
1990
1974
  "Retrieve a specific Apex class:\n<%= config.bin %> <%= command.id %> --metadata ApexClass:MyApexClass",
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@salesforce/plugin-deploy-retrieve",
3
3
  "description": "deploy and retrieve commands for sf",
4
- "version": "1.8.5-beta.6",
4
+ "version": "1.8.5-beta.8",
5
5
  "author": "Salesforce",
6
6
  "bugs": "https://github.com/forcedotcom/cli/issues",
7
7
  "dependencies": {
@@ -270,7 +270,7 @@
270
270
  }
271
271
  },
272
272
  "sfdx": {
273
- "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-deploy-retrieve/1.8.5-beta.6.crt",
274
- "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-deploy-retrieve/1.8.5-beta.6.sig"
273
+ "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-deploy-retrieve/1.8.5-beta.8.crt",
274
+ "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-deploy-retrieve/1.8.5-beta.8.sig"
275
275
  }
276
276
  }