@salesforce/plugin-deploy-retrieve 1.8.5-beta.3 → 1.8.5-beta.4

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.
@@ -1,5 +1,5 @@
1
1
  {
2
- "version": "1.8.5-beta.3",
2
+ "version": "1.8.5-beta.4",
3
3
  "commands": {
4
4
  "deploy": {
5
5
  "id": "deploy",
@@ -31,8 +31,8 @@
31
31
  },
32
32
  "project:convert:mdapi": {
33
33
  "id": "project:convert:mdapi",
34
- "summary": "convert metadata from the Metadata API format into the source format",
35
- "description": "Converts metadata retrieved via Metadata API into the source format used in Salesforce DX projects.\n\nTo 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 \"sfdx force:mdapi:convert\".\n\nTo convert files from the source format back to the metadata format, so that you can deploy them using \"<%= config.bin %> project deploy\", run \"<%= config.bin %> project convert source\".",
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\".",
36
36
  "strict": true,
37
37
  "pluginName": "@salesforce/plugin-deploy-retrieve",
38
38
  "pluginAlias": "@salesforce/plugin-deploy-retrieve",
@@ -42,8 +42,8 @@
42
42
  "force:mdapi:convert"
43
43
  ],
44
44
  "examples": [
45
- "$ <%= config.bin %> <%= command.id %> -r path/to/metadata",
46
- "$ <%= config.bin %> <%= command.id %> -r path/to/metadata -d path/to/outputdir"
45
+ "Convert metadata formatted files in the specified directory into source formatted files; writes converted files to your default package directory:\n$ <%= config.bin %> <%= command.id %> --root-dir path/to/metadata",
46
+ "Similar to previous example, but writes converted files to the specified output directory:\n$ <%= config.bin %> <%= command.id %> --root-dir path/to/metadata --output-dir path/to/outputdir"
47
47
  ],
48
48
  "deprecateAliases": true,
49
49
  "flags": {
@@ -79,8 +79,7 @@
79
79
  "name": "root-dir",
80
80
  "type": "option",
81
81
  "char": "r",
82
- "summary": "the root directory containing the Metadata API–formatted metadata",
83
- "description": "The root directory that contains the metadata you retrieved using Metadata API.",
82
+ "summary": "Root directory that contains the Metadata API–formatted metadata.",
84
83
  "required": true,
85
84
  "multiple": false,
86
85
  "deprecateAliases": true,
@@ -92,8 +91,7 @@
92
91
  "name": "output-dir",
93
92
  "type": "option",
94
93
  "char": "d",
95
- "summary": "the output directory to store the source–formatted files",
96
- "description": "The directory to store your files in after they’re converted to the source format. Can be an absolute or relative path.",
94
+ "summary": "Directory to store your files in after they’re converted to source format; can be an absolute or relative path.",
97
95
  "multiple": false,
98
96
  "deprecateAliases": true,
99
97
  "aliases": [
@@ -104,8 +102,8 @@
104
102
  "name": "manifest",
105
103
  "type": "option",
106
104
  "char": "x",
107
- "summary": "file path to manifest (package.xml) of metadata types to convert.",
108
- "description": "The complete path to the manifest (package.xml) file that specifies the metadata types to convert.\nIf you specify this parameter, don’t specify --metadata or --source-dir.",
105
+ "summary": "File path to manifest (package.xml) of metadata types to convert.",
106
+ "description": "If you specify this parameter, don’t specify --metadata or --source-dir.",
109
107
  "multiple": false,
110
108
  "deprecateAliases": true
111
109
  },
@@ -113,8 +111,8 @@
113
111
  "name": "metadata-dir",
114
112
  "type": "option",
115
113
  "char": "p",
116
- "summary": "comma-separated list of metadata file paths to convert",
117
- "description": "A comma-separated list of paths to the local metadata files to convert. 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).\nIf you specify this parameter, 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.",
114
+ "summary": "Comma-separated list of paths to the local metadata files to convert.",
115
+ "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.",
118
116
  "multiple": true,
119
117
  "exclusive": [
120
118
  "manifest",
@@ -130,12 +128,11 @@
130
128
  "name": "metadata",
131
129
  "type": "option",
132
130
  "char": "m",
133
- "summary": "comma-separated list of metadata component names to convert",
134
- "description": "A comma-separated list of metadata component names to convert.",
131
+ "summary": "Comma-separated list of metadata component names to convert.",
135
132
  "multiple": true,
136
133
  "exclusive": [
137
134
  "manifest",
138
- "metadata-dir"
135
+ "metadatapath"
139
136
  ],
140
137
  "deprecateAliases": true,
141
138
  "delimiter": ","
@@ -146,8 +143,8 @@
146
143
  },
147
144
  "project:convert:source": {
148
145
  "id": "project:convert:source",
149
- "summary": "convert source into Metadata API format",
150
- "description": "convert source into Metadata API format\nConverts source-formatted files into metadata that you can deploy using Metadata API.\nTo convert source-formatted files into the metadata format, so that you can deploy them using Metadata API,\nrun \"<%= config.bin %> project convert mdapi\". 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
+ "summary": "Convert source-formatted files into metadata that you can deploy using Metadata API.",
147
+ "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.",
151
148
  "strict": true,
152
149
  "pluginName": "@salesforce/plugin-deploy-retrieve",
153
150
  "pluginAlias": "@salesforce/plugin-deploy-retrieve",
@@ -156,8 +153,8 @@
156
153
  "force:source:convert"
157
154
  ],
158
155
  "examples": [
159
- "$ <%= config.bin %> <%= command.id %> -r path/to/source",
160
- "$ <%= config.bin %> <%= command.id %> -r path/to/source -d path/to/outputdir -n 'My Package'"
156
+ "Convert source-formatted files in the specified directory into metadata-formatted files; writes converted files into a new directory:\n$ <%= config.bin %> <%= command.id %> --root-dir path/to/source",
157
+ "Similar to previous example, but writes converted files to the specified output directory and associates the files with the specified package:\n$ <%= config.bin %> <%= command.id %> --root-dir path/to/source --output-dir path/to/outputdir --package-name 'My Package'"
161
158
  ],
162
159
  "deprecateAliases": true,
163
160
  "flags": {
@@ -193,7 +190,7 @@
193
190
  "name": "root-dir",
194
191
  "type": "option",
195
192
  "char": "r",
196
- "summary": "a source directory other than the default package to convert",
193
+ "summary": "Source directory other than the default package to convert.",
197
194
  "multiple": false,
198
195
  "deprecateAliases": true,
199
196
  "aliases": [
@@ -204,9 +201,9 @@
204
201
  "name": "output-dir",
205
202
  "type": "option",
206
203
  "char": "d",
207
- "summary": "output directory to store the Metadata API–formatted files in",
204
+ "summary": "Output directory to store the Metadata API–formatted files in.",
208
205
  "multiple": false,
209
- "default": "metadataPackage_1679597528416",
206
+ "default": "metadataPackage_1679601641935",
210
207
  "deprecateAliases": true,
211
208
  "aliases": [
212
209
  "outputdir"
@@ -216,7 +213,7 @@
216
213
  "name": "package-name",
217
214
  "type": "option",
218
215
  "char": "n",
219
- "summary": "name of the package to associate with the metadata-formatted files",
216
+ "summary": "Name of the package to associate with the metadata-formatted files.",
220
217
  "multiple": false,
221
218
  "deprecateAliases": true,
222
219
  "aliases": [
@@ -227,8 +224,8 @@
227
224
  "name": "manifest",
228
225
  "type": "option",
229
226
  "char": "x",
230
- "summary": "The complete path to the manifest (package.xml) file that specifies the metadata types to convert.\nIf you specify this parameter, don’t specify --metadata or --source-dir.",
231
- "description": "file path to manifest (package.xml) of metadata types to convert.",
227
+ "summary": "Path to the manifest (package.xml) file that specifies the metadata types to convert.",
228
+ "description": "If you specify this parameter, don’t specify --metadata or --source-dir.",
232
229
  "multiple": false,
233
230
  "deprecateAliases": true
234
231
  },
@@ -236,8 +233,8 @@
236
233
  "name": "source-dir",
237
234
  "type": "option",
238
235
  "char": "p",
239
- "summary": "A comma-separated list of paths to the local source files to convert. 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).\nIf you specify this parameter, don’t specify --manifest or --metadata.",
240
- "description": "comma-separated list of paths to the local source files to convert",
236
+ "summary": "Comma-separated list of paths to the local source files to convert.",
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.",
241
238
  "multiple": true,
242
239
  "exclusive": [
243
240
  "manifest",
@@ -253,7 +250,7 @@
253
250
  "name": "metadata",
254
251
  "type": "option",
255
252
  "char": "m",
256
- "description": "comma-separated list of metadata component names to convert",
253
+ "summary": "Comma-separated list of metadata component names to convert.",
257
254
  "multiple": true,
258
255
  "exclusive": [
259
256
  "manifest",
@@ -268,8 +265,8 @@
268
265
  },
269
266
  "project:delete:source": {
270
267
  "id": "project:delete:source",
271
- "summary": "delete source from your project and from a non-source-tracked org.",
272
- "description": "delete source from your project and from a non-source-tracked org\nIMPORTANT: 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\nUse this command to delete components from orgs that don’t have source tracking.\nTo remove deleted items from scratch orgs, which have change tracking, use \"sf project deploy start\".",
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.",
273
270
  "strict": true,
274
271
  "pluginName": "@salesforce/plugin-deploy-retrieve",
275
272
  "pluginAlias": "@salesforce/plugin-deploy-retrieve",
@@ -278,8 +275,11 @@
278
275
  "force:source:delete"
279
276
  ],
280
277
  "examples": [
281
- "$ <%= config.bin %> <%= command.id %> -m <metadata>",
282
- "$ <%= config.bin %> <%= command.id %> -p path/to/source"
278
+ "Delete all local Apex source files and all Apex classes from the org with alias \"my-scratch\":\n<%= config.bin %> <%= command.id %> --metadata ApexClass --target-org my-scratch",
279
+ "Delete a specific Apex class and a Profile that has a space in it from your default org; don't prompt for confirmation:\n<%= config.bin %> <%= command.id %> --metadata ApexClass:MyFabulousApexClass --metadata \"Profile: My Profile\" --no-prompt",
280
+ "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:\n<%= config.bin %> <%= command.id %> --metadata ApexClass --test-level RunLocalTests --track-source",
281
+ "Delete the Apex source files in a directory and the corresponding components from your default org:\n<%= config.bin %> <%= command.id %> --source-dir force-app/main/default/classes",
282
+ "Delete all components listed in a manifest:\n<%= config.bin %> <%= command.id %> --manifest path/to/package.xml"
283
283
  ],
284
284
  "deprecateAliases": true,
285
285
  "flags": {
@@ -328,8 +328,8 @@
328
328
  "name": "check-only",
329
329
  "type": "boolean",
330
330
  "char": "c",
331
- "summary": "validate delete command but do not delete from the org or delete files locally",
332
- "description": "Validates the deleted metadata and runs all Apex tests, but prevents the deletion from being saved to the org.\nIf you change a field type from Master-Detail to Lookup or vice versa, that change isn’t supported when using the --chec-konly 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.\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.\nNote: A Metadata API deletion that includes Master-Detail relationships deletes all detail records in the Recycle Bin in the following cases.\n1. 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.\n2. 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.",
331
+ "summary": "Validate delete command but don't delete anything from the org or the local project.",
332
+ "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 --chec-konly 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.",
333
333
  "allowNo": false,
334
334
  "deprecateAliases": true,
335
335
  "aliases": [
@@ -340,8 +340,8 @@
340
340
  "name": "wait",
341
341
  "type": "option",
342
342
  "char": "w",
343
- "summary": "wait time for command to finish in minutes",
344
- "description": "Number of minutes to wait for the command to complete and display results to the terminal window. If the command continues to run after the wait period, the CLI returns control of the terminal window to you.",
343
+ "summary": "Number of minutes to wait for the command to finish.",
344
+ "description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you.",
345
345
  "multiple": false,
346
346
  "default": {
347
347
  "quantity": 33,
@@ -353,12 +353,11 @@
353
353
  "name": "test-level",
354
354
  "type": "option",
355
355
  "char": "l",
356
- "summary": "deployment testing level",
357
- "description": "Specifies which level of deployment tests to run. Valid values are:\nNoTestRu — 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.\nRunLocalTests — 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.\nRunAllTestsInOrg — All tests in your org are run, including tests of managed packages.\nIf you don’t specify a test level, the default behavior depends on the contents of your deployment package. For more information, see “Running Tests in a Deployment” in the Metadata API Developer Guide.",
356
+ "summary": "Deployment Apex testing level.",
357
+ "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- 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- 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. For more information, see “Running Tests in a Deployment” in the Metadata API Developer Guide.",
358
358
  "multiple": false,
359
359
  "options": [
360
360
  "NoTestRun",
361
- "RunSpecifiedTests",
362
361
  "RunLocalTests",
363
362
  "RunAllTestsInOrg"
364
363
  ],
@@ -372,7 +371,7 @@
372
371
  "name": "no-prompt",
373
372
  "type": "boolean",
374
373
  "char": "r",
375
- "summary": "do not prompt for delete confirmation",
374
+ "summary": "Don't prompt for delete confirmation.",
376
375
  "allowNo": false,
377
376
  "deprecateAliases": true,
378
377
  "aliases": [
@@ -383,8 +382,8 @@
383
382
  "name": "metadata",
384
383
  "type": "option",
385
384
  "char": "m",
386
- "summary": "comma-separated list of names of metadata components to delete",
387
- "description": "A comma-separated list of names of metadata components to delete from your project and your org.\nIf you specify this parameter, don’t specify --source-dir.",
385
+ "summary": "Comma-separated list of names of metadata components to delete.",
386
+ "description": "If you specify this parameter, don’t specify --source-dir.",
388
387
  "multiple": true,
389
388
  "deprecateAliases": true,
390
389
  "delimiter": ","
@@ -393,8 +392,8 @@
393
392
  "name": "source-dir",
394
393
  "type": "option",
395
394
  "char": "p",
396
- "summary": "comma-separated list of source file paths to delete",
397
- "description": "A comma-separated list of paths to the local metadata to delete. 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).\nIf you specify this parameter, don’t specify --metadata.",
395
+ "summary": "Comma-separated list of source file paths to delete.",
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.",
398
397
  "multiple": true,
399
398
  "deprecateAliases": true,
400
399
  "aliases": [
@@ -406,7 +405,7 @@
406
405
  "name": "track-source",
407
406
  "type": "boolean",
408
407
  "char": "t",
409
- "summary": "If the delete succeeds, update the source tracking information, similar to push",
408
+ "summary": "If the delete succeeds, update the source tracking information.",
410
409
  "allowNo": false,
411
410
  "exclusive": [
412
411
  "check-only"
@@ -420,7 +419,7 @@
420
419
  "name": "force-overwrite",
421
420
  "type": "boolean",
422
421
  "char": "f",
423
- "summary": "ignore conflict warnings and overwrite changes to the org",
422
+ "summary": "Ignore conflict warnings and overwrite changes to the org.",
424
423
  "allowNo": false,
425
424
  "dependsOn": [
426
425
  "track-source"
@@ -433,7 +432,7 @@
433
432
  "verbose": {
434
433
  "name": "verbose",
435
434
  "type": "boolean",
436
- "summary": "verbose output of delete result",
435
+ "summary": "Verbose output of the delete result.",
437
436
  "allowNo": false,
438
437
  "deprecateAliases": true
439
438
  }
@@ -444,8 +443,8 @@
444
443
  },
445
444
  "project:delete:tracking": {
446
445
  "id": "project:delete:tracking",
447
- "summary": "delete all local source tracking information\n\nWARNING: 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', the CLI displays all local and remote files as changed, and any files with the same name are listed as conflicts.",
448
- "description": "delete all local source tracking information\n\nWARNING: 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', the CLI displays all local and remote files as changed, and any files with the same name are listed as conflicts.",
446
+ "summary": "Delete all local source tracking information.",
447
+ "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.",
449
448
  "strict": true,
450
449
  "pluginName": "@salesforce/plugin-deploy-retrieve",
451
450
  "pluginAlias": "@salesforce/plugin-deploy-retrieve",
@@ -502,7 +501,7 @@
502
501
  "name": "no-prompt",
503
502
  "type": "boolean",
504
503
  "char": "p",
505
- "summary": "do not prompt for source tracking override confirmation",
504
+ "summary": "Don't prompt for source tracking override confirmation.",
506
505
  "allowNo": false,
507
506
  "deprecateAliases": true,
508
507
  "aliases": [
@@ -1675,8 +1674,8 @@
1675
1674
  },
1676
1675
  "project:manifest:create": {
1677
1676
  "id": "project:manifest:create",
1678
- "summary": "create a project manifest that lists the metadata components you want to deploy or retrieve\nCreate 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 --manifest-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\npackage : package.xml (default)\npre : destructiveChangesPre.xml\npost : destructiveChangesPost.xml\ndestroy : 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 --manifest-name to specify a custom name for the generated manifest if the pre-defined ones don’t suit your needs. You can specify either --manifest-type or --manifest-name, but not both.",
1679
- "description": "create a project manifest that lists the metadata components you want to deploy or retrieve\nCreate 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 --manifest-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\npackage : package.xml (default)\npre : destructiveChangesPre.xml\npost : destructiveChangesPost.xml\ndestroy : 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 --manifest-name to specify a custom name for the generated manifest if the pre-defined ones don’t suit your needs. You can specify either --manifest-type or --manifest-name, but not both.",
1677
+ "summary": "Create a project manifest that lists the metadata components you want to deploy or retrieve.",
1678
+ "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 --manifest-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 --manifest-name to specify a custom name for the generated manifest if the pre-defined ones don’t suit your needs. You can specify either --manifest-type or --manifest-name, but not both.",
1680
1679
  "strict": true,
1681
1680
  "pluginName": "@salesforce/plugin-deploy-retrieve",
1682
1681
  "pluginAlias": "@salesforce/plugin-deploy-retrieve",
@@ -1685,10 +1684,10 @@
1685
1684
  "force:source:manifest:create"
1686
1685
  ],
1687
1686
  "examples": [
1688
- "$ <%= config.bin %> <%= command.id %> -m ApexClass",
1689
- "$ <%= config.bin %> <%= command.id %> -m ApexClass:MyApexClass --manifest-type destroy",
1690
- "$ <%= config.bin %> <%= command.id %> --source-dir force-app --manifest-name myNewManifest",
1691
- "$ <%= config.bin %> <%= command.id %> --from-org test@myorg.com --include-packages unlocked"
1687
+ "Create a manifest for deploying or retrieving all Apex classes:\n$ <%= config.bin %> <%= command.id %> --metadata ApexClass",
1688
+ "Create a manifest for deleting the specified Apex class:\n$ <%= config.bin %> <%= command.id %> --metadata ApexClass:MyApexClass --manifest-type destroy",
1689
+ "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 --manifest-name myNewManifest",
1690
+ "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"
1692
1691
  ],
1693
1692
  "deprecateAliases": true,
1694
1693
  "flags": {
@@ -1724,7 +1723,7 @@
1724
1723
  "name": "metadata",
1725
1724
  "type": "option",
1726
1725
  "char": "m",
1727
- "description": "comma-separated list of names of metadata components to include in the manifest",
1726
+ "summary": "Comma-separated list of names of metadata components to include in the manifest.",
1728
1727
  "multiple": true,
1729
1728
  "deprecateAliases": true,
1730
1729
  "delimiter": ","
@@ -1733,7 +1732,7 @@
1733
1732
  "name": "source-dir",
1734
1733
  "type": "option",
1735
1734
  "char": "p",
1736
- "description": "comma-separated list of paths to the local source files to include in the manifest",
1735
+ "summary": "Comma-separated list of paths to the local source files to include in the manifest.",
1737
1736
  "multiple": true,
1738
1737
  "deprecateAliases": true,
1739
1738
  "aliases": [
@@ -1745,7 +1744,7 @@
1745
1744
  "name": "manifest-name",
1746
1745
  "type": "option",
1747
1746
  "char": "n",
1748
- "summary": "name of a custom manifest file to create",
1747
+ "summary": "Name of a custom manifest file to create.",
1749
1748
  "multiple": false,
1750
1749
  "exclusive": [
1751
1750
  "manifest-type"
@@ -1759,7 +1758,7 @@
1759
1758
  "name": "manifest-type",
1760
1759
  "type": "option",
1761
1760
  "char": "t",
1762
- "summary": "type of manifest to create; the type determines the name of the created file",
1761
+ "summary": "Type of manifest to create; the type determines the name of the created file.",
1763
1762
  "multiple": false,
1764
1763
  "options": [
1765
1764
  "pre",
@@ -1776,7 +1775,7 @@
1776
1775
  "name": "include-packages",
1777
1776
  "type": "option",
1778
1777
  "char": "c",
1779
- "description": "comma-separated list of package types (managed, unlocked) whose metadata is included in the manifest; by default, metadata in packages is ignored",
1778
+ "summary": "Comma-separated list of package types (managed, unlocked) whose metadata is included in the manifest; by default, metadata in packages is ignored.",
1780
1779
  "multiple": true,
1781
1780
  "options": [
1782
1781
  "managed",
@@ -1794,7 +1793,7 @@
1794
1793
  "from-org": {
1795
1794
  "name": "from-org",
1796
1795
  "type": "option",
1797
- "summary": "username or alias of the org that contains the metadata components from which to build a manifest",
1796
+ "summary": "Username or alias of the org that contains the metadata components from which to build a manifest.",
1798
1797
  "multiple": false,
1799
1798
  "deprecateAliases": true,
1800
1799
  "aliases": [
@@ -1805,7 +1804,7 @@
1805
1804
  "name": "output-dir",
1806
1805
  "type": "option",
1807
1806
  "char": "d",
1808
- "summary": "directory to save the created manifest",
1807
+ "summary": "Directory to save the created manifest.",
1809
1808
  "multiple": false,
1810
1809
  "deprecateAliases": true,
1811
1810
  "aliases": [
@@ -1819,8 +1818,8 @@
1819
1818
  },
1820
1819
  "project:reset:tracking": {
1821
1820
  "id": "project:reset:tracking",
1822
- "summary": "reset local and remote source tracking\n\nWARNING: This command deletes or overwrites all existing source tracking files. Use with extreme caution.\n\nResets local and remote source tracking so that the CLI no longer registers differences between your local files and those in the org. When you next run force:source:status, the CLI returns no results, even though conflicts might actually exist. The CLI then resumes tracking new source changes as usual.\n\nUse the --revision parameter to reset source tracking to a specific revision number of an org source member. To get the revision number, query the SourceMember Tooling API object with the force:data:soql:query command. For example:\n$ sfdx force:data:soql:query -q \"SELECT MemberName, MemberType, RevisionCounter FROM SourceMember\" -t",
1823
- "description": "reset local and remote source tracking\n\nWARNING: This command deletes or overwrites all existing source tracking files. Use with extreme caution.\n\nResets local and remote source tracking so that the CLI no longer registers differences between your local files and those in the org. When you next run force:source:status, the CLI returns no results, even though conflicts might actually exist. The CLI then resumes tracking new source changes as usual.\n\nUse the --revision parameter to reset source tracking to a specific revision number of an org source member. To get the revision number, query the SourceMember Tooling API object with the force:data:soql:query command. For example:\n$ sfdx force:data:soql:query -q \"SELECT MemberName, MemberType, RevisionCounter FROM SourceMember\" -t",
1821
+ "summary": "Reset local and remote source tracking.",
1822
+ "description": "WARNING: This command deletes or overwrites all existing source tracking files. Use with extreme caution.\n\nResets local and remote source tracking so that Salesforce CLI no longer registers differences between your local files and those in the org. When you next run 'project deploy preview', Salesforce CLI returns no results, even though conflicts might actually exist. Salesforce CLI then resumes tracking new source changes as usual.\n\nUse the --revision parameter to reset source tracking to a specific revision number of an org source member. To get the revision number, query the SourceMember Tooling API object with the 'data soql' command. For example:\n\n<%= config.bin %> data query --query \"SELECT MemberName, MemberType, RevisionCounter FROM SourceMember\" --use-tooling-api",
1824
1823
  "strict": true,
1825
1824
  "pluginName": "@salesforce/plugin-deploy-retrieve",
1826
1825
  "pluginAlias": "@salesforce/plugin-deploy-retrieve",
@@ -1877,7 +1876,7 @@
1877
1876
  "name": "revision",
1878
1877
  "type": "option",
1879
1878
  "char": "r",
1880
- "summary": "reset to a specific SourceMember revision counter number",
1879
+ "summary": "SourceMember revision counter number to reset to.",
1881
1880
  "multiple": false,
1882
1881
  "deprecateAliases": true
1883
1882
  },
@@ -1885,7 +1884,7 @@
1885
1884
  "name": "no-prompt",
1886
1885
  "type": "boolean",
1887
1886
  "char": "p",
1888
- "summary": "do not prompt for source tracking override confirmation",
1887
+ "summary": "Don't prompt for source tracking override confirmation.",
1889
1888
  "allowNo": false,
1890
1889
  "deprecateAliases": true,
1891
1890
  "aliases": [
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.3",
4
+ "version": "1.8.5-beta.4",
5
5
  "author": "Salesforce",
6
6
  "bugs": "https://github.com/forcedotcom/cli/issues",
7
7
  "dependencies": {
@@ -266,7 +266,7 @@
266
266
  }
267
267
  },
268
268
  "sfdx": {
269
- "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-deploy-retrieve/1.8.5-beta.3.crt",
270
- "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-deploy-retrieve/1.8.5-beta.3.sig"
269
+ "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-deploy-retrieve/1.8.5-beta.4.crt",
270
+ "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-deploy-retrieve/1.8.5-beta.4.sig"
271
271
  }
272
272
  }