@salesforce/plugin-deploy-retrieve 1.8.5-beta.7 → 1.8.5-beta.9

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 (45) hide show
  1. package/lib/commands/project/deploy/cancel.js +4 -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.js +3 -4
  6. package/lib/commands/project/deploy/report.js.map +1 -1
  7. package/lib/commands/project/deploy/resume.js +4 -5
  8. package/lib/commands/project/deploy/resume.js.map +1 -1
  9. package/lib/commands/project/deploy/start.js +20 -11
  10. package/lib/commands/project/deploy/start.js.map +1 -1
  11. package/lib/commands/project/deploy/validate.js +2 -2
  12. package/lib/commands/project/deploy/validate.js.map +1 -1
  13. package/lib/commands/project/list/ignored.js +2 -2
  14. package/lib/commands/project/list/ignored.js.map +1 -1
  15. package/lib/commands/project/retrieve/start.js +1 -1
  16. package/lib/commands/project/retrieve/start.js.map +1 -1
  17. package/lib/formatters/asyncDeployCancelResultFormatter.d.ts +2 -1
  18. package/lib/formatters/asyncDeployCancelResultFormatter.js +4 -3
  19. package/lib/formatters/asyncDeployCancelResultFormatter.js.map +1 -1
  20. package/lib/formatters/asyncDeployResultFormatter.d.ts +2 -1
  21. package/lib/formatters/asyncDeployResultFormatter.js +5 -4
  22. package/lib/formatters/asyncDeployResultFormatter.js.map +1 -1
  23. package/lib/formatters/deployResultFormatter.js +1 -1
  24. package/lib/formatters/deployResultFormatter.js.map +1 -1
  25. package/lib/utils/deploy.d.ts +1 -1
  26. package/lib/utils/deploy.js +2 -2
  27. package/lib/utils/deploy.js.map +1 -1
  28. package/lib/utils/manifestCache.js +7 -1
  29. package/lib/utils/manifestCache.js.map +1 -1
  30. package/messages/convert.mdapi.md +4 -2
  31. package/messages/convert.source.md +4 -2
  32. package/messages/delete.source.md +5 -3
  33. package/messages/deploy.async.md +3 -3
  34. package/messages/deploy.md +1 -1
  35. package/messages/deploy.metadata.cancel.md +2 -2
  36. package/messages/deploy.metadata.md +21 -17
  37. package/messages/deploy.metadata.preview.md +5 -5
  38. package/messages/deploy.metadata.report.md +6 -6
  39. package/messages/deploy.metadata.resume.md +6 -6
  40. package/messages/list.ignored.md +17 -5
  41. package/messages/manifest.generate.md +7 -5
  42. package/messages/retrieve.metadata.md +4 -4
  43. package/messages/retrieve.metadata.preview.md +4 -4
  44. package/oclif.manifest.json +47 -49
  45. package/package.json +3 -3
@@ -1,10 +1,10 @@
1
1
  {
2
- "version": "1.8.5-beta.7",
2
+ "version": "1.8.5-beta.9",
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_1680031466306",
206
+ "default": "metadataPackage_1680099170456",
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
@@ -866,8 +866,7 @@
866
866
  "coverage-formatters": {
867
867
  "name": "coverage-formatters",
868
868
  "type": "option",
869
- "summary": "format of the code coverage results",
870
- "helpValue": "clover,cobertura,html-spa,html,json,json-summary,lcovonly,none,teamcity,text,text-summary",
869
+ "summary": "Format of the code coverage results",
871
870
  "multiple": true,
872
871
  "options": [
873
872
  "clover",
@@ -887,14 +886,14 @@
887
886
  "junit": {
888
887
  "name": "junit",
889
888
  "type": "boolean",
890
- "summary": "output JUnit test results",
889
+ "summary": "Output JUnit test results.",
891
890
  "allowNo": false,
892
891
  "deprecateAliases": true
893
892
  },
894
893
  "results-dir": {
895
894
  "name": "results-dir",
896
895
  "type": "option",
897
- "summary": "output directory for code coverage and JUnit results; defaults to the deploy ID",
896
+ "summary": "Output directory for code coverage and JUnit results; defaults to the deploy ID.",
898
897
  "multiple": false,
899
898
  "dependsOn": [
900
899
  "junit",
@@ -982,8 +981,7 @@
982
981
  "coverage-formatters": {
983
982
  "name": "coverage-formatters",
984
983
  "type": "option",
985
- "summary": "format of the code coverage results",
986
- "helpValue": "clover,cobertura,html-spa,html,json,json-summary,lcovonly,none,teamcity,text,text-summary",
984
+ "summary": "Format of the code coverage results.",
987
985
  "multiple": true,
988
986
  "options": [
989
987
  "clover",
@@ -1003,14 +1001,14 @@
1003
1001
  "junit": {
1004
1002
  "name": "junit",
1005
1003
  "type": "boolean",
1006
- "summary": "output JUnit test results",
1004
+ "summary": "Output JUnit test results.",
1007
1005
  "allowNo": false,
1008
1006
  "deprecateAliases": true
1009
1007
  },
1010
1008
  "results-dir": {
1011
1009
  "name": "results-dir",
1012
1010
  "type": "option",
1013
- "summary": "output directory for code coverage and JUnit results; defaults to the deploy ID",
1011
+ "summary": "Output directory for code coverage and JUnit results; defaults to the deploy ID.",
1014
1012
  "multiple": false,
1015
1013
  "dependsOn": [
1016
1014
  "junit",
@@ -1109,7 +1107,7 @@
1109
1107
  "name": "async",
1110
1108
  "type": "boolean",
1111
1109
  "summary": "Run the command asynchronously.",
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 \"sf project deploy resume\". To check the status of the deployment, run \"sf project deploy report\".",
1110
+ "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\".",
1113
1111
  "allowNo": false,
1114
1112
  "exclusive": [
1115
1113
  "wait"
@@ -1273,7 +1271,7 @@
1273
1271
  "type": "option",
1274
1272
  "char": "w",
1275
1273
  "summary": "Number of minutes to wait for command to complete and display results.",
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 \"sf project deploy resume\". To check the status of the deployment, run \"sf project deploy report\".",
1274
+ "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\".",
1277
1275
  "helpValue": "<minutes>",
1278
1276
  "multiple": false,
1279
1277
  "exclusive": [
@@ -1284,7 +1282,7 @@
1284
1282
  "purge-on-delete": {
1285
1283
  "name": "purge-on-delete",
1286
1284
  "type": "boolean",
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",
1285
+ "summary": "Specify that deleted components in the destructive changes manifest file are immediately eligible for deletion rather than being stored in the Recycle Bin.",
1288
1286
  "allowNo": false,
1289
1287
  "dependsOn": [
1290
1288
  "manifest"
@@ -1303,7 +1301,7 @@
1303
1301
  "pre-destructive-changes": {
1304
1302
  "name": "pre-destructive-changes",
1305
1303
  "type": "option",
1306
- "summary": "file path for a manifest (destructiveChangesPre.xml) of components to delete before the deploy",
1304
+ "summary": "File path for a manifest (destructiveChangesPre.xml) of components to delete before the deploy",
1307
1305
  "multiple": false,
1308
1306
  "dependsOn": [
1309
1307
  "manifest"
@@ -1313,7 +1311,7 @@
1313
1311
  "post-destructive-changes": {
1314
1312
  "name": "post-destructive-changes",
1315
1313
  "type": "option",
1316
- "summary": "file path for a manifest (destructiveChangesPost.xml) of components to delete after the deploy",
1314
+ "summary": "File path for a manifest (destructiveChangesPost.xml) of components to delete after the deploy.",
1317
1315
  "multiple": false,
1318
1316
  "dependsOn": [
1319
1317
  "manifest"
@@ -1323,8 +1321,7 @@
1323
1321
  "coverage-formatters": {
1324
1322
  "name": "coverage-formatters",
1325
1323
  "type": "option",
1326
- "summary": "format of the code coverage results",
1327
- "helpValue": "clover,cobertura,html-spa,html,json,json-summary,lcovonly,none,teamcity,text,text-summary",
1324
+ "summary": "Format of the code coverage results.",
1328
1325
  "multiple": true,
1329
1326
  "options": [
1330
1327
  "clover",
@@ -1344,7 +1341,7 @@
1344
1341
  "junit": {
1345
1342
  "name": "junit",
1346
1343
  "type": "boolean",
1347
- "summary": "output JUnit test results",
1344
+ "summary": "Output JUnit test results.",
1348
1345
  "allowNo": false,
1349
1346
  "dependsOn": [
1350
1347
  "coverage-formatters"
@@ -1354,7 +1351,7 @@
1354
1351
  "results-dir": {
1355
1352
  "name": "results-dir",
1356
1353
  "type": "option",
1357
- "summary": "output directory for code coverage and JUnit results; defaults to the deploy ID",
1354
+ "summary": "Output directory for code coverage and JUnit results; defaults to the deploy ID.",
1358
1355
  "multiple": false,
1359
1356
  "dependsOn": [
1360
1357
  "coverage-formatters"
@@ -1642,7 +1639,7 @@
1642
1639
  "project:generate:manifest": {
1643
1640
  "id": "project:generate:manifest",
1644
1641
  "summary": "Create a project manifest that lists the metadata components you want to deploy or retrieve.",
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.",
1642
+ "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.",
1646
1643
  "strict": true,
1647
1644
  "pluginName": "@salesforce/plugin-deploy-retrieve",
1648
1645
  "pluginAlias": "@salesforce/plugin-deploy-retrieve",
@@ -1651,7 +1648,7 @@
1651
1648
  "force:source:manifest:create"
1652
1649
  ],
1653
1650
  "examples": [
1654
- "Create a manifest for deploying or retrieving all Apex classes:\n$ <%= config.bin %> <%= command.id %> --metadata ApexClass",
1651
+ "Create a manifest for deploying or retrieving all Apex classes and custom objects:\n$ <%= config.bin %> <%= command.id %> --metadata ApexClass --metadata CustomObject",
1655
1652
  "Create a manifest for deleting the specified Apex class:\n$ <%= config.bin %> <%= command.id %> --metadata ApexClass:MyApexClass --type destroy",
1656
1653
  "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",
1657
1654
  "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"
@@ -1690,7 +1687,7 @@
1690
1687
  "name": "metadata",
1691
1688
  "type": "option",
1692
1689
  "char": "m",
1693
- "summary": "Comma-separated list of names of metadata components to include in the manifest.",
1690
+ "summary": "Names of metadata components to include in the manifest.",
1694
1691
  "multiple": true,
1695
1692
  "deprecateAliases": true,
1696
1693
  "delimiter": ","
@@ -1699,7 +1696,7 @@
1699
1696
  "name": "source-dir",
1700
1697
  "type": "option",
1701
1698
  "char": "p",
1702
- "summary": "Comma-separated list of paths to the local source files to include in the manifest.",
1699
+ "summary": "Paths to the local source files to include in the manifest.",
1703
1700
  "multiple": true,
1704
1701
  "deprecateAliases": true,
1705
1702
  "aliases": [
@@ -1745,7 +1742,7 @@
1745
1742
  "name": "include-packages",
1746
1743
  "type": "option",
1747
1744
  "char": "c",
1748
- "summary": "Comma-separated list of package types (managed, unlocked) whose metadata is included in the manifest; by default, metadata in packages is ignored.",
1745
+ "summary": "Package types (managed, unlocked) whose metadata is included in the manifest; by default, metadata in packages is ignored.",
1749
1746
  "multiple": true,
1750
1747
  "options": [
1751
1748
  "managed",
@@ -1788,8 +1785,8 @@
1788
1785
  },
1789
1786
  "project:list:ignored": {
1790
1787
  "id": "project:list:ignored",
1791
- "summary": "check your local project package directories for forceignored files",
1792
- "description": "check your local project package directories for forceignored files",
1788
+ "summary": "Check your local project package directories for forceignored files.",
1789
+ "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.",
1793
1790
  "strict": true,
1794
1791
  "pluginName": "@salesforce/plugin-deploy-retrieve",
1795
1792
  "pluginAlias": "@salesforce/plugin-deploy-retrieve",
@@ -1798,8 +1795,9 @@
1798
1795
  "force:source:ignored:list"
1799
1796
  ],
1800
1797
  "examples": [
1801
- "$ <%= config.bin %> <%= command.id %>",
1802
- "$ <%= config.bin %> <%= command.id %> --source-dir force-app"
1798
+ "List all the files in all package directories that are ignored:\n<%= config.bin %> <%= command.id %>",
1799
+ "List all the files in a specific directory that are ignored:\n<%= config.bin %> <%= command.id %> --source-dir force-app",
1800
+ "Check if a particular file is ignored:\n<%= config.bin %> <%= command.id %> --source-dir package.xml"
1803
1801
  ],
1804
1802
  "deprecateAliases": true,
1805
1803
  "flags": {
@@ -1815,7 +1813,7 @@
1815
1813
  "name": "source-dir",
1816
1814
  "type": "option",
1817
1815
  "char": "p",
1818
- "summary": "file or directory of files that the command checks for foreceignored files",
1816
+ "summary": "File or directory of files that the command checks for foreceignored files.",
1819
1817
  "multiple": false,
1820
1818
  "deprecateAliases": true,
1821
1819
  "aliases": [
@@ -1917,8 +1915,8 @@
1917
1915
  "retrieve:metadata:preview"
1918
1916
  ],
1919
1917
  "examples": [
1920
- "Preview the retrieve of all changes from the org:\n<%= config.bin %> <%= command.id %>",
1921
- "Preview the retrieve when ignoring any conflicts:\n<%= config.bin %> <%= command.id %> --ignore-conflicts"
1918
+ "Preview the retrieve of all changes from your default org:\n<%= config.bin %> <%= command.id %>",
1919
+ "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"
1922
1920
  ],
1923
1921
  "deprecateAliases": true,
1924
1922
  "flags": {
@@ -1934,7 +1932,7 @@
1934
1932
  "name": "ignore-conflicts",
1935
1933
  "type": "boolean",
1936
1934
  "char": "c",
1937
- "summary": "Ignore conflicts and preview the retrieve of remote components, even if they will overwrite local changes.",
1935
+ "summary": "Don't display conflicts in the preview of the retrieval.",
1938
1936
  "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.",
1939
1937
  "allowNo": false,
1940
1938
  "deprecateAliases": true
@@ -1966,8 +1964,8 @@
1966
1964
  "retrieve:metadata"
1967
1965
  ],
1968
1966
  "examples": [
1969
- "Retrieve remote changes:\n<%= config.bin %> <%= command.id %>",
1970
- "Retrieve the source files in a directory:\n<%= config.bin %> <%= command.id %> --source-dir path/to/source",
1967
+ "Retrieve remote changes from your default org:\n<%= config.bin %> <%= command.id %>",
1968
+ "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",
1971
1969
  "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",
1972
1970
  "Retrieve all Apex classes:\n<%= config.bin %> <%= command.id %> --metadata ApexClass",
1973
1971
  "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.7",
4
+ "version": "1.8.5-beta.9",
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.7.crt",
274
- "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-deploy-retrieve/1.8.5-beta.7.sig"
273
+ "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-deploy-retrieve/1.8.5-beta.9.crt",
274
+ "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-deploy-retrieve/1.8.5-beta.9.sig"
275
275
  }
276
276
  }