@salesforce/plugin-deploy-retrieve 3.19.1 → 3.20.0

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 (10) hide show
  1. package/README.md +17 -17
  2. package/lib/commands/project/delete/source.js +12 -1
  3. package/lib/commands/project/delete/source.js.map +1 -1
  4. package/lib/commands/project/retrieve/start.js +7 -7
  5. package/lib/commands/project/retrieve/start.js.map +1 -1
  6. package/lib/utils/flags.d.ts +5 -0
  7. package/lib/utils/flags.js +5 -0
  8. package/lib/utils/flags.js.map +1 -1
  9. package/oclif.manifest.json +1498 -1498
  10. package/package.json +3 -3
package/oclif.manifest.json CHANGED
@@ -1,15 +1,17 @@
1
1
  {
2
2
  "commands": {
3
- "project:convert:mdapi": {
3
+ "project:delete:source": {
4
4
  "aliases": [
5
- "force:mdapi:convert"
5
+ "force:source:delete"
6
6
  ],
7
7
  "args": {},
8
8
  "deprecateAliases": true,
9
- "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 \"sf 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 --source-dir.",
9
+ "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 --source-dir.",
10
10
  "examples": [
11
- "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",
12
- "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"
11
+ "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",
12
+ "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",
13
+ "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",
14
+ "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"
13
15
  ],
14
16
  "flags": {
15
17
  "json": {
@@ -48,80 +50,149 @@
48
50
  "multiple": false,
49
51
  "type": "option"
50
52
  },
51
- "root-dir": {
53
+ "target-org": {
52
54
  "aliases": [
53
- "rootdir"
55
+ "targetusername",
56
+ "u"
54
57
  ],
55
- "char": "r",
58
+ "char": "o",
56
59
  "deprecateAliases": true,
57
- "name": "root-dir",
60
+ "name": "target-org",
61
+ "noCacheDefault": true,
58
62
  "required": true,
59
- "summary": "Root directory that contains the Metadata API–formatted metadata.",
60
- "hasDynamicHelp": false,
63
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
64
+ "hasDynamicHelp": true,
61
65
  "multiple": false,
62
66
  "type": "option"
63
67
  },
64
- "output-dir": {
68
+ "check-only": {
65
69
  "aliases": [
66
- "outputdir"
70
+ "checkonly"
67
71
  ],
68
- "char": "d",
72
+ "char": "c",
69
73
  "deprecateAliases": true,
70
- "name": "output-dir",
71
- "summary": "Directory to store your files in after they’re converted to source format; can be an absolute or relative path.",
72
- "hasDynamicHelp": false,
74
+ "description": "IMPORTANT: Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.\n\nValidates the deleted metadata and runs all Apex tests, but prevents the deletion from being saved to the org.\n\nIf you change a field type from Master-Detail to Lookup or vice versa, that change isn’t supported when using the --check-only flag 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.",
75
+ "name": "check-only",
76
+ "summary": "Validate delete command but don't delete anything from the org or the local project.",
77
+ "allowNo": false,
78
+ "type": "boolean"
79
+ },
80
+ "wait": {
81
+ "char": "w",
82
+ "description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you.",
83
+ "name": "wait",
84
+ "summary": "Number of minutes to wait for the command to finish.",
85
+ "hasDynamicHelp": true,
73
86
  "multiple": false,
74
87
  "type": "option"
75
88
  },
76
- "manifest": {
77
- "char": "x",
78
- "description": "If you specify this flag, don’t specify --metadata or --source-dir.",
79
- "name": "manifest",
80
- "summary": "File path to manifest (package.xml) of metadata types to convert.",
89
+ "tests": {
90
+ "description": "If a test name contains a space, enclose it in double quotes.\nFor multiple test names, use one of the following formats:\n\n- Repeat the flag for multiple test names: --tests Test1 --tests Test2 --tests \"Test With Space\"\n- Separate the test names with spaces: --tests Test1 Test2 \"Test With Space\"",
91
+ "helpGroup": "Test",
92
+ "name": "tests",
93
+ "summary": "Apex tests to run when --test-level is RunSpecifiedTests.",
81
94
  "hasDynamicHelp": false,
82
- "multiple": false,
95
+ "multiple": true,
83
96
  "type": "option"
84
97
  },
85
- "metadata-dir": {
98
+ "test-level": {
86
99
  "aliases": [
87
- "metadatapath"
100
+ "testlevel"
88
101
  ],
89
- "char": "p",
102
+ "char": "l",
90
103
  "deprecateAliases": true,
91
- "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.",
92
- "exclusive": [
93
- "manifest",
94
- "metadata"
104
+ "description": "Valid values are:\n\n- NoTestRun — No tests are run. This test level applies only to deployments to development environments, such as sandbox, Developer Edition, or trial orgs. This test level is the default for development environments.\n\n- RunSpecifiedTests — Runs only the tests that you specify with the --tests flag. Code coverage requirements differ from the default coverage requirements when using this test level. Executed tests must comprise a minimum of 75% code coverage for each class and trigger in the deployment package. This coverage is computed for each class and trigger individually and is different than the overall coverage percentage.\n\n- RunLocalTests — All tests in your org are run, except the ones that originate from installed managed and unlocked packages. This test level is the default for production deployments that include Apex classes or triggers.\n\n- RunAllTestsInOrg — All tests in your org are run, including tests of managed packages.\n\nIf you don’t specify a test level, the default behavior depends on the contents of your deployment package and target org. For more information, see “Running Tests in a Deployment” in the Metadata API Developer Guide.",
105
+ "helpGroup": "Test",
106
+ "name": "test-level",
107
+ "summary": "Deployment Apex testing level.",
108
+ "hasDynamicHelp": false,
109
+ "multiple": false,
110
+ "options": [
111
+ "NoTestRun",
112
+ "RunSpecifiedTests",
113
+ "RunLocalTests",
114
+ "RunAllTestsInOrg"
95
115
  ],
96
- "name": "metadata-dir",
97
- "summary": "Root of directory or zip file of metadata formatted files to convert.",
116
+ "type": "option"
117
+ },
118
+ "no-prompt": {
119
+ "aliases": [
120
+ "noprompt"
121
+ ],
122
+ "char": "r",
123
+ "deprecateAliases": true,
124
+ "name": "no-prompt",
125
+ "summary": "Don't prompt for delete confirmation.",
126
+ "allowNo": false,
127
+ "type": "boolean"
128
+ },
129
+ "metadata": {
130
+ "char": "m",
131
+ "description": "If you specify this flag, don’t specify --source-dir.",
132
+ "name": "metadata",
133
+ "summary": "Metadata components to delete.",
98
134
  "delimiter": ",",
99
135
  "hasDynamicHelp": false,
100
136
  "multiple": true,
101
137
  "type": "option"
102
138
  },
103
- "metadata": {
104
- "char": "m",
105
- "exclusive": [
106
- "manifest",
107
- "metadatapath"
139
+ "source-dir": {
140
+ "aliases": [
141
+ "sourcepath"
108
142
  ],
109
- "name": "metadata",
110
- "summary": "Metadata component names to convert.",
143
+ "char": "p",
144
+ "deprecateAliases": true,
145
+ "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 flag, don’t specify --metadata.",
146
+ "name": "source-dir",
147
+ "summary": "Source file paths to delete.",
111
148
  "delimiter": ",",
112
149
  "hasDynamicHelp": false,
113
150
  "multiple": true,
114
151
  "type": "option"
152
+ },
153
+ "track-source": {
154
+ "aliases": [
155
+ "tracksource"
156
+ ],
157
+ "char": "t",
158
+ "deprecateAliases": true,
159
+ "exclusive": [
160
+ "check-only"
161
+ ],
162
+ "name": "track-source",
163
+ "summary": "If the delete succeeds, update the source tracking information.",
164
+ "allowNo": false,
165
+ "type": "boolean"
166
+ },
167
+ "force-overwrite": {
168
+ "aliases": [
169
+ "forceoverwrite"
170
+ ],
171
+ "char": "f",
172
+ "dependsOn": [
173
+ "track-source"
174
+ ],
175
+ "deprecateAliases": true,
176
+ "name": "force-overwrite",
177
+ "summary": "Ignore conflict warnings and overwrite changes to the org.",
178
+ "allowNo": false,
179
+ "type": "boolean"
180
+ },
181
+ "verbose": {
182
+ "name": "verbose",
183
+ "summary": "Verbose output of the delete result.",
184
+ "allowNo": false,
185
+ "type": "boolean"
115
186
  }
116
187
  },
117
- "hasDynamicHelp": false,
188
+ "hasDynamicHelp": true,
118
189
  "hiddenAliases": [],
119
- "id": "project:convert:mdapi",
190
+ "id": "project:delete:source",
120
191
  "pluginAlias": "@salesforce/plugin-deploy-retrieve",
121
192
  "pluginName": "@salesforce/plugin-deploy-retrieve",
122
193
  "pluginType": "core",
123
194
  "strict": true,
124
- "summary": "Convert metadata retrieved via Metadata API into the source format used in Salesforce DX projects.",
195
+ "summary": "Delete source from your project and from a non-source-tracked org.",
125
196
  "enableJsonFlag": true,
126
197
  "requiresProject": true,
127
198
  "isESM": true,
@@ -129,34 +200,35 @@
129
200
  "lib",
130
201
  "commands",
131
202
  "project",
132
- "convert",
133
- "mdapi.js"
203
+ "delete",
204
+ "source.js"
134
205
  ],
135
206
  "aliasPermutations": [
136
- "force:mdapi:convert",
137
- "mdapi:force:convert",
138
- "mdapi:convert:force",
139
- "force:convert:mdapi",
140
- "convert:force:mdapi",
141
- "convert:mdapi:force"
207
+ "force:source:delete",
208
+ "source:force:delete",
209
+ "source:delete:force",
210
+ "force:delete:source",
211
+ "delete:force:source",
212
+ "delete:source:force"
142
213
  ],
143
214
  "permutations": [
144
- "project:convert:mdapi",
145
- "convert:project:mdapi",
146
- "convert:mdapi:project",
147
- "project:mdapi:convert",
148
- "mdapi:project:convert",
149
- "mdapi:convert:project"
215
+ "project:delete:source",
216
+ "delete:project:source",
217
+ "delete:source:project",
218
+ "project:source:delete",
219
+ "source:project:delete",
220
+ "source:delete:project"
150
221
  ]
151
222
  },
152
- "project:convert:source-behavior": {
153
- "aliases": [],
223
+ "project:delete:tracking": {
224
+ "aliases": [
225
+ "force:source:tracking:clear"
226
+ ],
154
227
  "args": {},
155
- "description": "Specifically, this command updates the \"sourceBehaviorOption\" option in the \"sfdx-project.json\" file and then converts the associated local source files in your project as needed.\n\nFor example, run this command with the \"--behavior decomposePermissionSetBeta\" flag to start decomposing permission sets when you deploy or retrieve them. Decomposing means breaking up the monolithic metadata API format XML file that corresponds to a metadata component into smaller XML files and directories based on its subtypes. Permission sets are not decomposed by default; you must opt-in to start decomposing them by using this command. When the command finishes, your \"sfdx-project.json\" file is updated to always decompose permission sets, and the existing permission set files in your local package directories are converted into the new decomposed format. You run this command only once for a given behavior change.\n\nFor more information about the possible values for the --behavior flag, see the \"sourceBehaviorOptions\" section in the https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_ws_config.htm topic.",
228
+ "deprecateAliases": true,
229
+ "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.",
156
230
  "examples": [
157
- "Update your Salesforce DX project to decompose custom permission sets:\n<%= config.bin %> <%= command.id %> --behavior decomposePermissionSetBeta",
158
- "Display what the command would do, but don't change any existing files:\n<%= config.bin %> <%= command.id %> --behavior decomposePermissionSetBeta --dry-run",
159
- "Keep the temporary directory that contains the interim metadata API formatted files:\n<%= config.bin %> <%= command.id %> --behavior decomposePermissionSetBeta --dry-run --preserve-temp-dir"
231
+ "Delete local source tracking for the org with alias \"my-scratch\":\n$ <%= config.bin %> <%= command.id %> --target-org my-scratch"
160
232
  ],
161
233
  "flags": {
162
234
  "json": {
@@ -174,55 +246,62 @@
174
246
  "multiple": false,
175
247
  "type": "option"
176
248
  },
177
- "behavior": {
178
- "char": "b",
179
- "name": "behavior",
180
- "required": true,
181
- "summary": "Behavior to enable; the values correspond to the possible values of the \"sourceBehaviorOption\" option in the \"sfdx-project.json\" file.",
249
+ "api-version": {
250
+ "aliases": [
251
+ "apiversion"
252
+ ],
253
+ "deprecateAliases": true,
254
+ "description": "Override the api version used for api requests made by this command",
255
+ "name": "api-version",
182
256
  "hasDynamicHelp": false,
183
257
  "multiple": false,
184
- "options": [
185
- "decomposeCustomLabelsBeta2",
186
- "decomposeCustomLabelsBeta",
187
- "decomposePermissionSetBeta",
188
- "decomposePermissionSetBeta2",
189
- "decomposeSharingRulesBeta",
190
- "decomposeWorkflowBeta",
191
- "decomposeExternalServiceRegistrationBeta"
192
- ],
193
258
  "type": "option"
194
259
  },
195
- "dry-run": {
196
- "name": "dry-run",
197
- "summary": "Display what the command would do, but don't make any actual changes.",
198
- "allowNo": false,
199
- "type": "boolean"
200
- },
201
- "preserve-temp-dir": {
202
- "name": "preserve-temp-dir",
203
- "summary": "Don't delete the metadata API format temporary directory that this command creates. Useful for debugging.",
204
- "allowNo": false,
205
- "type": "boolean"
260
+ "loglevel": {
261
+ "deprecated": {
262
+ "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
263
+ },
264
+ "hidden": true,
265
+ "name": "loglevel",
266
+ "hasDynamicHelp": false,
267
+ "multiple": false,
268
+ "type": "option"
206
269
  },
207
270
  "target-org": {
271
+ "aliases": [
272
+ "targetusername",
273
+ "u"
274
+ ],
208
275
  "char": "o",
276
+ "deprecateAliases": true,
209
277
  "name": "target-org",
210
278
  "noCacheDefault": true,
211
- "summary": "Username or alias of the target org.",
279
+ "required": true,
280
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
212
281
  "hasDynamicHelp": true,
213
282
  "multiple": false,
214
283
  "type": "option"
284
+ },
285
+ "no-prompt": {
286
+ "aliases": [
287
+ "noprompt"
288
+ ],
289
+ "char": "p",
290
+ "deprecateAliases": true,
291
+ "name": "no-prompt",
292
+ "summary": "Don't prompt for source tracking override confirmation.",
293
+ "allowNo": false,
294
+ "type": "boolean"
215
295
  }
216
296
  },
217
297
  "hasDynamicHelp": true,
218
298
  "hiddenAliases": [],
219
- "id": "project:convert:source-behavior",
299
+ "id": "project:delete:tracking",
220
300
  "pluginAlias": "@salesforce/plugin-deploy-retrieve",
221
301
  "pluginName": "@salesforce/plugin-deploy-retrieve",
222
302
  "pluginType": "core",
223
- "state": "beta",
224
303
  "strict": true,
225
- "summary": "Enable a behavior of your project source files, and then update your Salesforce DX project to implement the behavior.",
304
+ "summary": "Delete all local source tracking information.",
226
305
  "enableJsonFlag": true,
227
306
  "requiresProject": true,
228
307
  "isESM": true,
@@ -230,29 +309,54 @@
230
309
  "lib",
231
310
  "commands",
232
311
  "project",
233
- "convert",
234
- "source-behavior.js"
312
+ "delete",
313
+ "tracking.js"
314
+ ],
315
+ "aliasPermutations": [
316
+ "force:source:tracking:clear",
317
+ "source:force:tracking:clear",
318
+ "source:tracking:force:clear",
319
+ "source:tracking:clear:force",
320
+ "force:tracking:source:clear",
321
+ "tracking:force:source:clear",
322
+ "tracking:source:force:clear",
323
+ "tracking:source:clear:force",
324
+ "force:tracking:clear:source",
325
+ "tracking:force:clear:source",
326
+ "tracking:clear:force:source",
327
+ "tracking:clear:source:force",
328
+ "force:source:clear:tracking",
329
+ "source:force:clear:tracking",
330
+ "source:clear:force:tracking",
331
+ "source:clear:tracking:force",
332
+ "force:clear:source:tracking",
333
+ "clear:force:source:tracking",
334
+ "clear:source:force:tracking",
335
+ "clear:source:tracking:force",
336
+ "force:clear:tracking:source",
337
+ "clear:force:tracking:source",
338
+ "clear:tracking:force:source",
339
+ "clear:tracking:source:force"
235
340
  ],
236
- "aliasPermutations": [],
237
341
  "permutations": [
238
- "project:convert:source-behavior",
239
- "convert:project:source-behavior",
240
- "convert:source-behavior:project",
241
- "project:source-behavior:convert",
242
- "source-behavior:project:convert",
243
- "source-behavior:convert:project"
342
+ "project:delete:tracking",
343
+ "delete:project:tracking",
344
+ "delete:tracking:project",
345
+ "project:tracking:delete",
346
+ "tracking:project:delete",
347
+ "tracking:delete:project"
244
348
  ]
245
349
  },
246
- "project:convert:source": {
350
+ "project:deploy:cancel": {
247
351
  "aliases": [
248
- "force:source:convert"
352
+ "deploy:metadata:cancel"
249
353
  ],
250
354
  "args": {},
251
355
  "deprecateAliases": true,
252
- "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 --source-dir.",
356
+ "description": "Use this command to cancel a deploy operation that hasn't yet completed in the org. Deploy operations include standard deploys, quick deploys, deploy validations, and deploy cancellations.\n\nRun this command by either passing it a job ID or specifying the --use-most-recent flag to use the job ID of the most recent deploy operation.",
253
357
  "examples": [
254
- "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",
255
- "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'"
358
+ "Cancel a deploy operation using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
359
+ "Cancel the most recent deploy operation:\n<%= config.bin %> <%= command.id %> --use-most-recent"
256
360
  ],
257
361
  "flags": {
258
362
  "json": {
@@ -270,153 +374,103 @@
270
374
  "multiple": false,
271
375
  "type": "option"
272
376
  },
273
- "api-version": {
274
- "aliases": [
275
- "apiversion"
276
- ],
277
- "deprecateAliases": true,
278
- "description": "Override the api version used for api requests made by this command",
279
- "name": "api-version",
280
- "summary": "API Version to use in the generated project's manifest. By default, will use the version from sfdx-project.json",
281
- "hasDynamicHelp": false,
282
- "multiple": false,
283
- "type": "option"
284
- },
285
- "loglevel": {
286
- "deprecated": {
287
- "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
288
- },
289
- "hidden": true,
290
- "name": "loglevel",
291
- "hasDynamicHelp": false,
292
- "multiple": false,
293
- "type": "option"
294
- },
295
- "root-dir": {
296
- "aliases": [
297
- "rootdir"
298
- ],
299
- "char": "r",
300
- "deprecateAliases": true,
301
- "name": "root-dir",
302
- "summary": "Source directory other than the default package to convert.",
303
- "hasDynamicHelp": false,
304
- "multiple": false,
305
- "type": "option"
306
- },
307
- "output-dir": {
308
- "aliases": [
309
- "outputdir"
310
- ],
311
- "char": "d",
312
- "deprecateAliases": true,
313
- "name": "output-dir",
314
- "summary": "Output directory to store the Metadata API–formatted files in.",
315
- "default": "metadataPackage_>timestamp<",
377
+ "target-org": {
378
+ "char": "o",
379
+ "name": "target-org",
380
+ "noCacheDefault": true,
381
+ "summary": "Username or alias of the target org.",
316
382
  "hasDynamicHelp": true,
317
383
  "multiple": false,
318
384
  "type": "option"
319
385
  },
320
- "package-name": {
321
- "aliases": [
322
- "packagename"
386
+ "async": {
387
+ "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\".",
388
+ "exclusive": [
389
+ "wait"
323
390
  ],
324
- "char": "n",
325
- "deprecateAliases": true,
326
- "name": "package-name",
327
- "summary": "Name of the package to associate with the metadata-formatted files.",
328
- "hasDynamicHelp": false,
329
- "multiple": false,
330
- "type": "option"
391
+ "name": "async",
392
+ "summary": "Run the command asynchronously.",
393
+ "allowNo": false,
394
+ "type": "boolean"
331
395
  },
332
- "manifest": {
333
- "char": "x",
334
- "description": "If you specify this flag, don’t specify --metadata or --source-dir.",
335
- "name": "manifest",
336
- "summary": "Path to the manifest (package.xml) file that specifies the metadata types to convert.",
396
+ "job-id": {
397
+ "char": "i",
398
+ "description": "These commands return a job ID if they time out or you specified the --async flag:\n\n- <%= config.bin %> project deploy start\n- <%= config.bin %> project deploy validate\n- <%= config.bin %> project deploy quick\n- <%= config.bin %> project deploy cancel\n\nThe job ID is valid for 10 days from when you started the deploy operation.",
399
+ "name": "job-id",
400
+ "summary": "Job ID of the deploy operation you want to cancel.",
337
401
  "hasDynamicHelp": false,
338
402
  "multiple": false,
339
403
  "type": "option"
340
404
  },
341
- "source-dir": {
342
- "aliases": [
343
- "sourcepath"
344
- ],
345
- "char": "p",
346
- "deprecateAliases": true,
347
- "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.",
348
- "exclusive": [
349
- "manifest",
350
- "metadata"
351
- ],
352
- "name": "source-dir",
353
- "summary": "Paths to the local source files to convert.",
354
- "delimiter": ",",
355
- "hasDynamicHelp": false,
356
- "multiple": true,
357
- "type": "option"
405
+ "use-most-recent": {
406
+ "char": "r",
407
+ "description": "For performance reasons, this flag uses job IDs for deploy operations that started only in the past 3 days or less. If your most recent deploy operations was more than 3 days ago, this flag won't find a job ID.",
408
+ "name": "use-most-recent",
409
+ "summary": "Use the job ID of the most recent deploy operation.",
410
+ "allowNo": false,
411
+ "type": "boolean"
358
412
  },
359
- "metadata": {
360
- "char": "m",
413
+ "wait": {
414
+ "char": "w",
415
+ "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\".",
361
416
  "exclusive": [
362
- "manifest",
363
- "sourcepath"
417
+ "async"
364
418
  ],
365
- "name": "metadata",
366
- "summary": "Metadata component names to convert.",
367
- "delimiter": ",",
368
- "hasDynamicHelp": false,
369
- "multiple": true,
419
+ "name": "wait",
420
+ "summary": "Number of minutes to wait for the command to complete and display results.",
421
+ "hasDynamicHelp": true,
422
+ "helpValue": "<minutes>",
423
+ "multiple": false,
370
424
  "type": "option"
371
425
  }
372
426
  },
373
427
  "hasDynamicHelp": true,
374
428
  "hiddenAliases": [],
375
- "id": "project:convert:source",
429
+ "id": "project:deploy:cancel",
376
430
  "pluginAlias": "@salesforce/plugin-deploy-retrieve",
377
431
  "pluginName": "@salesforce/plugin-deploy-retrieve",
378
432
  "pluginType": "core",
379
433
  "strict": true,
380
- "summary": "Convert source-formatted files into metadata that you can deploy using Metadata API.",
434
+ "summary": "Cancel a deploy operation.",
381
435
  "enableJsonFlag": true,
382
- "requiresProject": true,
383
436
  "isESM": true,
384
437
  "relativePath": [
385
438
  "lib",
386
439
  "commands",
387
440
  "project",
388
- "convert",
389
- "source.js"
441
+ "deploy",
442
+ "cancel.js"
390
443
  ],
391
444
  "aliasPermutations": [
392
- "force:source:convert",
393
- "source:force:convert",
394
- "source:convert:force",
395
- "force:convert:source",
396
- "convert:force:source",
397
- "convert:source:force"
445
+ "deploy:metadata:cancel",
446
+ "metadata:deploy:cancel",
447
+ "metadata:cancel:deploy",
448
+ "deploy:cancel:metadata",
449
+ "cancel:deploy:metadata",
450
+ "cancel:metadata:deploy"
398
451
  ],
399
452
  "permutations": [
400
- "project:convert:source",
401
- "convert:project:source",
402
- "convert:source:project",
403
- "project:source:convert",
404
- "source:project:convert",
405
- "source:convert:project"
453
+ "project:deploy:cancel",
454
+ "deploy:project:cancel",
455
+ "deploy:cancel:project",
456
+ "project:cancel:deploy",
457
+ "cancel:project:deploy",
458
+ "cancel:deploy:project"
406
459
  ]
407
460
  },
408
- "project:delete:source": {
461
+ "project:deploy:preview": {
409
462
  "aliases": [
410
- "force:source:delete"
463
+ "deploy:metadata:preview"
411
464
  ],
412
465
  "args": {},
413
466
  "deprecateAliases": true,
414
- "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 --source-dir.",
467
+ "description": "You must run this command from within a project.\n\nThe command outputs a table that describes what will happen if you run the \"<%= config.bin %> project deploy start\" command. The table lists the metadata components that will be deployed and deleted. The table also lists the current conflicts between files in your local project and components in the org. Finally, the table lists the files that won't be deployed because they're included in your .forceignore file.\n\nIf your org allows source tracking, then this command displays potential conflicts between the org and your local project. Some orgs, such as production org, never allow source tracking. Source tracking is enabled by default on scratch and sandbox orgs; you can disable source tracking when you create the orgs by specifying the --no-track-source flag on the \"<%= config.bin %> org create scratch|sandbox\" commands.\n\nTo preview the deployment of 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 --source-dir.",
415
468
  "examples": [
416
- "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",
417
- "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",
418
- "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",
419
- "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"
469
+ "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.",
470
+ "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",
471
+ "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",
472
+ "Preview deployment of a specific Apex class:\n<%= config.bin %> <%= command.id %> --metadata ApexClass:MyApexClass",
473
+ "Preview deployment of all components listed in a manifest:\n<%= config.bin %> <%= command.id %> --manifest path/to/package.xml"
420
474
  ],
421
475
  "flags": {
422
476
  "json": {
@@ -434,170 +488,77 @@
434
488
  "multiple": false,
435
489
  "type": "option"
436
490
  },
437
- "api-version": {
438
- "aliases": [
439
- "apiversion"
440
- ],
441
- "deprecateAliases": true,
442
- "description": "Override the api version used for api requests made by this command",
443
- "name": "api-version",
444
- "hasDynamicHelp": false,
445
- "multiple": false,
446
- "type": "option"
491
+ "ignore-conflicts": {
492
+ "char": "c",
493
+ "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.",
494
+ "name": "ignore-conflicts",
495
+ "summary": "Don't display conflicts in preview of the deployment.",
496
+ "allowNo": false,
497
+ "type": "boolean"
447
498
  },
448
- "loglevel": {
449
- "deprecated": {
450
- "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
451
- },
452
- "hidden": true,
453
- "name": "loglevel",
499
+ "manifest": {
500
+ "char": "x",
501
+ "description": "All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.",
502
+ "exclusive": [
503
+ "source-dir",
504
+ "metadata"
505
+ ],
506
+ "name": "manifest",
507
+ "summary": "Full file path for manifest (package.xml) of components to preview.",
454
508
  "hasDynamicHelp": false,
455
509
  "multiple": false,
456
510
  "type": "option"
457
511
  },
458
- "target-org": {
459
- "aliases": [
460
- "targetusername",
461
- "u"
462
- ],
463
- "char": "o",
464
- "deprecateAliases": true,
465
- "name": "target-org",
466
- "noCacheDefault": true,
467
- "required": true,
468
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
469
- "hasDynamicHelp": true,
470
- "multiple": false,
471
- "type": "option"
472
- },
473
- "check-only": {
474
- "aliases": [
475
- "checkonly"
476
- ],
477
- "char": "c",
478
- "deprecateAliases": true,
479
- "description": "IMPORTANT: Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.\n\nValidates the deleted metadata and runs all Apex tests, but prevents the deletion from being saved to the org.\n\nIf you change a field type from Master-Detail to Lookup or vice versa, that change isn’t supported when using the --check-only flag 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.",
480
- "name": "check-only",
481
- "summary": "Validate delete command but don't delete anything from the org or the local project.",
482
- "allowNo": false,
483
- "type": "boolean"
484
- },
485
- "wait": {
486
- "char": "w",
487
- "description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you.",
488
- "name": "wait",
489
- "summary": "Number of minutes to wait for the command to finish.",
490
- "hasDynamicHelp": true,
491
- "multiple": false,
492
- "type": "option"
493
- },
494
- "tests": {
495
- "description": "If a test name contains a space, enclose it in double quotes.\nFor multiple test names, use one of the following formats:\n\n- Repeat the flag for multiple test names: --tests Test1 --tests Test2 --tests \"Test With Space\"\n- Separate the test names with spaces: --tests Test1 Test2 \"Test With Space\"",
496
- "helpGroup": "Test",
497
- "name": "tests",
498
- "summary": "Apex tests to run when --test-level is RunSpecifiedTests.",
499
- "hasDynamicHelp": false,
500
- "multiple": true,
501
- "type": "option"
502
- },
503
- "test-level": {
504
- "aliases": [
505
- "testlevel"
506
- ],
507
- "char": "l",
508
- "deprecateAliases": true,
509
- "description": "Valid values are:\n\n- NoTestRun — No tests are run. This test level applies only to deployments to development environments, such as sandbox, Developer Edition, or trial orgs. This test level is the default for development environments.\n\n- RunSpecifiedTests — Runs only the tests that you specify with the --tests flag. Code coverage requirements differ from the default coverage requirements when using this test level. Executed tests must comprise a minimum of 75% code coverage for each class and trigger in the deployment package. This coverage is computed for each class and trigger individually and is different than the overall coverage percentage.\n\n- RunLocalTests — All tests in your org are run, except the ones that originate from installed managed and unlocked packages. This test level is the default for production deployments that include Apex classes or triggers.\n\n- RunAllTestsInOrg — All tests in your org are run, including tests of managed packages.\n\nIf you don’t specify a test level, the default behavior depends on the contents of your deployment package and target org. For more information, see “Running Tests in a Deployment” in the Metadata API Developer Guide.",
510
- "helpGroup": "Test",
511
- "name": "test-level",
512
- "summary": "Deployment Apex testing level.",
513
- "hasDynamicHelp": false,
514
- "multiple": false,
515
- "options": [
516
- "NoTestRun",
517
- "RunSpecifiedTests",
518
- "RunLocalTests",
519
- "RunAllTestsInOrg"
520
- ],
521
- "type": "option"
522
- },
523
- "no-prompt": {
524
- "aliases": [
525
- "noprompt"
526
- ],
527
- "char": "r",
528
- "deprecateAliases": true,
529
- "name": "no-prompt",
530
- "summary": "Don't prompt for delete confirmation.",
531
- "allowNo": false,
532
- "type": "boolean"
533
- },
534
512
  "metadata": {
535
513
  "char": "m",
536
- "description": "If you specify this flag, don’t specify --source-dir.",
514
+ "exclusive": [
515
+ "manifest",
516
+ "source-dir"
517
+ ],
537
518
  "name": "metadata",
538
- "summary": "Metadata components to delete.",
539
- "delimiter": ",",
519
+ "summary": "Metadata component names to preview.",
540
520
  "hasDynamicHelp": false,
541
521
  "multiple": true,
542
522
  "type": "option"
543
523
  },
544
524
  "source-dir": {
545
- "aliases": [
546
- "sourcepath"
525
+ "char": "d",
526
+ "description": "The supplied path 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 subdirectories).\n\nIf you specify this flag, don’t specify --metadata or --manifest.",
527
+ "exclusive": [
528
+ "manifest",
529
+ "metadata"
547
530
  ],
548
- "char": "p",
549
- "deprecateAliases": true,
550
- "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 flag, don’t specify --metadata.",
551
531
  "name": "source-dir",
552
- "summary": "Source file paths to delete.",
553
- "delimiter": ",",
532
+ "summary": "Path to the local source files to preview.",
554
533
  "hasDynamicHelp": false,
555
534
  "multiple": true,
556
535
  "type": "option"
557
536
  },
558
- "track-source": {
559
- "aliases": [
560
- "tracksource"
561
- ],
562
- "char": "t",
563
- "deprecateAliases": true,
564
- "exclusive": [
565
- "check-only"
566
- ],
567
- "name": "track-source",
568
- "summary": "If the delete succeeds, update the source tracking information.",
569
- "allowNo": false,
570
- "type": "boolean"
571
- },
572
- "force-overwrite": {
573
- "aliases": [
574
- "forceoverwrite"
575
- ],
576
- "char": "f",
577
- "dependsOn": [
578
- "track-source"
579
- ],
580
- "deprecateAliases": true,
581
- "name": "force-overwrite",
582
- "summary": "Ignore conflict warnings and overwrite changes to the org.",
583
- "allowNo": false,
584
- "type": "boolean"
537
+ "target-org": {
538
+ "char": "o",
539
+ "name": "target-org",
540
+ "noCacheDefault": true,
541
+ "required": true,
542
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
543
+ "hasDynamicHelp": true,
544
+ "multiple": false,
545
+ "type": "option"
585
546
  },
586
- "verbose": {
587
- "name": "verbose",
588
- "summary": "Verbose output of the delete result.",
547
+ "concise": {
548
+ "name": "concise",
549
+ "summary": "Show only the changes that will be deployed; omits files that are forceignored.",
589
550
  "allowNo": false,
590
551
  "type": "boolean"
591
552
  }
592
553
  },
593
554
  "hasDynamicHelp": true,
594
555
  "hiddenAliases": [],
595
- "id": "project:delete:source",
556
+ "id": "project:deploy:preview",
596
557
  "pluginAlias": "@salesforce/plugin-deploy-retrieve",
597
558
  "pluginName": "@salesforce/plugin-deploy-retrieve",
598
559
  "pluginType": "core",
599
560
  "strict": true,
600
- "summary": "Delete source from your project and from a non-source-tracked org.",
561
+ "summary": "Preview a deployment to see what will deploy to the org, the potential conflicts, and the ignored files.",
601
562
  "enableJsonFlag": true,
602
563
  "requiresProject": true,
603
564
  "isESM": true,
@@ -605,35 +566,36 @@
605
566
  "lib",
606
567
  "commands",
607
568
  "project",
608
- "delete",
609
- "source.js"
569
+ "deploy",
570
+ "preview.js"
610
571
  ],
611
572
  "aliasPermutations": [
612
- "force:source:delete",
613
- "source:force:delete",
614
- "source:delete:force",
615
- "force:delete:source",
616
- "delete:force:source",
617
- "delete:source:force"
573
+ "deploy:metadata:preview",
574
+ "metadata:deploy:preview",
575
+ "metadata:preview:deploy",
576
+ "deploy:preview:metadata",
577
+ "preview:deploy:metadata",
578
+ "preview:metadata:deploy"
618
579
  ],
619
580
  "permutations": [
620
- "project:delete:source",
621
- "delete:project:source",
622
- "delete:source:project",
623
- "project:source:delete",
624
- "source:project:delete",
625
- "source:delete:project"
581
+ "project:deploy:preview",
582
+ "deploy:project:preview",
583
+ "deploy:preview:project",
584
+ "project:preview:deploy",
585
+ "preview:project:deploy",
586
+ "preview:deploy:project"
626
587
  ]
627
588
  },
628
- "project:delete:tracking": {
589
+ "project:deploy:quick": {
629
590
  "aliases": [
630
- "force:source:tracking:clear"
591
+ "deploy:metadata:quick"
631
592
  ],
632
593
  "args": {},
633
594
  "deprecateAliases": true,
634
- "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.",
595
+ "description": "Before you run this command, first create a validated deployment with the \"<%= config.bin %> project deploy validate\" command, which returns a job ID. Validated deployments haven't been deployed to the org yet; you deploy them with this command. Either pass the job ID to this command or use the --use-most-recent flag to use the job ID of the most recently validated deployment. For the quick deploy to succeed, the associated validated deployment must also have succeeded.\n\nExecuting this quick deploy command takes less time than a standard deploy because it skips running Apex tests. These tests were previously run as part of the validation. Validating first and then running a quick deploy is useful if the deployment to your production org take several hours and you don’t want to risk a failed deploy.\n\nThis command doesn't support source-tracking. The source you deploy overwrites the corresponding metadata in your org. This command doesn’t attempt to merge your source with the versions in your org.\n\nNote: Don't use this command on sandboxes; the command is intended to be used on production orgs. By default, sandboxes don't run tests during a deploy. Use \"<%= config.bin %> project deploy start\" instead.",
635
596
  "examples": [
636
- "Delete local source tracking for the org with alias \"my-scratch\":\n$ <%= config.bin %> <%= command.id %> --target-org my-scratch"
597
+ "Run a quick deploy to your default org using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
598
+ "Asynchronously run a quick deploy of the most recently validated deployment to an org with alias \"my-prod-org\":\n<%= config.bin %> <%= command.id %> --async --use-most-recent --target-org my-prod-org"
637
599
  ],
638
600
  "flags": {
639
601
  "json": {
@@ -651,121 +613,162 @@
651
613
  "multiple": false,
652
614
  "type": "option"
653
615
  },
654
- "api-version": {
655
- "aliases": [
656
- "apiversion"
616
+ "async": {
617
+ "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 deploy, run \"<%= config.bin %> project deploy resume\". To check the status of the deploy, run \"<%= config.bin %> project deploy report\".",
618
+ "exclusive": [
619
+ "wait"
657
620
  ],
658
- "deprecateAliases": true,
659
- "description": "Override the api version used for api requests made by this command",
660
- "name": "api-version",
661
- "hasDynamicHelp": false,
662
- "multiple": false,
663
- "type": "option"
621
+ "name": "async",
622
+ "summary": "Run the command asynchronously.",
623
+ "allowNo": false,
624
+ "type": "boolean"
664
625
  },
665
- "loglevel": {
666
- "deprecated": {
667
- "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
668
- },
669
- "hidden": true,
670
- "name": "loglevel",
626
+ "concise": {
627
+ "exclusive": [
628
+ "verbose"
629
+ ],
630
+ "name": "concise",
631
+ "summary": "Show concise output of the deploy result.",
632
+ "allowNo": false,
633
+ "type": "boolean"
634
+ },
635
+ "job-id": {
636
+ "char": "i",
637
+ "description": "The job ID is valid for 10 days from when you started the validation.",
638
+ "name": "job-id",
639
+ "summary": "Job ID of the deployment you want to quick deploy.",
671
640
  "hasDynamicHelp": false,
672
641
  "multiple": false,
673
642
  "type": "option"
674
643
  },
675
644
  "target-org": {
676
- "aliases": [
677
- "targetusername",
678
- "u"
679
- ],
680
645
  "char": "o",
681
- "deprecateAliases": true,
682
646
  "name": "target-org",
683
647
  "noCacheDefault": true,
684
- "required": true,
685
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
648
+ "summary": "Username or alias of the target org.",
686
649
  "hasDynamicHelp": true,
687
650
  "multiple": false,
688
651
  "type": "option"
689
652
  },
690
- "no-prompt": {
691
- "aliases": [
692
- "noprompt"
653
+ "use-most-recent": {
654
+ "char": "r",
655
+ "description": "For performance reasons, this flag uses only job IDs that were validated in the past 3 days or less. If your most recent deployment validation was more than 3 days ago, this flag won't find a job ID.",
656
+ "name": "use-most-recent",
657
+ "summary": "Use the job ID of the most recently validated deployment.",
658
+ "allowNo": false,
659
+ "type": "boolean"
660
+ },
661
+ "verbose": {
662
+ "exclusive": [
663
+ "concise"
693
664
  ],
694
- "char": "p",
695
- "deprecateAliases": true,
696
- "name": "no-prompt",
697
- "summary": "Don't prompt for source tracking override confirmation.",
665
+ "name": "verbose",
666
+ "summary": "Show verbose output of the deploy result.",
698
667
  "allowNo": false,
699
668
  "type": "boolean"
700
- }
701
- },
702
- "hasDynamicHelp": true,
703
- "hiddenAliases": [],
704
- "id": "project:delete:tracking",
705
- "pluginAlias": "@salesforce/plugin-deploy-retrieve",
706
- "pluginName": "@salesforce/plugin-deploy-retrieve",
707
- "pluginType": "core",
708
- "strict": true,
709
- "summary": "Delete all local source tracking information.",
710
- "enableJsonFlag": true,
711
- "requiresProject": true,
669
+ },
670
+ "wait": {
671
+ "char": "w",
672
+ "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 deploy, run \"<%= config.bin %> project deploy resume\". To check the status of the deploy, run \"<%= config.bin %> project deploy report\".",
673
+ "exclusive": [
674
+ "async"
675
+ ],
676
+ "name": "wait",
677
+ "summary": "Number of minutes to wait for the command to complete and display results.",
678
+ "default": "33 minutes",
679
+ "hasDynamicHelp": true,
680
+ "helpValue": "<minutes>",
681
+ "multiple": false,
682
+ "type": "option"
683
+ },
684
+ "api-version": {
685
+ "char": "a",
686
+ "description": "Use this flag to override the default API version with the API version of your package.xml file. The default API version is the latest version supported by the CLI.",
687
+ "name": "api-version",
688
+ "summary": "Target API version for the deploy.",
689
+ "hasDynamicHelp": false,
690
+ "multiple": false,
691
+ "type": "option"
692
+ }
693
+ },
694
+ "hasDynamicHelp": true,
695
+ "hiddenAliases": [],
696
+ "id": "project:deploy:quick",
697
+ "pluginAlias": "@salesforce/plugin-deploy-retrieve",
698
+ "pluginName": "@salesforce/plugin-deploy-retrieve",
699
+ "pluginType": "core",
700
+ "strict": true,
701
+ "summary": "Quickly deploy a validated deployment to an org.",
702
+ "enableJsonFlag": true,
703
+ "errorCodes": {
704
+ "header": "ERROR CODES",
705
+ "body": [
706
+ {
707
+ "name": "Succeeded (0)",
708
+ "description": "The deploy succeeded."
709
+ },
710
+ {
711
+ "name": "Canceled (1)",
712
+ "description": "The deploy was canceled."
713
+ },
714
+ {
715
+ "name": "Failed (1)",
716
+ "description": "The deploy failed."
717
+ },
718
+ {
719
+ "name": "SucceededPartial (68)",
720
+ "description": "The deploy partially succeeded."
721
+ },
722
+ {
723
+ "name": "InProgress (69)",
724
+ "description": "The deploy is in progress."
725
+ },
726
+ {
727
+ "name": "Pending (69)",
728
+ "description": "The deploy is pending."
729
+ },
730
+ {
731
+ "name": "Canceling (69)",
732
+ "description": "The deploy is being canceled."
733
+ }
734
+ ]
735
+ },
712
736
  "isESM": true,
713
737
  "relativePath": [
714
738
  "lib",
715
739
  "commands",
716
740
  "project",
717
- "delete",
718
- "tracking.js"
741
+ "deploy",
742
+ "quick.js"
719
743
  ],
720
744
  "aliasPermutations": [
721
- "force:source:tracking:clear",
722
- "source:force:tracking:clear",
723
- "source:tracking:force:clear",
724
- "source:tracking:clear:force",
725
- "force:tracking:source:clear",
726
- "tracking:force:source:clear",
727
- "tracking:source:force:clear",
728
- "tracking:source:clear:force",
729
- "force:tracking:clear:source",
730
- "tracking:force:clear:source",
731
- "tracking:clear:force:source",
732
- "tracking:clear:source:force",
733
- "force:source:clear:tracking",
734
- "source:force:clear:tracking",
735
- "source:clear:force:tracking",
736
- "source:clear:tracking:force",
737
- "force:clear:source:tracking",
738
- "clear:force:source:tracking",
739
- "clear:source:force:tracking",
740
- "clear:source:tracking:force",
741
- "force:clear:tracking:source",
742
- "clear:force:tracking:source",
743
- "clear:tracking:force:source",
744
- "clear:tracking:source:force"
745
+ "deploy:metadata:quick",
746
+ "metadata:deploy:quick",
747
+ "metadata:quick:deploy",
748
+ "deploy:quick:metadata",
749
+ "quick:deploy:metadata",
750
+ "quick:metadata:deploy"
745
751
  ],
746
752
  "permutations": [
747
- "project:delete:tracking",
748
- "delete:project:tracking",
749
- "delete:tracking:project",
750
- "project:tracking:delete",
751
- "tracking:project:delete",
752
- "tracking:delete:project"
753
+ "project:deploy:quick",
754
+ "deploy:project:quick",
755
+ "deploy:quick:project",
756
+ "project:quick:deploy",
757
+ "quick:project:deploy",
758
+ "quick:deploy:project"
753
759
  ]
754
760
  },
755
- "project:generate:manifest": {
761
+ "project:deploy:report": {
756
762
  "aliases": [
757
- "force:source:manifest:create"
763
+ "deploy:metadata:report"
758
764
  ],
759
765
  "args": {},
760
766
  "deprecateAliases": true,
761
- "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 flags, 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 flag, 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.\n\nTo build a manifest from the metadata in an org, use the --from-org flag. You can combine --from-org with the --metadata flag to include only certain metadata types, or with the --excluded-metadata flag to exclude certain metadata types. When building a manifest from an org, the command makes many concurrent API calls to discover the metadata that exists in the org. To limit the number of concurrent requests, use the SF_LIST_METADATA_BATCH_SIZE environment variable and set it to a size that works best for your org and environment. If you experience timeouts or inconsistent manifest contents, then setting this environment variable can improve accuracy. However, the command takes longer to run because it sends fewer requests at a time.",
767
+ "description": "Deploy operations include standard deploys, quick deploys, deploy validations, and deploy cancellations.\n\nRun this command by either passing it a job ID or specifying the --use-most-recent flag to use the job ID of the most recent deploy operation. If you specify the --wait flag, the command polls for the status every second until the timeout of --wait minutes. If you don't specify the --wait flag, the command simply checks and displays the status of the deploy; the command doesn't poll for the status.\n\nYou typically don't specify the --target-org flag because the cached job already references the org to which you deployed. But if you run this command on a computer different than the one from which you deployed, then you must specify the --target-org and it must point to the same org.\n\nThis command doesn't update source tracking information.",
762
768
  "examples": [
763
- "Create a manifest for deploying or retrieving all Apex classes and custom objects:\n$ <%= config.bin %> <%= command.id %> --metadata ApexClass --metadata CustomObject",
764
- "Create a manifest for deleting the specified Apex class:\n$ <%= config.bin %> <%= command.id %> --metadata ApexClass:MyApexClass --type destroy",
765
- "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",
766
- "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",
767
- "Create a manifest from specific metadata types in an org:\n$ <%= config.bin %> <%= command.id %> --from-org test@myorg.com --metadata ApexClass,CustomObject,CustomLabels",
768
- "Create a manifest from all metadata components in an org excluding specific metadata types:\n$ <%= config.bin %> <%= command.id %> --from-org test@myorg.com --excluded-metadata StandardValueSet"
769
+ "Check the status using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
770
+ "Check the status of the most recent deploy operation:\n<%= config.bin %> <%= command.id %> --use-most-recent",
771
+ "Poll for the status using a job ID and target org:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2 --target-org me@my.org --wait 30"
769
772
  ],
770
773
  "flags": {
771
774
  "json": {
@@ -783,213 +786,133 @@
783
786
  "multiple": false,
784
787
  "type": "option"
785
788
  },
786
- "api-version": {
787
- "aliases": [
788
- "apiversion"
789
- ],
790
- "deprecateAliases": true,
791
- "description": "Override the api version used for api requests made by this command",
792
- "name": "api-version",
793
- "hasDynamicHelp": false,
789
+ "target-org": {
790
+ "char": "o",
791
+ "name": "target-org",
792
+ "noCacheDefault": true,
793
+ "summary": "Username or alias of the target org.",
794
+ "hasDynamicHelp": true,
794
795
  "multiple": false,
795
796
  "type": "option"
796
797
  },
797
- "loglevel": {
798
- "deprecated": {
799
- "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
800
- },
801
- "hidden": true,
802
- "name": "loglevel",
798
+ "job-id": {
799
+ "char": "i",
800
+ "description": "These commands return a job ID if they time out or you specified the --async flag:\n\n- <%= config.bin %> project deploy start\n- <%= config.bin %> project deploy validate\n- <%= config.bin %> project deploy quick\n- <%= config.bin %> project deploy cancel\n\nThe job ID is valid for 10 days from when you started the deploy operation.",
801
+ "name": "job-id",
802
+ "summary": "Job ID of the deploy operation you want to check the status of.",
803
803
  "hasDynamicHelp": false,
804
804
  "multiple": false,
805
805
  "type": "option"
806
806
  },
807
- "metadata": {
808
- "char": "m",
809
- "name": "metadata",
810
- "summary": "Names of metadata components to include in the manifest.",
811
- "delimiter": ",",
812
- "hasDynamicHelp": false,
813
- "multiple": true,
814
- "type": "option"
807
+ "use-most-recent": {
808
+ "char": "r",
809
+ "description": "For performance reasons, this flag uses job IDs for deploy operations that started only in the past 3 days or less. If your most recent operation was more than 3 days ago, this flag won't find a job ID.",
810
+ "name": "use-most-recent",
811
+ "summary": "Use the job ID of the most recent deploy operation.",
812
+ "allowNo": false,
813
+ "type": "boolean"
815
814
  },
816
- "source-dir": {
817
- "aliases": [
818
- "sourcepath"
819
- ],
820
- "char": "p",
821
- "deprecateAliases": true,
822
- "name": "source-dir",
823
- "summary": "Paths to the local source files to include in the manifest.",
824
- "delimiter": ",",
815
+ "coverage-formatters": {
816
+ "description": "For multiple formatters, repeat the flag for each formatter.\n--coverage-formatters lcov --coverage-formatters clover",
817
+ "helpGroup": "Test",
818
+ "name": "coverage-formatters",
819
+ "summary": "Format of the code coverage results.",
825
820
  "hasDynamicHelp": false,
826
821
  "multiple": true,
822
+ "options": [
823
+ "clover",
824
+ "cobertura",
825
+ "html-spa",
826
+ "html",
827
+ "json",
828
+ "json-summary",
829
+ "lcovonly",
830
+ "none",
831
+ "teamcity",
832
+ "text",
833
+ "text-summary"
834
+ ],
827
835
  "type": "option"
828
836
  },
829
- "name": {
830
- "aliases": [
831
- "manifestname"
832
- ],
833
- "char": "n",
834
- "deprecateAliases": true,
835
- "exclusive": [
836
- "type"
837
+ "junit": {
838
+ "helpGroup": "Test",
839
+ "name": "junit",
840
+ "summary": "Output JUnit test results.",
841
+ "allowNo": false,
842
+ "type": "boolean"
843
+ },
844
+ "results-dir": {
845
+ "helpGroup": "Test",
846
+ "name": "results-dir",
847
+ "relationships": [
848
+ {
849
+ "type": "some",
850
+ "flags": [
851
+ "coverage-formatters",
852
+ "junit"
853
+ ]
854
+ }
837
855
  ],
838
- "name": "name",
839
- "summary": "Name of a custom manifest file to create.",
856
+ "summary": "Output directory for code coverage and JUnit results; defaults to the deploy ID.",
840
857
  "hasDynamicHelp": false,
841
858
  "multiple": false,
842
859
  "type": "option"
843
860
  },
844
- "type": {
845
- "aliases": [
846
- "manifesttype"
847
- ],
848
- "char": "t",
849
- "deprecateAliases": true,
850
- "exclusive": [
851
- "name"
852
- ],
853
- "name": "type",
854
- "summary": "Type of manifest to create; the type determines the name of the created file.",
855
- "hasDynamicHelp": false,
856
- "multiple": false,
857
- "options": [
858
- "pre",
859
- "post",
860
- "destroy",
861
- "package"
862
- ],
863
- "type": "option"
864
- },
865
- "include-packages": {
866
- "aliases": [
867
- "includepackages"
868
- ],
869
- "char": "c",
870
- "dependsOn": [
871
- "from-org"
872
- ],
873
- "deprecateAliases": true,
874
- "name": "include-packages",
875
- "summary": "Package types (managed, unlocked) whose metadata is included in the manifest; by default, metadata in managed and unlocked packages is excluded. Metadata in unmanaged packages is always included.",
876
- "delimiter": ",",
877
- "hasDynamicHelp": false,
878
- "multiple": true,
879
- "options": [
880
- "managed",
881
- "unlocked"
882
- ],
883
- "type": "option"
884
- },
885
- "excluded-metadata": {
886
- "name": "excluded-metadata",
887
- "relationships": [
888
- {
889
- "type": "some",
890
- "flags": [
891
- "from-org",
892
- "source-dir"
893
- ]
894
- }
895
- ],
896
- "summary": "Metadata types to exclude when building a manifest from an org. Specify the name of the type, not the name of a specific component.",
897
- "delimiter": ",",
898
- "hasDynamicHelp": false,
899
- "multiple": true,
900
- "type": "option"
901
- },
902
- "from-org": {
903
- "aliases": [
904
- "fromorg"
905
- ],
906
- "deprecateAliases": true,
907
- "exclusive": [
908
- "source-dir"
909
- ],
910
- "name": "from-org",
911
- "summary": "Username or alias of the org that contains the metadata components from which to build a manifest.",
912
- "hasDynamicHelp": false,
913
- "multiple": false,
914
- "type": "option"
915
- },
916
- "output-dir": {
917
- "aliases": [
918
- "outputdir",
919
- "o"
920
- ],
921
- "char": "d",
922
- "deprecateAliases": true,
923
- "name": "output-dir",
924
- "summary": "Directory to save the created manifest.",
925
- "hasDynamicHelp": false,
861
+ "wait": {
862
+ "char": "w",
863
+ "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\".",
864
+ "name": "wait",
865
+ "summary": "Number of minutes to wait for command to complete and display results.",
866
+ "hasDynamicHelp": true,
867
+ "helpValue": "<minutes>",
926
868
  "multiple": false,
927
869
  "type": "option"
928
870
  }
929
871
  },
930
- "hasDynamicHelp": false,
872
+ "hasDynamicHelp": true,
931
873
  "hiddenAliases": [],
932
- "id": "project:generate:manifest",
874
+ "id": "project:deploy:report",
933
875
  "pluginAlias": "@salesforce/plugin-deploy-retrieve",
934
876
  "pluginName": "@salesforce/plugin-deploy-retrieve",
935
877
  "pluginType": "core",
936
878
  "strict": true,
937
- "summary": "Create a project manifest that lists the metadata components you want to deploy or retrieve.",
879
+ "summary": "Check or poll for the status of a deploy operation.",
938
880
  "enableJsonFlag": true,
939
- "requiresProject": true,
940
881
  "isESM": true,
941
882
  "relativePath": [
942
883
  "lib",
943
884
  "commands",
944
885
  "project",
945
- "generate",
946
- "manifest.js"
886
+ "deploy",
887
+ "report.js"
947
888
  ],
948
889
  "aliasPermutations": [
949
- "force:source:manifest:create",
950
- "source:force:manifest:create",
951
- "source:manifest:force:create",
952
- "source:manifest:create:force",
953
- "force:manifest:source:create",
954
- "manifest:force:source:create",
955
- "manifest:source:force:create",
956
- "manifest:source:create:force",
957
- "force:manifest:create:source",
958
- "manifest:force:create:source",
959
- "manifest:create:force:source",
960
- "manifest:create:source:force",
961
- "force:source:create:manifest",
962
- "source:force:create:manifest",
963
- "source:create:force:manifest",
964
- "source:create:manifest:force",
965
- "force:create:source:manifest",
966
- "create:force:source:manifest",
967
- "create:source:force:manifest",
968
- "create:source:manifest:force",
969
- "force:create:manifest:source",
970
- "create:force:manifest:source",
971
- "create:manifest:force:source",
972
- "create:manifest:source:force"
890
+ "deploy:metadata:report",
891
+ "metadata:deploy:report",
892
+ "metadata:report:deploy",
893
+ "deploy:report:metadata",
894
+ "report:deploy:metadata",
895
+ "report:metadata:deploy"
973
896
  ],
974
897
  "permutations": [
975
- "project:generate:manifest",
976
- "generate:project:manifest",
977
- "generate:manifest:project",
978
- "project:manifest:generate",
979
- "manifest:project:generate",
980
- "manifest:generate:project"
898
+ "project:deploy:report",
899
+ "deploy:project:report",
900
+ "deploy:report:project",
901
+ "project:report:deploy",
902
+ "report:project:deploy",
903
+ "report:deploy:project"
981
904
  ]
982
905
  },
983
- "project:deploy:cancel": {
906
+ "project:deploy:resume": {
984
907
  "aliases": [
985
- "deploy:metadata:cancel"
908
+ "deploy:metadata:resume"
986
909
  ],
987
910
  "args": {},
988
911
  "deprecateAliases": true,
989
- "description": "Use this command to cancel a deploy operation that hasn't yet completed in the org. Deploy operations include standard deploys, quick deploys, deploy validations, and deploy cancellations.\n\nRun this command by either passing it a job ID or specifying the --use-most-recent flag to use the job ID of the most recent deploy operation.",
912
+ "description": "Use this command to resume watching a deploy operation if the original command times out or you specified the --async flag. Deploy operations include standard deploys, quick deploys, deploy validations, and deploy cancellations. This command doesn't resume the original operation itself, because the operation always continues after you've started it, regardless of whether you're watching it or not. When the deploy completes, source tracking information is updated as needed.\n\nRun this command by either passing it a job ID or specifying the --use-most-recent flag to use the job ID of the most recent deploy operation.",
990
913
  "examples": [
991
- "Cancel a deploy operation using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
992
- "Cancel the most recent deploy operation:\n<%= config.bin %> <%= command.id %> --use-most-recent"
914
+ "Resume watching a deploy operation using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
915
+ "Resume watching the most recent deploy operation:\n<%= config.bin %> <%= command.id %> --use-most-recent"
993
916
  ],
994
917
  "flags": {
995
918
  "json": {
@@ -1007,22 +930,12 @@
1007
930
  "multiple": false,
1008
931
  "type": "option"
1009
932
  },
1010
- "target-org": {
1011
- "char": "o",
1012
- "name": "target-org",
1013
- "noCacheDefault": true,
1014
- "summary": "Username or alias of the target org.",
1015
- "hasDynamicHelp": true,
1016
- "multiple": false,
1017
- "type": "option"
1018
- },
1019
- "async": {
1020
- "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\".",
933
+ "concise": {
1021
934
  "exclusive": [
1022
- "wait"
935
+ "verbose"
1023
936
  ],
1024
- "name": "async",
1025
- "summary": "Run the command asynchronously.",
937
+ "name": "concise",
938
+ "summary": "Show concise output of the deploy operation result.",
1026
939
  "allowNo": false,
1027
940
  "type": "boolean"
1028
941
  },
@@ -1030,80 +943,183 @@
1030
943
  "char": "i",
1031
944
  "description": "These commands return a job ID if they time out or you specified the --async flag:\n\n- <%= config.bin %> project deploy start\n- <%= config.bin %> project deploy validate\n- <%= config.bin %> project deploy quick\n- <%= config.bin %> project deploy cancel\n\nThe job ID is valid for 10 days from when you started the deploy operation.",
1032
945
  "name": "job-id",
1033
- "summary": "Job ID of the deploy operation you want to cancel.",
946
+ "summary": "Job ID of the deploy operation you want to resume.",
1034
947
  "hasDynamicHelp": false,
1035
948
  "multiple": false,
1036
949
  "type": "option"
1037
950
  },
1038
951
  "use-most-recent": {
1039
952
  "char": "r",
1040
- "description": "For performance reasons, this flag uses job IDs for deploy operations that started only in the past 3 days or less. If your most recent deploy operations was more than 3 days ago, this flag won't find a job ID.",
953
+ "description": "For performance reasons, this flag uses job IDs for deploy operations that started only in the past 3 days or less. If your most recent operation was more than 3 days ago, this flag won't find a job ID.",
1041
954
  "name": "use-most-recent",
1042
955
  "summary": "Use the job ID of the most recent deploy operation.",
1043
956
  "allowNo": false,
1044
957
  "type": "boolean"
1045
958
  },
1046
- "wait": {
1047
- "char": "w",
1048
- "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\".",
959
+ "verbose": {
1049
960
  "exclusive": [
1050
- "async"
961
+ "concise"
1051
962
  ],
963
+ "name": "verbose",
964
+ "summary": "Show verbose output of the deploy operation result.",
965
+ "allowNo": false,
966
+ "type": "boolean"
967
+ },
968
+ "wait": {
969
+ "char": "w",
970
+ "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 deploy operation, run this command again. To check the status of the deploy operation, run \"<%= config.bin %> project deploy report\".",
1052
971
  "name": "wait",
1053
972
  "summary": "Number of minutes to wait for the command to complete and display results.",
1054
973
  "hasDynamicHelp": true,
1055
974
  "helpValue": "<minutes>",
1056
975
  "multiple": false,
1057
976
  "type": "option"
977
+ },
978
+ "coverage-formatters": {
979
+ "description": "For multiple formatters, repeat the flag for each formatter.\n--coverage-formatters lcov --coverage-formatters clover",
980
+ "helpGroup": "Test",
981
+ "name": "coverage-formatters",
982
+ "summary": "Format of the code coverage results.",
983
+ "hasDynamicHelp": false,
984
+ "multiple": true,
985
+ "options": [
986
+ "clover",
987
+ "cobertura",
988
+ "html-spa",
989
+ "html",
990
+ "json",
991
+ "json-summary",
992
+ "lcovonly",
993
+ "none",
994
+ "teamcity",
995
+ "text",
996
+ "text-summary"
997
+ ],
998
+ "type": "option"
999
+ },
1000
+ "junit": {
1001
+ "helpGroup": "Test",
1002
+ "name": "junit",
1003
+ "summary": "Output JUnit test results.",
1004
+ "allowNo": false,
1005
+ "type": "boolean"
1006
+ },
1007
+ "results-dir": {
1008
+ "helpGroup": "Test",
1009
+ "name": "results-dir",
1010
+ "relationships": [
1011
+ {
1012
+ "type": "some",
1013
+ "flags": [
1014
+ "coverage-formatters",
1015
+ "junit"
1016
+ ]
1017
+ }
1018
+ ],
1019
+ "summary": "Output directory for code coverage and JUnit results; defaults to the deploy ID.",
1020
+ "hasDynamicHelp": false,
1021
+ "multiple": false,
1022
+ "type": "option"
1058
1023
  }
1059
1024
  },
1060
1025
  "hasDynamicHelp": true,
1061
1026
  "hiddenAliases": [],
1062
- "id": "project:deploy:cancel",
1027
+ "id": "project:deploy:resume",
1063
1028
  "pluginAlias": "@salesforce/plugin-deploy-retrieve",
1064
1029
  "pluginName": "@salesforce/plugin-deploy-retrieve",
1065
1030
  "pluginType": "core",
1066
1031
  "strict": true,
1067
- "summary": "Cancel a deploy operation.",
1032
+ "summary": "Resume watching a deploy operation and update source tracking when the deploy completes.",
1068
1033
  "enableJsonFlag": true,
1034
+ "envVariablesSection": {
1035
+ "header": "ENVIRONMENT VARIABLES",
1036
+ "body": [
1037
+ {
1038
+ "name": "SF_USE_PROGRESS_BAR",
1039
+ "description": "Set to false to disable the progress bar when running the metadata deploy command."
1040
+ }
1041
+ ]
1042
+ },
1043
+ "errorCodes": {
1044
+ "header": "ERROR CODES",
1045
+ "body": [
1046
+ {
1047
+ "name": "Succeeded (0)",
1048
+ "description": "The deploy succeeded."
1049
+ },
1050
+ {
1051
+ "name": "Canceled (1)",
1052
+ "description": "The deploy was canceled."
1053
+ },
1054
+ {
1055
+ "name": "Failed (1)",
1056
+ "description": "The deploy failed."
1057
+ },
1058
+ {
1059
+ "name": "SucceededPartial (68)",
1060
+ "description": "The deploy partially succeeded."
1061
+ },
1062
+ {
1063
+ "name": "InProgress (69)",
1064
+ "description": "The deploy is in progress."
1065
+ },
1066
+ {
1067
+ "name": "Pending (69)",
1068
+ "description": "The deploy is pending."
1069
+ },
1070
+ {
1071
+ "name": "Canceling (69)",
1072
+ "description": "The deploy is being canceled."
1073
+ }
1074
+ ]
1075
+ },
1069
1076
  "isESM": true,
1070
1077
  "relativePath": [
1071
1078
  "lib",
1072
1079
  "commands",
1073
1080
  "project",
1074
1081
  "deploy",
1075
- "cancel.js"
1082
+ "resume.js"
1076
1083
  ],
1077
1084
  "aliasPermutations": [
1078
- "deploy:metadata:cancel",
1079
- "metadata:deploy:cancel",
1080
- "metadata:cancel:deploy",
1081
- "deploy:cancel:metadata",
1082
- "cancel:deploy:metadata",
1083
- "cancel:metadata:deploy"
1085
+ "deploy:metadata:resume",
1086
+ "metadata:deploy:resume",
1087
+ "metadata:resume:deploy",
1088
+ "deploy:resume:metadata",
1089
+ "resume:deploy:metadata",
1090
+ "resume:metadata:deploy"
1084
1091
  ],
1085
1092
  "permutations": [
1086
- "project:deploy:cancel",
1087
- "deploy:project:cancel",
1088
- "deploy:cancel:project",
1089
- "project:cancel:deploy",
1090
- "cancel:project:deploy",
1091
- "cancel:deploy:project"
1093
+ "project:deploy:resume",
1094
+ "deploy:project:resume",
1095
+ "deploy:resume:project",
1096
+ "project:resume:deploy",
1097
+ "resume:project:deploy",
1098
+ "resume:deploy:project"
1092
1099
  ]
1093
1100
  },
1094
- "project:deploy:preview": {
1101
+ "project:deploy:start": {
1095
1102
  "aliases": [
1096
- "deploy:metadata:preview"
1103
+ "deploy:metadata"
1097
1104
  ],
1098
1105
  "args": {},
1099
1106
  "deprecateAliases": true,
1100
- "description": "You must run this command from within a project.\n\nThe command outputs a table that describes what will happen if you run the \"<%= config.bin %> project deploy start\" command. The table lists the metadata components that will be deployed and deleted. The table also lists the current conflicts between files in your local project and components in the org. Finally, the table lists the files that won't be deployed because they're included in your .forceignore file.\n\nIf your org allows source tracking, then this command displays potential conflicts between the org and your local project. Some orgs, such as production org, never allow source tracking. Source tracking is enabled by default on scratch and sandbox orgs; you can disable source tracking when you create the orgs by specifying the --no-track-source flag on the \"<%= config.bin %> org create scratch|sandbox\" commands.\n\nTo preview the deployment of 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 --source-dir.",
1107
+ "description": "You must run this command from within a project.\n\nMetadata components are deployed in source format by default. Deploy them in metadata format by specifying the --metadata-dir flag, which specifies the root directory or ZIP file that contains the metadata formatted files you want to deploy.\n\nIf your org allows source tracking, then this command tracks the changes in your source. Some orgs, such as production orgs, never allow source tracking. Source tracking is enabled by default on scratch and sandbox orgs; you can disable source tracking when you create the orgs by specifying the --no-track-source flag on the \"<%= config.bin %> org create scratch|sandbox\" commands.\n\nTo deploy 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 --source-dir.",
1101
1108
  "examples": [
1102
- "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.",
1103
- "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",
1104
- "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",
1105
- "Preview deployment of a specific Apex class:\n<%= config.bin %> <%= command.id %> --metadata ApexClass:MyApexClass",
1106
- "Preview deployment of all components listed in a manifest:\n<%= config.bin %> <%= command.id %> --manifest path/to/package.xml"
1109
+ "Deploy local changes not in the org; uses your default org:\n<%= config.bin %> <%= command.id %>",
1110
+ "Deploy all source files in the \"force-app\" directory to an org with alias \"my-scratch\"; show only concise output, in other words don't print a list of all the source that was deployed:\n<%= config.bin %> <%= command.id %> --source-dir force-app --target-org my-scratch --concise",
1111
+ "Deploy all the Apex classes and custom objects that are in the \"force-app\" directory. The list views, layouts, etc, that are associated with the custom objects are also deployed. Both examples are equivalent:\n<%= config.bin %> <%= command.id %> --source-dir force-app/main/default/classes force-app/main/default/objects\n<%= config.bin %> <%= command.id %> --source-dir force-app/main/default/classes --source-dir force-app/main/default/objects",
1112
+ "Deploy all Apex classes that are in all package directories defined in the \"sfdx-project.json\" file:\n<%= config.bin %> <%= command.id %> --metadata ApexClass",
1113
+ "Deploy a specific Apex class; ignore any conflicts between the local project and org (be careful with this flag, because it will overwrite the Apex class in the org if there are conflicts!):\n<%= config.bin %> <%= command.id %> --metadata ApexClass:MyApexClass --ignore-conflicts",
1114
+ "Deploy specific Apex classes that match a pattern; in this example, deploy Apex classes whose names contain the string \"MyApex\". Also ignore any deployment warnings (again, be careful with this flag! You typically want to see the warnings):\n<%= config.bin %> <%= command.id %> --metadata 'ApexClass:MyApex*' --ignore-warnings",
1115
+ "Deploy a custom object called ExcitingObject that's in the SBQQ namespace:\nsf <%= command.id %> --metadata CustomObject:SBQQ__ExcitingObject",
1116
+ "Deploy all custom objects in the SBQQ namespace by using a wildcard and quotes:\nsf <%= command.id %> --metadata 'CustomObject:SBQQ__*'",
1117
+ "Deploy all custom objects and Apex classes found in all defined package directories (both examples are equivalent):\n<%= config.bin %> <%= command.id %> --metadata CustomObject ApexClass\n<%= config.bin %> <%= command.id %> --metadata CustomObject --metadata ApexClass",
1118
+ "Deploy all Apex classes and a profile that has a space in its name:\n<%= config.bin %> <%= command.id %> --metadata ApexClass --metadata \"Profile:My Profile\"",
1119
+ "Deploy all components listed in a manifest:\n<%= config.bin %> <%= command.id %> --manifest path/to/package.xml",
1120
+ "Run the tests that aren’t in any managed packages as part of a deployment:\n<%= config.bin %> <%= command.id %> --metadata ApexClass --test-level RunLocalTests",
1121
+ "Deploy all metadata formatted files in the \"MDAPI\" directory:\n<%= config.bin %> <%= command.id %> --metadata-dir MDAPI",
1122
+ "Deploy all metadata formatted files in the \"MDAPI\" directory; items listed in the MDAPI/destructiveChangesPre.xml and MDAPI/destructiveChangesPost.xml manifests are immediately eligible for deletion rather than stored in the Recycle Bin:\n<%= config.bin %> <%= command.id %> --metadata-dir MDAPI --purge-on-delete"
1107
1123
  ],
1108
1124
  "flags": {
1109
1125
  "json": {
@@ -1121,11 +1137,61 @@
1121
1137
  "multiple": false,
1122
1138
  "type": "option"
1123
1139
  },
1140
+ "api-version": {
1141
+ "char": "a",
1142
+ "description": "Use this flag to override the default API version with the API version of your package.xml file. The default API version is the latest version supported by the CLI.",
1143
+ "name": "api-version",
1144
+ "summary": "Target API version for the deploy.",
1145
+ "hasDynamicHelp": false,
1146
+ "multiple": false,
1147
+ "type": "option"
1148
+ },
1149
+ "async": {
1150
+ "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\".",
1151
+ "exclusive": [
1152
+ "wait"
1153
+ ],
1154
+ "name": "async",
1155
+ "summary": "Run the command asynchronously.",
1156
+ "allowNo": false,
1157
+ "type": "boolean"
1158
+ },
1159
+ "concise": {
1160
+ "exclusive": [
1161
+ "verbose"
1162
+ ],
1163
+ "name": "concise",
1164
+ "summary": "Show concise output of the deploy result.",
1165
+ "allowNo": false,
1166
+ "type": "boolean"
1167
+ },
1168
+ "dry-run": {
1169
+ "name": "dry-run",
1170
+ "summary": "Validate deploy and run Apex tests but don’t save to the org.",
1171
+ "allowNo": false,
1172
+ "type": "boolean"
1173
+ },
1124
1174
  "ignore-conflicts": {
1125
1175
  "char": "c",
1126
1176
  "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.",
1127
1177
  "name": "ignore-conflicts",
1128
- "summary": "Don't display conflicts in preview of the deployment.",
1178
+ "summary": "Ignore conflicts and deploy local files, even if they overwrite changes in the org.",
1179
+ "allowNo": false,
1180
+ "type": "boolean"
1181
+ },
1182
+ "ignore-errors": {
1183
+ "char": "r",
1184
+ "description": "Never use this flag when deploying to a production org. If you specify it, components without errors are deployed and components with errors are skipped, and could result in an inconsistent production org.",
1185
+ "name": "ignore-errors",
1186
+ "summary": "Ignore any errors and don’t roll back deployment.",
1187
+ "allowNo": false,
1188
+ "type": "boolean"
1189
+ },
1190
+ "ignore-warnings": {
1191
+ "char": "g",
1192
+ "description": "If you specify this flag, and a warning occurs, the success status of the deployment is set to true. If you don't specify this flag, and a warning occurs, then the success status is set to false, and the warning is treated like an error.\n\nThis flag is useful in a CI environment and your deployment includes destructive changes; if you try to delete a component that doesn't exist in the org, you get a warning. In this case, to ensure that the command returns a success value of true, specify this flag.",
1193
+ "name": "ignore-warnings",
1194
+ "summary": "Ignore warnings and allow a deployment to complete successfully.",
1129
1195
  "allowNo": false,
1130
1196
  "type": "boolean"
1131
1197
  },
@@ -1134,10 +1200,12 @@
1134
1200
  "description": "All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.",
1135
1201
  "exclusive": [
1136
1202
  "source-dir",
1137
- "metadata"
1203
+ "metadata",
1204
+ "metadata-dir"
1138
1205
  ],
1206
+ "helpGroup": "Source Format",
1139
1207
  "name": "manifest",
1140
- "summary": "Full file path for manifest (package.xml) of components to preview.",
1208
+ "summary": "Full file path for manifest (package.xml) of components to deploy.",
1141
1209
  "hasDynamicHelp": false,
1142
1210
  "multiple": false,
1143
1211
  "type": "option"
@@ -1146,23 +1214,50 @@
1146
1214
  "char": "m",
1147
1215
  "exclusive": [
1148
1216
  "manifest",
1149
- "source-dir"
1217
+ "source-dir",
1218
+ "metadata-dir"
1150
1219
  ],
1220
+ "helpGroup": "Source Format",
1151
1221
  "name": "metadata",
1152
- "summary": "Metadata component names to preview.",
1222
+ "summary": "Metadata component names to deploy. Wildcards (`*` ) supported as long as you use quotes, such as `ApexClass:MyClass*`.",
1153
1223
  "hasDynamicHelp": false,
1154
1224
  "multiple": true,
1155
1225
  "type": "option"
1156
1226
  },
1227
+ "metadata-dir": {
1228
+ "exclusive": [
1229
+ "manifest",
1230
+ "source-dir",
1231
+ "metadata"
1232
+ ],
1233
+ "helpGroup": "Metadata API Format",
1234
+ "name": "metadata-dir",
1235
+ "summary": "Root of directory or zip file of metadata formatted files to deploy.",
1236
+ "hasDynamicHelp": false,
1237
+ "multiple": false,
1238
+ "type": "option"
1239
+ },
1240
+ "single-package": {
1241
+ "dependsOn": [
1242
+ "metadata-dir"
1243
+ ],
1244
+ "helpGroup": "Metadata API Format",
1245
+ "name": "single-package",
1246
+ "summary": "Indicates that the metadata zip file points to a directory structure for a single package.",
1247
+ "allowNo": false,
1248
+ "type": "boolean"
1249
+ },
1157
1250
  "source-dir": {
1158
1251
  "char": "d",
1159
1252
  "description": "The supplied path 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 subdirectories).\n\nIf you specify this flag, don’t specify --metadata or --manifest.",
1160
1253
  "exclusive": [
1161
1254
  "manifest",
1162
- "metadata"
1255
+ "metadata",
1256
+ "metadata-dir"
1163
1257
  ],
1258
+ "helpGroup": "Source Format",
1164
1259
  "name": "source-dir",
1165
- "summary": "Path to the local source files to preview.",
1260
+ "summary": "Path to the local source files to deploy.",
1166
1261
  "hasDynamicHelp": false,
1167
1262
  "multiple": true,
1168
1263
  "type": "option"
@@ -1177,148 +1272,136 @@
1177
1272
  "multiple": false,
1178
1273
  "type": "option"
1179
1274
  },
1180
- "concise": {
1181
- "name": "concise",
1182
- "summary": "Show only the changes that will be deployed; omits files that are forceignored.",
1183
- "allowNo": false,
1184
- "type": "boolean"
1185
- }
1186
- },
1187
- "hasDynamicHelp": true,
1188
- "hiddenAliases": [],
1189
- "id": "project:deploy:preview",
1190
- "pluginAlias": "@salesforce/plugin-deploy-retrieve",
1191
- "pluginName": "@salesforce/plugin-deploy-retrieve",
1192
- "pluginType": "core",
1193
- "strict": true,
1194
- "summary": "Preview a deployment to see what will deploy to the org, the potential conflicts, and the ignored files.",
1195
- "enableJsonFlag": true,
1196
- "requiresProject": true,
1197
- "isESM": true,
1198
- "relativePath": [
1199
- "lib",
1200
- "commands",
1201
- "project",
1202
- "deploy",
1203
- "preview.js"
1204
- ],
1205
- "aliasPermutations": [
1206
- "deploy:metadata:preview",
1207
- "metadata:deploy:preview",
1208
- "metadata:preview:deploy",
1209
- "deploy:preview:metadata",
1210
- "preview:deploy:metadata",
1211
- "preview:metadata:deploy"
1212
- ],
1213
- "permutations": [
1214
- "project:deploy:preview",
1215
- "deploy:project:preview",
1216
- "deploy:preview:project",
1217
- "project:preview:deploy",
1218
- "preview:project:deploy",
1219
- "preview:deploy:project"
1220
- ]
1221
- },
1222
- "project:deploy:quick": {
1223
- "aliases": [
1224
- "deploy:metadata:quick"
1225
- ],
1226
- "args": {},
1227
- "deprecateAliases": true,
1228
- "description": "Before you run this command, first create a validated deployment with the \"<%= config.bin %> project deploy validate\" command, which returns a job ID. Validated deployments haven't been deployed to the org yet; you deploy them with this command. Either pass the job ID to this command or use the --use-most-recent flag to use the job ID of the most recently validated deployment. For the quick deploy to succeed, the associated validated deployment must also have succeeded.\n\nExecuting this quick deploy command takes less time than a standard deploy because it skips running Apex tests. These tests were previously run as part of the validation. Validating first and then running a quick deploy is useful if the deployment to your production org take several hours and you don’t want to risk a failed deploy.\n\nThis command doesn't support source-tracking. The source you deploy overwrites the corresponding metadata in your org. This command doesn’t attempt to merge your source with the versions in your org.\n\nNote: Don't use this command on sandboxes; the command is intended to be used on production orgs. By default, sandboxes don't run tests during a deploy. Use \"<%= config.bin %> project deploy start\" instead.",
1229
- "examples": [
1230
- "Run a quick deploy to your default org using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
1231
- "Asynchronously run a quick deploy of the most recently validated deployment to an org with alias \"my-prod-org\":\n<%= config.bin %> <%= command.id %> --async --use-most-recent --target-org my-prod-org"
1232
- ],
1233
- "flags": {
1234
- "json": {
1235
- "description": "Format output as json.",
1236
- "helpGroup": "GLOBAL",
1237
- "name": "json",
1238
- "allowNo": false,
1239
- "type": "boolean"
1275
+ "tests": {
1276
+ "char": "t",
1277
+ "description": "If a test name contains a space, enclose it in double quotes.\nFor multiple test names, use one of the following formats:\n\n- Repeat the flag for multiple test names: --tests Test1 --tests Test2 --tests \"Test With Space\"\n- Separate the test names with spaces: --tests Test1 Test2 \"Test With Space\"",
1278
+ "helpGroup": "Test",
1279
+ "name": "tests",
1280
+ "summary": "Apex tests to run when --test-level is RunSpecifiedTests.",
1281
+ "hasDynamicHelp": false,
1282
+ "multiple": true,
1283
+ "type": "option"
1240
1284
  },
1241
- "flags-dir": {
1242
- "helpGroup": "GLOBAL",
1243
- "name": "flags-dir",
1244
- "summary": "Import flag values from a directory.",
1285
+ "test-level": {
1286
+ "char": "l",
1287
+ "description": "Valid values are:\n\n- NoTestRun — No tests are run. This test level applies only to deployments to development environments, such as sandbox, Developer Edition, or trial orgs. This test level is the default for development environments.\n\n- RunSpecifiedTests — Runs only the tests that you specify with the --tests flag. Code coverage requirements differ from the default coverage requirements when using this test level. Executed tests must comprise a minimum of 75% code coverage for each class and trigger in the deployment package. This coverage is computed for each class and trigger individually and is different than the overall coverage percentage.\n\n- RunLocalTests — All tests in your org are run, except the ones that originate from installed managed and unlocked packages. This test level is the default for production deployments that include Apex classes or triggers.\n\n- RunAllTestsInOrg — All tests in your org are run, including tests of managed packages.\n\n If you don’t specify a test level, the default behavior depends on the contents of your deployment package and target org. For more information, see [Running Tests in a Deployment](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy_running_tests.htm) in the \"Metadata API Developer Guide\".",
1288
+ "helpGroup": "Test",
1289
+ "name": "test-level",
1290
+ "summary": "Deployment Apex testing level.",
1245
1291
  "hasDynamicHelp": false,
1246
1292
  "multiple": false,
1293
+ "options": [
1294
+ "NoTestRun",
1295
+ "RunSpecifiedTests",
1296
+ "RunLocalTests",
1297
+ "RunAllTestsInOrg"
1298
+ ],
1247
1299
  "type": "option"
1248
1300
  },
1249
- "async": {
1250
- "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 deploy, run \"<%= config.bin %> project deploy resume\". To check the status of the deploy, run \"<%= config.bin %> project deploy report\".",
1301
+ "verbose": {
1251
1302
  "exclusive": [
1252
- "wait"
1303
+ "concise"
1253
1304
  ],
1254
- "name": "async",
1255
- "summary": "Run the command asynchronously.",
1305
+ "name": "verbose",
1306
+ "summary": "Show verbose output of the deploy result.",
1256
1307
  "allowNo": false,
1257
1308
  "type": "boolean"
1258
1309
  },
1259
- "concise": {
1310
+ "wait": {
1311
+ "char": "w",
1312
+ "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\".",
1260
1313
  "exclusive": [
1261
- "verbose"
1314
+ "async"
1262
1315
  ],
1263
- "name": "concise",
1264
- "summary": "Show concise output of the deploy result.",
1265
- "allowNo": false,
1266
- "type": "boolean"
1267
- },
1268
- "job-id": {
1269
- "char": "i",
1270
- "description": "The job ID is valid for 10 days from when you started the validation.",
1271
- "name": "job-id",
1272
- "summary": "Job ID of the deployment you want to quick deploy.",
1273
- "hasDynamicHelp": false,
1316
+ "name": "wait",
1317
+ "summary": "Number of minutes to wait for command to complete and display results.",
1318
+ "hasDynamicHelp": true,
1319
+ "helpValue": "<minutes>",
1274
1320
  "multiple": false,
1275
1321
  "type": "option"
1276
1322
  },
1277
- "target-org": {
1278
- "char": "o",
1279
- "name": "target-org",
1280
- "noCacheDefault": true,
1281
- "summary": "Username or alias of the target org.",
1282
- "hasDynamicHelp": true,
1283
- "multiple": false,
1284
- "type": "option"
1285
- },
1286
- "use-most-recent": {
1287
- "char": "r",
1288
- "description": "For performance reasons, this flag uses only job IDs that were validated in the past 3 days or less. If your most recent deployment validation was more than 3 days ago, this flag won't find a job ID.",
1289
- "name": "use-most-recent",
1290
- "summary": "Use the job ID of the most recently validated deployment.",
1323
+ "purge-on-delete": {
1324
+ "helpGroup": "Delete",
1325
+ "name": "purge-on-delete",
1326
+ "relationships": [
1327
+ {
1328
+ "type": "some",
1329
+ "flags": [
1330
+ "pre-destructive-changes",
1331
+ "manifest",
1332
+ "metadata-dir",
1333
+ "post-destructive-changes"
1334
+ ]
1335
+ }
1336
+ ],
1337
+ "summary": "Specify that deleted components in the destructive changes manifest file are immediately eligible for deletion rather than being stored in the Recycle Bin.",
1291
1338
  "allowNo": false,
1292
1339
  "type": "boolean"
1293
1340
  },
1294
- "verbose": {
1295
- "exclusive": [
1296
- "concise"
1341
+ "pre-destructive-changes": {
1342
+ "dependsOn": [
1343
+ "manifest"
1297
1344
  ],
1298
- "name": "verbose",
1299
- "summary": "Show verbose output of the deploy result.",
1300
- "allowNo": false,
1301
- "type": "boolean"
1345
+ "helpGroup": "Delete",
1346
+ "name": "pre-destructive-changes",
1347
+ "summary": "File path for a manifest (destructiveChangesPre.xml) of components to delete before the deploy.",
1348
+ "hasDynamicHelp": false,
1349
+ "multiple": false,
1350
+ "type": "option"
1302
1351
  },
1303
- "wait": {
1304
- "char": "w",
1305
- "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 deploy, run \"<%= config.bin %> project deploy resume\". To check the status of the deploy, run \"<%= config.bin %> project deploy report\".",
1306
- "exclusive": [
1307
- "async"
1352
+ "post-destructive-changes": {
1353
+ "dependsOn": [
1354
+ "manifest"
1308
1355
  ],
1309
- "name": "wait",
1310
- "summary": "Number of minutes to wait for the command to complete and display results.",
1311
- "default": "33 minutes",
1312
- "hasDynamicHelp": true,
1313
- "helpValue": "<minutes>",
1356
+ "helpGroup": "Delete",
1357
+ "name": "post-destructive-changes",
1358
+ "summary": "File path for a manifest (destructiveChangesPost.xml) of components to delete after the deploy.",
1359
+ "hasDynamicHelp": false,
1314
1360
  "multiple": false,
1315
1361
  "type": "option"
1316
1362
  },
1317
- "api-version": {
1318
- "char": "a",
1319
- "description": "Use this flag to override the default API version with the API version of your package.xml file. The default API version is the latest version supported by the CLI.",
1320
- "name": "api-version",
1321
- "summary": "Target API version for the deploy.",
1363
+ "coverage-formatters": {
1364
+ "description": "For multiple formatters, repeat the flag for each formatter.\n--coverage-formatters lcov --coverage-formatters clover",
1365
+ "helpGroup": "Test",
1366
+ "name": "coverage-formatters",
1367
+ "summary": "Format of the code coverage results.",
1368
+ "hasDynamicHelp": false,
1369
+ "multiple": true,
1370
+ "options": [
1371
+ "clover",
1372
+ "cobertura",
1373
+ "html-spa",
1374
+ "html",
1375
+ "json",
1376
+ "json-summary",
1377
+ "lcovonly",
1378
+ "none",
1379
+ "teamcity",
1380
+ "text",
1381
+ "text-summary"
1382
+ ],
1383
+ "type": "option"
1384
+ },
1385
+ "junit": {
1386
+ "helpGroup": "Test",
1387
+ "name": "junit",
1388
+ "summary": "Output JUnit test results.",
1389
+ "allowNo": false,
1390
+ "type": "boolean"
1391
+ },
1392
+ "results-dir": {
1393
+ "helpGroup": "Test",
1394
+ "name": "results-dir",
1395
+ "relationships": [
1396
+ {
1397
+ "type": "some",
1398
+ "flags": [
1399
+ "coverage-formatters",
1400
+ "junit"
1401
+ ]
1402
+ }
1403
+ ],
1404
+ "summary": "Output directory for code coverage and JUnit results; defaults to the deploy ID.",
1322
1405
  "hasDynamicHelp": false,
1323
1406
  "multiple": false,
1324
1407
  "type": "option"
@@ -1326,13 +1409,39 @@
1326
1409
  },
1327
1410
  "hasDynamicHelp": true,
1328
1411
  "hiddenAliases": [],
1329
- "id": "project:deploy:quick",
1412
+ "id": "project:deploy:start",
1330
1413
  "pluginAlias": "@salesforce/plugin-deploy-retrieve",
1331
1414
  "pluginName": "@salesforce/plugin-deploy-retrieve",
1332
1415
  "pluginType": "core",
1333
1416
  "strict": true,
1334
- "summary": "Quickly deploy a validated deployment to an org.",
1417
+ "summary": "Deploy metadata to an org from your local project.",
1335
1418
  "enableJsonFlag": true,
1419
+ "configurationVariablesSection": {
1420
+ "header": "CONFIGURATION VARIABLES",
1421
+ "body": [
1422
+ {
1423
+ "name": "target-org",
1424
+ "description": "Username or alias of the org that all commands run against by default. (sf only)"
1425
+ },
1426
+ {
1427
+ "name": "org-api-version",
1428
+ "description": "API version of your project. Default: API version of your Dev Hub org."
1429
+ }
1430
+ ]
1431
+ },
1432
+ "envVariablesSection": {
1433
+ "header": "ENVIRONMENT VARIABLES",
1434
+ "body": [
1435
+ {
1436
+ "name": "SF_TARGET_ORG",
1437
+ "description": "Username or alias of your default org. Overrides the target-org configuration variable."
1438
+ },
1439
+ {
1440
+ "name": "SF_USE_PROGRESS_BAR",
1441
+ "description": "Set to false to disable the progress bar when running the metadata deploy command."
1442
+ }
1443
+ ]
1444
+ },
1336
1445
  "errorCodes": {
1337
1446
  "header": "ERROR CODES",
1338
1447
  "body": [
@@ -1372,36 +1481,34 @@
1372
1481
  "commands",
1373
1482
  "project",
1374
1483
  "deploy",
1375
- "quick.js"
1484
+ "start.js"
1376
1485
  ],
1377
1486
  "aliasPermutations": [
1378
- "deploy:metadata:quick",
1379
- "metadata:deploy:quick",
1380
- "metadata:quick:deploy",
1381
- "deploy:quick:metadata",
1382
- "quick:deploy:metadata",
1383
- "quick:metadata:deploy"
1487
+ "deploy:metadata",
1488
+ "metadata:deploy"
1384
1489
  ],
1385
1490
  "permutations": [
1386
- "project:deploy:quick",
1387
- "deploy:project:quick",
1388
- "deploy:quick:project",
1389
- "project:quick:deploy",
1390
- "quick:project:deploy",
1391
- "quick:deploy:project"
1491
+ "project:deploy:start",
1492
+ "deploy:project:start",
1493
+ "deploy:start:project",
1494
+ "project:start:deploy",
1495
+ "start:project:deploy",
1496
+ "start:deploy:project"
1392
1497
  ]
1393
1498
  },
1394
- "project:deploy:report": {
1499
+ "project:deploy:validate": {
1395
1500
  "aliases": [
1396
- "deploy:metadata:report"
1501
+ "deploy:metadata:validate"
1397
1502
  ],
1398
1503
  "args": {},
1399
1504
  "deprecateAliases": true,
1400
- "description": "Deploy operations include standard deploys, quick deploys, deploy validations, and deploy cancellations.\n\nRun this command by either passing it a job ID or specifying the --use-most-recent flag to use the job ID of the most recent deploy operation. If you specify the --wait flag, the command polls for the status every second until the timeout of --wait minutes. If you don't specify the --wait flag, the command simply checks and displays the status of the deploy; the command doesn't poll for the status.\n\nYou typically don't specify the --target-org flag because the cached job already references the org to which you deployed. But if you run this command on a computer different than the one from which you deployed, then you must specify the --target-org and it must point to the same org.\n\nThis command doesn't update source tracking information.",
1505
+ "description": "Use this command to verify whether a deployment will succeed without actually deploying the metadata to your org. This command is similar to \"<%= config.bin %> project deploy start\", except you're required to run Apex tests, and the command returns a job ID rather than executing the deployment. If the validation succeeds, then you pass this job ID to the \"<%= config.bin %> project deploy quick\" command to actually deploy the metadata. This quick deploy takes less time because it skips running Apex tests. The job ID is valid for 10 days from when you started the validation. Validating first is useful if the deployment to your production org take several hours and you don’t want to risk a failed deploy.\n\nYou must run this command from within a project.\n\nThis command doesn't support source-tracking. When you quick deploy with the resulting job ID, the source you deploy overwrites the corresponding metadata in your org.\n\nTo validate the deployment of 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 --source-dir.\n\nNote: Don't use this command on sandboxes; the command is intended to be used on production orgs. By default, sandboxes don't run tests during a deploy. If you want to validate a deployment with tests on a sandbox, use \"<%= config.bin %> project deploy start --dry-run --test-level RunLocalTests\" instead.",
1401
1506
  "examples": [
1402
- "Check the status using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
1403
- "Check the status of the most recent deploy operation:\n<%= config.bin %> <%= command.id %> --use-most-recent",
1404
- "Poll for the status using a job ID and target org:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2 --target-org me@my.org --wait 30"
1507
+ "NOTE: These examples focus on validating large deployments. See the help for \"<%= config.bin %> project deploy start\" for examples of deploying smaller sets of metadata which you can also use to validate.",
1508
+ "Validate the deployment of all source files in the \"force-app\" directory to the default org:\n<%= config.bin %> <%= command.id %> --source-dir force-app",
1509
+ "Validate the deployment of all source files in two directories: \"force-app\" and \"force-app-utils\":\n<%= config.bin %> <%= command.id %> --source-dir force-app --source-dir force-app-utils",
1510
+ "Asynchronously validate the deployment and run all tests in the org with alias \"my-prod-org\"; command immediately returns the job ID:\n<%= config.bin %> <%= command.id %> --source-dir force-app --async --test-level RunAllTestsInOrg --target-org my-prod-org",
1511
+ "Validate the deployment of all components listed in a manifest:\n<%= config.bin %> <%= command.id %> --manifest path/to/package.xml"
1405
1512
  ],
1406
1513
  "flags": {
1407
1514
  "json": {
@@ -1419,188 +1526,126 @@
1419
1526
  "multiple": false,
1420
1527
  "type": "option"
1421
1528
  },
1422
- "target-org": {
1423
- "char": "o",
1424
- "name": "target-org",
1425
- "noCacheDefault": true,
1426
- "summary": "Username or alias of the target org.",
1427
- "hasDynamicHelp": true,
1428
- "multiple": false,
1429
- "type": "option"
1430
- },
1431
- "job-id": {
1432
- "char": "i",
1433
- "description": "These commands return a job ID if they time out or you specified the --async flag:\n\n- <%= config.bin %> project deploy start\n- <%= config.bin %> project deploy validate\n- <%= config.bin %> project deploy quick\n- <%= config.bin %> project deploy cancel\n\nThe job ID is valid for 10 days from when you started the deploy operation.",
1434
- "name": "job-id",
1435
- "summary": "Job ID of the deploy operation you want to check the status of.",
1529
+ "api-version": {
1530
+ "char": "a",
1531
+ "description": "Use this flag to override the default API version with the API version of your package.xml file. The default API version is the latest version supported by the CLI.",
1532
+ "name": "api-version",
1533
+ "summary": "Target API version for the validation.",
1436
1534
  "hasDynamicHelp": false,
1437
1535
  "multiple": false,
1438
1536
  "type": "option"
1439
1537
  },
1440
- "use-most-recent": {
1441
- "char": "r",
1442
- "description": "For performance reasons, this flag uses job IDs for deploy operations that started only in the past 3 days or less. If your most recent operation was more than 3 days ago, this flag won't find a job ID.",
1443
- "name": "use-most-recent",
1444
- "summary": "Use the job ID of the most recent deploy operation.",
1538
+ "async": {
1539
+ "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 watching the validation, run \"<%= config.bin %> project deploy resume\". To check the status of the validation, run \"<%= config.bin %> project deploy report\".",
1540
+ "name": "async",
1541
+ "summary": "Run the command asynchronously.",
1445
1542
  "allowNo": false,
1446
1543
  "type": "boolean"
1447
1544
  },
1448
- "coverage-formatters": {
1449
- "description": "For multiple formatters, repeat the flag for each formatter.\n--coverage-formatters lcov --coverage-formatters clover",
1450
- "helpGroup": "Test",
1451
- "name": "coverage-formatters",
1452
- "summary": "Format of the code coverage results.",
1453
- "hasDynamicHelp": false,
1454
- "multiple": true,
1455
- "options": [
1456
- "clover",
1457
- "cobertura",
1458
- "html-spa",
1459
- "html",
1460
- "json",
1461
- "json-summary",
1462
- "lcovonly",
1463
- "none",
1464
- "teamcity",
1465
- "text",
1466
- "text-summary"
1545
+ "concise": {
1546
+ "exclusive": [
1547
+ "verbose"
1467
1548
  ],
1468
- "type": "option"
1469
- },
1470
- "junit": {
1471
- "helpGroup": "Test",
1472
- "name": "junit",
1473
- "summary": "Output JUnit test results.",
1549
+ "name": "concise",
1550
+ "summary": "Show concise output of the validation result.",
1474
1551
  "allowNo": false,
1475
1552
  "type": "boolean"
1476
1553
  },
1477
- "results-dir": {
1478
- "helpGroup": "Test",
1479
- "name": "results-dir",
1480
- "relationships": [
1481
- {
1482
- "type": "some",
1483
- "flags": [
1484
- "coverage-formatters",
1485
- "junit"
1486
- ]
1487
- }
1488
- ],
1489
- "summary": "Output directory for code coverage and JUnit results; defaults to the deploy ID.",
1554
+ "manifest": {
1555
+ "char": "x",
1556
+ "description": "All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.",
1557
+ "helpGroup": "Source Format",
1558
+ "name": "manifest",
1559
+ "summary": "Full file path for manifest (package.xml) of components to validate for deployment.",
1490
1560
  "hasDynamicHelp": false,
1491
1561
  "multiple": false,
1492
1562
  "type": "option"
1493
1563
  },
1494
- "wait": {
1495
- "char": "w",
1496
- "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\".",
1497
- "name": "wait",
1498
- "summary": "Number of minutes to wait for command to complete and display results.",
1499
- "hasDynamicHelp": true,
1500
- "helpValue": "<minutes>",
1501
- "multiple": false,
1564
+ "metadata": {
1565
+ "char": "m",
1566
+ "helpGroup": "Source Format",
1567
+ "name": "metadata",
1568
+ "summary": "Metadata component names to validate for deployment.",
1569
+ "hasDynamicHelp": false,
1570
+ "multiple": true,
1502
1571
  "type": "option"
1503
- }
1504
- },
1505
- "hasDynamicHelp": true,
1506
- "hiddenAliases": [],
1507
- "id": "project:deploy:report",
1508
- "pluginAlias": "@salesforce/plugin-deploy-retrieve",
1509
- "pluginName": "@salesforce/plugin-deploy-retrieve",
1510
- "pluginType": "core",
1511
- "strict": true,
1512
- "summary": "Check or poll for the status of a deploy operation.",
1513
- "enableJsonFlag": true,
1514
- "isESM": true,
1515
- "relativePath": [
1516
- "lib",
1517
- "commands",
1518
- "project",
1519
- "deploy",
1520
- "report.js"
1521
- ],
1522
- "aliasPermutations": [
1523
- "deploy:metadata:report",
1524
- "metadata:deploy:report",
1525
- "metadata:report:deploy",
1526
- "deploy:report:metadata",
1527
- "report:deploy:metadata",
1528
- "report:metadata:deploy"
1529
- ],
1530
- "permutations": [
1531
- "project:deploy:report",
1532
- "deploy:project:report",
1533
- "deploy:report:project",
1534
- "project:report:deploy",
1535
- "report:project:deploy",
1536
- "report:deploy:project"
1537
- ]
1538
- },
1539
- "project:deploy:resume": {
1540
- "aliases": [
1541
- "deploy:metadata:resume"
1542
- ],
1543
- "args": {},
1544
- "deprecateAliases": true,
1545
- "description": "Use this command to resume watching a deploy operation if the original command times out or you specified the --async flag. Deploy operations include standard deploys, quick deploys, deploy validations, and deploy cancellations. This command doesn't resume the original operation itself, because the operation always continues after you've started it, regardless of whether you're watching it or not. When the deploy completes, source tracking information is updated as needed.\n\nRun this command by either passing it a job ID or specifying the --use-most-recent flag to use the job ID of the most recent deploy operation.",
1546
- "examples": [
1547
- "Resume watching a deploy operation using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
1548
- "Resume watching the most recent deploy operation:\n<%= config.bin %> <%= command.id %> --use-most-recent"
1549
- ],
1550
- "flags": {
1551
- "json": {
1552
- "description": "Format output as json.",
1553
- "helpGroup": "GLOBAL",
1554
- "name": "json",
1555
- "allowNo": false,
1556
- "type": "boolean"
1557
1572
  },
1558
- "flags-dir": {
1559
- "helpGroup": "GLOBAL",
1560
- "name": "flags-dir",
1561
- "summary": "Import flag values from a directory.",
1573
+ "source-dir": {
1574
+ "char": "d",
1575
+ "description": "The supplied path 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 subdirectories).\n\nIf you specify this flag, don’t specify --metadata or --manifest.",
1576
+ "helpGroup": "Source Format",
1577
+ "name": "source-dir",
1578
+ "summary": "Path to the local source files to validate for deployment.",
1579
+ "hasDynamicHelp": false,
1580
+ "multiple": true,
1581
+ "type": "option"
1582
+ },
1583
+ "metadata-dir": {
1584
+ "helpGroup": "Metadata API Format",
1585
+ "name": "metadata-dir",
1586
+ "summary": "Root of directory or zip file of metadata formatted files to deploy.",
1562
1587
  "hasDynamicHelp": false,
1563
1588
  "multiple": false,
1564
1589
  "type": "option"
1565
1590
  },
1566
- "concise": {
1567
- "exclusive": [
1568
- "verbose"
1591
+ "single-package": {
1592
+ "dependsOn": [
1593
+ "metadata-dir"
1569
1594
  ],
1570
- "name": "concise",
1571
- "summary": "Show concise output of the deploy operation result.",
1595
+ "helpGroup": "Metadata API Format",
1596
+ "name": "single-package",
1597
+ "summary": "Indicates that the metadata zip file points to a directory structure for a single package.",
1572
1598
  "allowNo": false,
1573
1599
  "type": "boolean"
1574
1600
  },
1575
- "job-id": {
1576
- "char": "i",
1577
- "description": "These commands return a job ID if they time out or you specified the --async flag:\n\n- <%= config.bin %> project deploy start\n- <%= config.bin %> project deploy validate\n- <%= config.bin %> project deploy quick\n- <%= config.bin %> project deploy cancel\n\nThe job ID is valid for 10 days from when you started the deploy operation.",
1578
- "name": "job-id",
1579
- "summary": "Job ID of the deploy operation you want to resume.",
1580
- "hasDynamicHelp": false,
1601
+ "target-org": {
1602
+ "char": "o",
1603
+ "name": "target-org",
1604
+ "noCacheDefault": true,
1605
+ "required": true,
1606
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
1607
+ "hasDynamicHelp": true,
1581
1608
  "multiple": false,
1582
1609
  "type": "option"
1583
1610
  },
1584
- "use-most-recent": {
1585
- "char": "r",
1586
- "description": "For performance reasons, this flag uses job IDs for deploy operations that started only in the past 3 days or less. If your most recent operation was more than 3 days ago, this flag won't find a job ID.",
1587
- "name": "use-most-recent",
1588
- "summary": "Use the job ID of the most recent deploy operation.",
1589
- "allowNo": false,
1590
- "type": "boolean"
1611
+ "tests": {
1612
+ "char": "t",
1613
+ "description": "If a test name contains a space, enclose it in double quotes.\nFor multiple test names, use one of the following formats:\n\n- Repeat the flag for multiple test names: --tests Test1 --tests Test2 --tests \"Test With Space\"\n- Separate the test names with spaces: --tests Test1 Test2 \"Test With Space\"",
1614
+ "helpGroup": "Test",
1615
+ "name": "tests",
1616
+ "summary": "Apex tests to run when --test-level is RunSpecifiedTests.",
1617
+ "hasDynamicHelp": false,
1618
+ "multiple": true,
1619
+ "type": "option"
1620
+ },
1621
+ "test-level": {
1622
+ "char": "l",
1623
+ "description": "Valid values are:\n\n- RunSpecifiedTests — Runs only the tests that you specify with the --tests flag. Code coverage requirements differ from the default coverage requirements when using this test level. Executed tests must comprise a minimum of 75% code coverage for each class and trigger in the deployment package. This coverage is computed for each class and trigger individually and is different than the overall coverage percentage.\n\n- RunLocalTests — All tests in your org are run, except the ones that originate from installed managed and unlocked packages. This test level is the default.\n\n- RunAllTestsInOrg — All tests in your org are run, including tests of managed packages.",
1624
+ "helpGroup": "Test",
1625
+ "name": "test-level",
1626
+ "summary": "Deployment Apex testing level.",
1627
+ "default": "RunLocalTests",
1628
+ "hasDynamicHelp": false,
1629
+ "multiple": false,
1630
+ "options": [
1631
+ "RunAllTestsInOrg",
1632
+ "RunLocalTests",
1633
+ "RunSpecifiedTests"
1634
+ ],
1635
+ "type": "option"
1591
1636
  },
1592
1637
  "verbose": {
1593
1638
  "exclusive": [
1594
1639
  "concise"
1595
1640
  ],
1596
1641
  "name": "verbose",
1597
- "summary": "Show verbose output of the deploy operation result.",
1642
+ "summary": "Show verbose output of the validation result.",
1598
1643
  "allowNo": false,
1599
1644
  "type": "boolean"
1600
1645
  },
1601
1646
  "wait": {
1602
1647
  "char": "w",
1603
- "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 deploy operation, run this command again. To check the status of the deploy operation, run \"<%= config.bin %> project deploy report\".",
1648
+ "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 watching the validation, run \"<%= config.bin %> project deploy resume\". To check the status of the validation, run \"<%= config.bin %> project deploy report\".",
1604
1649
  "name": "wait",
1605
1650
  "summary": "Number of minutes to wait for the command to complete and display results.",
1606
1651
  "hasDynamicHelp": true,
@@ -1608,6 +1653,14 @@
1608
1653
  "multiple": false,
1609
1654
  "type": "option"
1610
1655
  },
1656
+ "ignore-warnings": {
1657
+ "char": "g",
1658
+ "description": "If you specify this flag, and a warning occurs, the success status of the deployment is set to true. If you don't specify this flag, and a warning occurs, then the success status is set to false, and the warning is treated like an error.\n\nThis flag is useful in a CI environment and your deployment includes destructive changes; if you try to delete a component that doesn't exist in the org, you get a warning. In this case, to ensure that the command returns a success value of true, specify this flag.",
1659
+ "name": "ignore-warnings",
1660
+ "summary": "Ignore warnings and allow a deployment to complete successfully.",
1661
+ "allowNo": false,
1662
+ "type": "boolean"
1663
+ },
1611
1664
  "coverage-formatters": {
1612
1665
  "description": "For multiple formatters, repeat the flag for each formatter.\n--coverage-formatters lcov --coverage-formatters clover",
1613
1666
  "helpGroup": "Test",
@@ -1653,20 +1706,78 @@
1653
1706
  "hasDynamicHelp": false,
1654
1707
  "multiple": false,
1655
1708
  "type": "option"
1709
+ },
1710
+ "purge-on-delete": {
1711
+ "dependsOn": [
1712
+ "manifest"
1713
+ ],
1714
+ "helpGroup": "Delete",
1715
+ "name": "purge-on-delete",
1716
+ "relationships": [
1717
+ {
1718
+ "type": "some",
1719
+ "flags": [
1720
+ "pre-destructive-changes",
1721
+ "post-destructive-changes"
1722
+ ]
1723
+ }
1724
+ ],
1725
+ "summary": "Specify that deleted components in the destructive changes manifest file are immediately eligible for deletion rather than being stored in the Recycle Bin.",
1726
+ "allowNo": false,
1727
+ "type": "boolean"
1728
+ },
1729
+ "pre-destructive-changes": {
1730
+ "dependsOn": [
1731
+ "manifest"
1732
+ ],
1733
+ "helpGroup": "Delete",
1734
+ "name": "pre-destructive-changes",
1735
+ "summary": "File path for a manifest (destructiveChangesPre.xml) of components to delete before the deploy",
1736
+ "hasDynamicHelp": false,
1737
+ "multiple": false,
1738
+ "type": "option"
1739
+ },
1740
+ "post-destructive-changes": {
1741
+ "dependsOn": [
1742
+ "manifest"
1743
+ ],
1744
+ "helpGroup": "Delete",
1745
+ "name": "post-destructive-changes",
1746
+ "summary": "File path for a manifest (destructiveChangesPost.xml) of components to delete after the deploy.",
1747
+ "hasDynamicHelp": false,
1748
+ "multiple": false,
1749
+ "type": "option"
1656
1750
  }
1657
1751
  },
1658
1752
  "hasDynamicHelp": true,
1659
1753
  "hiddenAliases": [],
1660
- "id": "project:deploy:resume",
1754
+ "id": "project:deploy:validate",
1661
1755
  "pluginAlias": "@salesforce/plugin-deploy-retrieve",
1662
1756
  "pluginName": "@salesforce/plugin-deploy-retrieve",
1663
1757
  "pluginType": "core",
1664
1758
  "strict": true,
1665
- "summary": "Resume watching a deploy operation and update source tracking when the deploy completes.",
1759
+ "summary": "Validate a metadata deployment without actually executing it.",
1666
1760
  "enableJsonFlag": true,
1761
+ "configurationVariablesSection": {
1762
+ "header": "CONFIGURATION VARIABLES",
1763
+ "body": [
1764
+ {
1765
+ "name": "target-org",
1766
+ "description": "Username or alias of the org that all commands run against by default. (sf only)"
1767
+ },
1768
+ {
1769
+ "name": "org-api-version",
1770
+ "description": "API version of your project. Default: API version of your Dev Hub org."
1771
+ }
1772
+ ]
1773
+ },
1667
1774
  "envVariablesSection": {
1668
1775
  "header": "ENVIRONMENT VARIABLES",
1669
1776
  "body": [
1777
+ {
1778
+ "name": "SF_TARGET_ORG",
1779
+ "description": "Username or alias of your default org. Overrides the target-org configuration variable."
1780
+ },
1670
1781
  {
1671
1782
  "name": "SF_USE_PROGRESS_BAR",
1672
1783
  "description": "Set to false to disable the progress bar when running the metadata deploy command."
@@ -1712,48 +1823,40 @@
1712
1823
  "commands",
1713
1824
  "project",
1714
1825
  "deploy",
1715
- "resume.js"
1826
+ "validate.js"
1716
1827
  ],
1717
1828
  "aliasPermutations": [
1718
- "deploy:metadata:resume",
1719
- "metadata:deploy:resume",
1720
- "metadata:resume:deploy",
1721
- "deploy:resume:metadata",
1722
- "resume:deploy:metadata",
1723
- "resume:metadata:deploy"
1829
+ "deploy:metadata:validate",
1830
+ "metadata:deploy:validate",
1831
+ "metadata:validate:deploy",
1832
+ "deploy:validate:metadata",
1833
+ "validate:deploy:metadata",
1834
+ "validate:metadata:deploy"
1724
1835
  ],
1725
1836
  "permutations": [
1726
- "project:deploy:resume",
1727
- "deploy:project:resume",
1728
- "deploy:resume:project",
1729
- "project:resume:deploy",
1730
- "resume:project:deploy",
1731
- "resume:deploy:project"
1837
+ "project:deploy:validate",
1838
+ "deploy:project:validate",
1839
+ "deploy:validate:project",
1840
+ "project:validate:deploy",
1841
+ "validate:project:deploy",
1842
+ "validate:deploy:project"
1732
1843
  ]
1733
1844
  },
1734
- "project:deploy:start": {
1845
+ "project:generate:manifest": {
1735
1846
  "aliases": [
1736
- "deploy:metadata"
1847
+ "force:source:manifest:create"
1737
1848
  ],
1738
1849
  "args": {},
1739
1850
  "deprecateAliases": true,
1740
- "description": "You must run this command from within a project.\n\nMetadata components are deployed in source format by default. Deploy them in metadata format by specifying the --metadata-dir flag, which specifies the root directory or ZIP file that contains the metadata formatted files you want to deploy.\n\nIf your org allows source tracking, then this command tracks the changes in your source. Some orgs, such as production orgs, never allow source tracking. Source tracking is enabled by default on scratch and sandbox orgs; you can disable source tracking when you create the orgs by specifying the --no-track-source flag on the \"<%= config.bin %> org create scratch|sandbox\" commands.\n\nTo deploy 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 --source-dir.",
1851
+ "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 flags, 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 flag, 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.\n\nTo build a manifest from the metadata in an org, use the --from-org flag. You can combine --from-org with the --metadata flag to include only certain metadata types, or with the --excluded-metadata flag to exclude certain metadata types. When building a manifest from an org, the command makes many concurrent API calls to discover the metadata that exists in the org. To limit the number of concurrent requests, use the SF_LIST_METADATA_BATCH_SIZE environment variable and set it to a size that works best for your org and environment. If you experience timeouts or inconsistent manifest contents, then setting this environment variable can improve accuracy. However, the command takes longer to run because it sends fewer requests at a time.",
1741
1852
  "examples": [
1742
- "Deploy local changes not in the org; uses your default org:\n<%= config.bin %> <%= command.id %>",
1743
- "Deploy all source files in the \"force-app\" directory to an org with alias \"my-scratch\"; show only concise output, in other words don't print a list of all the source that was deployed:\n<%= config.bin %> <%= command.id %> --source-dir force-app --target-org my-scratch --concise",
1744
- "Deploy all the Apex classes and custom objects that are in the \"force-app\" directory. The list views, layouts, etc, that are associated with the custom objects are also deployed. Both examples are equivalent:\n<%= config.bin %> <%= command.id %> --source-dir force-app/main/default/classes force-app/main/default/objects\n<%= config.bin %> <%= command.id %> --source-dir force-app/main/default/classes --source-dir force-app/main/default/objects",
1745
- "Deploy all Apex classes that are in all package directories defined in the \"sfdx-project.json\" file:\n<%= config.bin %> <%= command.id %> --metadata ApexClass",
1746
- "Deploy a specific Apex class; ignore any conflicts between the local project and org (be careful with this flag, because it will overwrite the Apex class in the org if there are conflicts!):\n<%= config.bin %> <%= command.id %> --metadata ApexClass:MyApexClass --ignore-conflicts",
1747
- "Deploy specific Apex classes that match a pattern; in this example, deploy Apex classes whose names contain the string \"MyApex\". Also ignore any deployment warnings (again, be careful with this flag! You typically want to see the warnings):\n<%= config.bin %> <%= command.id %> --metadata 'ApexClass:MyApex*' --ignore-warnings",
1748
- "Deploy a custom object called ExcitingObject that's in the SBQQ namespace:\nsf <%= command.id %> --metadata CustomObject:SBQQ__ExcitingObject",
1749
- "Deploy all custom objects in the SBQQ namespace by using a wildcard and quotes:\nsf <%= command.id %> --metadata 'CustomObject:SBQQ__*'",
1750
- "Deploy all custom objects and Apex classes found in all defined package directories (both examples are equivalent):\n<%= config.bin %> <%= command.id %> --metadata CustomObject ApexClass\n<%= config.bin %> <%= command.id %> --metadata CustomObject --metadata ApexClass",
1751
- "Deploy all Apex classes and a profile that has a space in its name:\n<%= config.bin %> <%= command.id %> --metadata ApexClass --metadata \"Profile:My Profile\"",
1752
- "Deploy all components listed in a manifest:\n<%= config.bin %> <%= command.id %> --manifest path/to/package.xml",
1753
- "Run the tests that aren’t in any managed packages as part of a deployment:\n<%= config.bin %> <%= command.id %> --metadata ApexClass --test-level RunLocalTests",
1754
- "Deploy all metadata formatted files in the \"MDAPI\" directory:\n<%= config.bin %> <%= command.id %> --metadata-dir MDAPI",
1755
- "Deploy all metadata formatted files in the \"MDAPI\" directory; items listed in the MDAPI/destructiveChangesPre.xml and MDAPI/destructiveChangesPost.xml manifests are immediately eligible for deletion rather than stored in the Recycle Bin:\n<%= config.bin %> <%= command.id %> --metadata-dir MDAPI --purge-on-delete"
1756
- ],
1853
+ "Create a manifest for deploying or retrieving all Apex classes and custom objects:\n$ <%= config.bin %> <%= command.id %> --metadata ApexClass --metadata CustomObject",
1854
+ "Create a manifest for deleting the specified Apex class:\n$ <%= config.bin %> <%= command.id %> --metadata ApexClass:MyApexClass --type destroy",
1855
+ "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",
1856
+ "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",
1857
+ "Create a manifest from specific metadata types in an org:\n$ <%= config.bin %> <%= command.id %> --from-org test@myorg.com --metadata ApexClass,CustomObject,CustomLabels",
1858
+ "Create a manifest from all metadata components in an org excluding specific metadata types:\n$ <%= config.bin %> <%= command.id %> --from-org test@myorg.com --excluded-metadata StandardValueSet"
1859
+ ],
1757
1860
  "flags": {
1758
1861
  "json": {
1759
1862
  "description": "Format output as json.",
@@ -1771,377 +1874,212 @@
1771
1874
  "type": "option"
1772
1875
  },
1773
1876
  "api-version": {
1774
- "char": "a",
1775
- "description": "Use this flag to override the default API version with the API version of your package.xml file. The default API version is the latest version supported by the CLI.",
1877
+ "aliases": [
1878
+ "apiversion"
1879
+ ],
1880
+ "deprecateAliases": true,
1881
+ "description": "Override the api version used for api requests made by this command",
1776
1882
  "name": "api-version",
1777
- "summary": "Target API version for the deploy.",
1778
1883
  "hasDynamicHelp": false,
1779
1884
  "multiple": false,
1780
1885
  "type": "option"
1781
1886
  },
1782
- "async": {
1783
- "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\".",
1784
- "exclusive": [
1785
- "wait"
1786
- ],
1787
- "name": "async",
1788
- "summary": "Run the command asynchronously.",
1789
- "allowNo": false,
1790
- "type": "boolean"
1791
- },
1792
- "concise": {
1793
- "exclusive": [
1794
- "verbose"
1795
- ],
1796
- "name": "concise",
1797
- "summary": "Show concise output of the deploy result.",
1798
- "allowNo": false,
1799
- "type": "boolean"
1800
- },
1801
- "dry-run": {
1802
- "name": "dry-run",
1803
- "summary": "Validate deploy and run Apex tests but don’t save to the org.",
1804
- "allowNo": false,
1805
- "type": "boolean"
1806
- },
1807
- "ignore-conflicts": {
1808
- "char": "c",
1809
- "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.",
1810
- "name": "ignore-conflicts",
1811
- "summary": "Ignore conflicts and deploy local files, even if they overwrite changes in the org.",
1812
- "allowNo": false,
1813
- "type": "boolean"
1814
- },
1815
- "ignore-errors": {
1816
- "char": "r",
1817
- "description": "Never use this flag when deploying to a production org. If you specify it, components without errors are deployed and components with errors are skipped, and could result in an inconsistent production org.",
1818
- "name": "ignore-errors",
1819
- "summary": "Ignore any errors and don’t roll back deployment.",
1820
- "allowNo": false,
1821
- "type": "boolean"
1822
- },
1823
- "ignore-warnings": {
1824
- "char": "g",
1825
- "description": "If you specify this flag, and a warning occurs, the success status of the deployment is set to true. If you don't specify this flag, and a warning occurs, then the success status is set to false, and the warning is treated like an error.\n\nThis flag is useful in a CI environment and your deployment includes destructive changes; if you try to delete a component that doesn't exist in the org, you get a warning. In this case, to ensure that the command returns a success value of true, specify this flag.",
1826
- "name": "ignore-warnings",
1827
- "summary": "Ignore warnings and allow a deployment to complete successfully.",
1828
- "allowNo": false,
1829
- "type": "boolean"
1830
- },
1831
- "manifest": {
1832
- "char": "x",
1833
- "description": "All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.",
1834
- "exclusive": [
1835
- "source-dir",
1836
- "metadata",
1837
- "metadata-dir"
1838
- ],
1839
- "helpGroup": "Source Format",
1840
- "name": "manifest",
1841
- "summary": "Full file path for manifest (package.xml) of components to deploy.",
1887
+ "loglevel": {
1888
+ "deprecated": {
1889
+ "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
1890
+ },
1891
+ "hidden": true,
1892
+ "name": "loglevel",
1842
1893
  "hasDynamicHelp": false,
1843
1894
  "multiple": false,
1844
1895
  "type": "option"
1845
1896
  },
1846
1897
  "metadata": {
1847
1898
  "char": "m",
1848
- "exclusive": [
1849
- "manifest",
1850
- "source-dir",
1851
- "metadata-dir"
1852
- ],
1853
- "helpGroup": "Source Format",
1854
1899
  "name": "metadata",
1855
- "summary": "Metadata component names to deploy. Wildcards (`*` ) supported as long as you use quotes, such as `ApexClass:MyClass*`.",
1900
+ "summary": "Names of metadata components to include in the manifest.",
1901
+ "delimiter": ",",
1856
1902
  "hasDynamicHelp": false,
1857
1903
  "multiple": true,
1858
1904
  "type": "option"
1859
1905
  },
1860
- "metadata-dir": {
1861
- "exclusive": [
1862
- "manifest",
1863
- "source-dir",
1864
- "metadata"
1906
+ "source-dir": {
1907
+ "aliases": [
1908
+ "sourcepath"
1865
1909
  ],
1866
- "helpGroup": "Metadata API Format",
1867
- "name": "metadata-dir",
1868
- "summary": "Root of directory or zip file of metadata formatted files to deploy.",
1910
+ "char": "p",
1911
+ "deprecateAliases": true,
1912
+ "name": "source-dir",
1913
+ "summary": "Paths to the local source files to include in the manifest.",
1914
+ "delimiter": ",",
1869
1915
  "hasDynamicHelp": false,
1870
- "multiple": false,
1916
+ "multiple": true,
1871
1917
  "type": "option"
1872
1918
  },
1873
- "single-package": {
1874
- "dependsOn": [
1875
- "metadata-dir"
1919
+ "name": {
1920
+ "aliases": [
1921
+ "manifestname"
1876
1922
  ],
1877
- "helpGroup": "Metadata API Format",
1878
- "name": "single-package",
1879
- "summary": "Indicates that the metadata zip file points to a directory structure for a single package.",
1880
- "allowNo": false,
1881
- "type": "boolean"
1882
- },
1883
- "source-dir": {
1884
- "char": "d",
1885
- "description": "The supplied path 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 subdirectories).\n\nIf you specify this flag, don’t specify --metadata or --manifest.",
1923
+ "char": "n",
1924
+ "deprecateAliases": true,
1886
1925
  "exclusive": [
1887
- "manifest",
1888
- "metadata",
1889
- "metadata-dir"
1926
+ "type"
1890
1927
  ],
1891
- "helpGroup": "Source Format",
1892
- "name": "source-dir",
1893
- "summary": "Path to the local source files to deploy.",
1928
+ "name": "name",
1929
+ "summary": "Name of a custom manifest file to create.",
1894
1930
  "hasDynamicHelp": false,
1895
- "multiple": true,
1896
- "type": "option"
1897
- },
1898
- "target-org": {
1899
- "char": "o",
1900
- "name": "target-org",
1901
- "noCacheDefault": true,
1902
- "required": true,
1903
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
1904
- "hasDynamicHelp": true,
1905
1931
  "multiple": false,
1906
1932
  "type": "option"
1907
1933
  },
1908
- "tests": {
1934
+ "type": {
1935
+ "aliases": [
1936
+ "manifesttype"
1937
+ ],
1909
1938
  "char": "t",
1910
- "description": "If a test name contains a space, enclose it in double quotes.\nFor multiple test names, use one of the following formats:\n\n- Repeat the flag for multiple test names: --tests Test1 --tests Test2 --tests \"Test With Space\"\n- Separate the test names with spaces: --tests Test1 Test2 \"Test With Space\"",
1911
- "helpGroup": "Test",
1912
- "name": "tests",
1913
- "summary": "Apex tests to run when --test-level is RunSpecifiedTests.",
1914
- "hasDynamicHelp": false,
1915
- "multiple": true,
1916
- "type": "option"
1917
- },
1918
- "test-level": {
1919
- "char": "l",
1920
- "description": "Valid values are:\n\n- NoTestRun — No tests are run. This test level applies only to deployments to development environments, such as sandbox, Developer Edition, or trial orgs. This test level is the default for development environments.\n\n- RunSpecifiedTests — Runs only the tests that you specify with the --tests flag. Code coverage requirements differ from the default coverage requirements when using this test level. Executed tests must comprise a minimum of 75% code coverage for each class and trigger in the deployment package. This coverage is computed for each class and trigger individually and is different than the overall coverage percentage.\n\n- RunLocalTests — All tests in your org are run, except the ones that originate from installed managed and unlocked packages. This test level is the default for production deployments that include Apex classes or triggers.\n\n- RunAllTestsInOrg — All tests in your org are run, including tests of managed packages.\n\n If you don’t specify a test level, the default behavior depends on the contents of your deployment package and target org. For more information, see [Running Tests in a Deployment](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_deploy_running_tests.htm) in the \"Metadata API Developer Guide\".",
1921
- "helpGroup": "Test",
1922
- "name": "test-level",
1923
- "summary": "Deployment Apex testing level.",
1939
+ "deprecateAliases": true,
1940
+ "exclusive": [
1941
+ "name"
1942
+ ],
1943
+ "name": "type",
1944
+ "summary": "Type of manifest to create; the type determines the name of the created file.",
1924
1945
  "hasDynamicHelp": false,
1925
1946
  "multiple": false,
1926
1947
  "options": [
1927
- "NoTestRun",
1928
- "RunSpecifiedTests",
1929
- "RunLocalTests",
1930
- "RunAllTestsInOrg"
1948
+ "pre",
1949
+ "post",
1950
+ "destroy",
1951
+ "package"
1931
1952
  ],
1932
1953
  "type": "option"
1933
1954
  },
1934
- "verbose": {
1935
- "exclusive": [
1936
- "concise"
1955
+ "include-packages": {
1956
+ "aliases": [
1957
+ "includepackages"
1937
1958
  ],
1938
- "name": "verbose",
1939
- "summary": "Show verbose output of the deploy result.",
1940
- "allowNo": false,
1941
- "type": "boolean"
1942
- },
1943
- "wait": {
1944
- "char": "w",
1945
- "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\".",
1946
- "exclusive": [
1947
- "async"
1959
+ "char": "c",
1960
+ "dependsOn": [
1961
+ "from-org"
1962
+ ],
1963
+ "deprecateAliases": true,
1964
+ "name": "include-packages",
1965
+ "summary": "Package types (managed, unlocked) whose metadata is included in the manifest; by default, metadata in managed and unlocked packages is excluded. Metadata in unmanaged packages is always included.",
1966
+ "delimiter": ",",
1967
+ "hasDynamicHelp": false,
1968
+ "multiple": true,
1969
+ "options": [
1970
+ "managed",
1971
+ "unlocked"
1948
1972
  ],
1949
- "name": "wait",
1950
- "summary": "Number of minutes to wait for command to complete and display results.",
1951
- "hasDynamicHelp": true,
1952
- "helpValue": "<minutes>",
1953
- "multiple": false,
1954
1973
  "type": "option"
1955
1974
  },
1956
- "purge-on-delete": {
1957
- "helpGroup": "Delete",
1958
- "name": "purge-on-delete",
1975
+ "excluded-metadata": {
1976
+ "name": "excluded-metadata",
1959
1977
  "relationships": [
1960
1978
  {
1961
1979
  "type": "some",
1962
1980
  "flags": [
1963
- "pre-destructive-changes",
1964
- "manifest",
1965
- "metadata-dir",
1966
- "post-destructive-changes"
1981
+ "from-org",
1982
+ "source-dir"
1967
1983
  ]
1968
1984
  }
1969
1985
  ],
1970
- "summary": "Specify that deleted components in the destructive changes manifest file are immediately eligible for deletion rather than being stored in the Recycle Bin.",
1971
- "allowNo": false,
1972
- "type": "boolean"
1973
- },
1974
- "pre-destructive-changes": {
1975
- "dependsOn": [
1976
- "manifest"
1977
- ],
1978
- "helpGroup": "Delete",
1979
- "name": "pre-destructive-changes",
1980
- "summary": "File path for a manifest (destructiveChangesPre.xml) of components to delete before the deploy.",
1986
+ "summary": "Metadata types to exclude when building a manifest from an org. Specify the name of the type, not the name of a specific component.",
1987
+ "delimiter": ",",
1981
1988
  "hasDynamicHelp": false,
1982
- "multiple": false,
1989
+ "multiple": true,
1983
1990
  "type": "option"
1984
1991
  },
1985
- "post-destructive-changes": {
1986
- "dependsOn": [
1987
- "manifest"
1992
+ "from-org": {
1993
+ "aliases": [
1994
+ "fromorg"
1988
1995
  ],
1989
- "helpGroup": "Delete",
1990
- "name": "post-destructive-changes",
1991
- "summary": "File path for a manifest (destructiveChangesPost.xml) of components to delete after the deploy.",
1996
+ "deprecateAliases": true,
1997
+ "exclusive": [
1998
+ "source-dir"
1999
+ ],
2000
+ "name": "from-org",
2001
+ "summary": "Username or alias of the org that contains the metadata components from which to build a manifest.",
1992
2002
  "hasDynamicHelp": false,
1993
2003
  "multiple": false,
1994
2004
  "type": "option"
1995
2005
  },
1996
- "coverage-formatters": {
1997
- "description": "For multiple formatters, repeat the flag for each formatter.\n--coverage-formatters lcov --coverage-formatters clover",
1998
- "helpGroup": "Test",
1999
- "name": "coverage-formatters",
2000
- "summary": "Format of the code coverage results.",
2001
- "hasDynamicHelp": false,
2002
- "multiple": true,
2003
- "options": [
2004
- "clover",
2005
- "cobertura",
2006
- "html-spa",
2007
- "html",
2008
- "json",
2009
- "json-summary",
2010
- "lcovonly",
2011
- "none",
2012
- "teamcity",
2013
- "text",
2014
- "text-summary"
2015
- ],
2016
- "type": "option"
2017
- },
2018
- "junit": {
2019
- "helpGroup": "Test",
2020
- "name": "junit",
2021
- "summary": "Output JUnit test results.",
2022
- "allowNo": false,
2023
- "type": "boolean"
2024
- },
2025
- "results-dir": {
2026
- "helpGroup": "Test",
2027
- "name": "results-dir",
2028
- "relationships": [
2029
- {
2030
- "type": "some",
2031
- "flags": [
2032
- "coverage-formatters",
2033
- "junit"
2034
- ]
2035
- }
2006
+ "output-dir": {
2007
+ "aliases": [
2008
+ "outputdir",
2009
+ "o"
2036
2010
  ],
2037
- "summary": "Output directory for code coverage and JUnit results; defaults to the deploy ID.",
2011
+ "char": "d",
2012
+ "deprecateAliases": true,
2013
+ "name": "output-dir",
2014
+ "summary": "Directory to save the created manifest.",
2038
2015
  "hasDynamicHelp": false,
2039
2016
  "multiple": false,
2040
2017
  "type": "option"
2041
2018
  }
2042
2019
  },
2043
- "hasDynamicHelp": true,
2020
+ "hasDynamicHelp": false,
2044
2021
  "hiddenAliases": [],
2045
- "id": "project:deploy:start",
2022
+ "id": "project:generate:manifest",
2046
2023
  "pluginAlias": "@salesforce/plugin-deploy-retrieve",
2047
2024
  "pluginName": "@salesforce/plugin-deploy-retrieve",
2048
2025
  "pluginType": "core",
2049
2026
  "strict": true,
2050
- "summary": "Deploy metadata to an org from your local project.",
2027
+ "summary": "Create a project manifest that lists the metadata components you want to deploy or retrieve.",
2051
2028
  "enableJsonFlag": true,
2052
- "configurationVariablesSection": {
2053
- "header": "CONFIGURATION VARIABLES",
2054
- "body": [
2055
- {
2056
- "name": "target-org",
2057
- "description": "Username or alias of the org that all commands run against by default. (sf only)"
2058
- },
2059
- {
2060
- "name": "org-api-version",
2061
- "description": "API version of your project. Default: API version of your Dev Hub org."
2062
- }
2063
- ]
2064
- },
2065
- "envVariablesSection": {
2066
- "header": "ENVIRONMENT VARIABLES",
2067
- "body": [
2068
- {
2069
- "name": "SF_TARGET_ORG",
2070
- "description": "Username or alias of your default org. Overrides the target-org configuration variable."
2071
- },
2072
- {
2073
- "name": "SF_USE_PROGRESS_BAR",
2074
- "description": "Set to false to disable the progress bar when running the metadata deploy command."
2075
- }
2076
- ]
2077
- },
2078
- "errorCodes": {
2079
- "header": "ERROR CODES",
2080
- "body": [
2081
- {
2082
- "name": "Succeeded (0)",
2083
- "description": "The deploy succeeded."
2084
- },
2085
- {
2086
- "name": "Canceled (1)",
2087
- "description": "The deploy was canceled."
2088
- },
2089
- {
2090
- "name": "Failed (1)",
2091
- "description": "The deploy failed."
2092
- },
2093
- {
2094
- "name": "SucceededPartial (68)",
2095
- "description": "The deploy partially succeeded."
2096
- },
2097
- {
2098
- "name": "InProgress (69)",
2099
- "description": "The deploy is in progress."
2100
- },
2101
- {
2102
- "name": "Pending (69)",
2103
- "description": "The deploy is pending."
2104
- },
2105
- {
2106
- "name": "Canceling (69)",
2107
- "description": "The deploy is being canceled."
2108
- }
2109
- ]
2110
- },
2029
+ "requiresProject": true,
2111
2030
  "isESM": true,
2112
2031
  "relativePath": [
2113
2032
  "lib",
2114
2033
  "commands",
2115
2034
  "project",
2116
- "deploy",
2117
- "start.js"
2035
+ "generate",
2036
+ "manifest.js"
2118
2037
  ],
2119
2038
  "aliasPermutations": [
2120
- "deploy:metadata",
2121
- "metadata:deploy"
2039
+ "force:source:manifest:create",
2040
+ "source:force:manifest:create",
2041
+ "source:manifest:force:create",
2042
+ "source:manifest:create:force",
2043
+ "force:manifest:source:create",
2044
+ "manifest:force:source:create",
2045
+ "manifest:source:force:create",
2046
+ "manifest:source:create:force",
2047
+ "force:manifest:create:source",
2048
+ "manifest:force:create:source",
2049
+ "manifest:create:force:source",
2050
+ "manifest:create:source:force",
2051
+ "force:source:create:manifest",
2052
+ "source:force:create:manifest",
2053
+ "source:create:force:manifest",
2054
+ "source:create:manifest:force",
2055
+ "force:create:source:manifest",
2056
+ "create:force:source:manifest",
2057
+ "create:source:force:manifest",
2058
+ "create:source:manifest:force",
2059
+ "force:create:manifest:source",
2060
+ "create:force:manifest:source",
2061
+ "create:manifest:force:source",
2062
+ "create:manifest:source:force"
2122
2063
  ],
2123
2064
  "permutations": [
2124
- "project:deploy:start",
2125
- "deploy:project:start",
2126
- "deploy:start:project",
2127
- "project:start:deploy",
2128
- "start:project:deploy",
2129
- "start:deploy:project"
2065
+ "project:generate:manifest",
2066
+ "generate:project:manifest",
2067
+ "generate:manifest:project",
2068
+ "project:manifest:generate",
2069
+ "manifest:project:generate",
2070
+ "manifest:generate:project"
2130
2071
  ]
2131
2072
  },
2132
- "project:deploy:validate": {
2073
+ "project:convert:mdapi": {
2133
2074
  "aliases": [
2134
- "deploy:metadata:validate"
2075
+ "force:mdapi:convert"
2135
2076
  ],
2136
2077
  "args": {},
2137
2078
  "deprecateAliases": true,
2138
- "description": "Use this command to verify whether a deployment will succeed without actually deploying the metadata to your org. This command is similar to \"<%= config.bin %> project deploy start\", except you're required to run Apex tests, and the command returns a job ID rather than executing the deployment. If the validation succeeds, then you pass this job ID to the \"<%= config.bin %> project deploy quick\" command to actually deploy the metadata. This quick deploy takes less time because it skips running Apex tests. The job ID is valid for 10 days from when you started the validation. Validating first is useful if the deployment to your production org take several hours and you don’t want to risk a failed deploy.\n\nYou must run this command from within a project.\n\nThis command doesn't support source-tracking. When you quick deploy with the resulting job ID, the source you deploy overwrites the corresponding metadata in your org.\n\nTo validate the deployment of 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 --source-dir.\n\nNote: Don't use this command on sandboxes; the command is intended to be used on production orgs. By default, sandboxes don't run tests during a deploy. If you want to validate a deployment with tests on a sandbox, use \"<%= config.bin %> project deploy start --dry-run --test-level RunLocalTests\" instead.",
2079
+ "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 \"sf 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 --source-dir.",
2139
2080
  "examples": [
2140
- "NOTE: These examples focus on validating large deployments. See the help for \"<%= config.bin %> project deploy start\" for examples of deploying smaller sets of metadata which you can also use to validate.",
2141
- "Validate the deployment of all source files in the \"force-app\" directory to the default org:\n<%= config.bin %> <%= command.id %> --source-dir force-app",
2142
- "Validate the deployment of all source files in two directories: \"force-app\" and \"force-app-utils\":\n<%= config.bin %> <%= command.id %> --source-dir force-app --source-dir force-app-utils",
2143
- "Asynchronously validate the deployment and run all tests in the org with alias \"my-prod-org\"; command immediately returns the job ID:\n<%= config.bin %> <%= command.id %> --source-dir force-app --async --test-level RunAllTestsInOrg --target-org my-prod-org",
2144
- "Validate the deployment of all components listed in a manifest:\n<%= config.bin %> <%= command.id %> --manifest path/to/package.xml"
2081
+ "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",
2082
+ "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"
2145
2083
  ],
2146
2084
  "flags": {
2147
2085
  "json": {
@@ -2160,319 +2098,381 @@
2160
2098
  "type": "option"
2161
2099
  },
2162
2100
  "api-version": {
2163
- "char": "a",
2164
- "description": "Use this flag to override the default API version with the API version of your package.xml file. The default API version is the latest version supported by the CLI.",
2101
+ "aliases": [
2102
+ "apiversion"
2103
+ ],
2104
+ "deprecateAliases": true,
2105
+ "description": "Override the api version used for api requests made by this command",
2165
2106
  "name": "api-version",
2166
- "summary": "Target API version for the validation.",
2167
2107
  "hasDynamicHelp": false,
2168
2108
  "multiple": false,
2169
2109
  "type": "option"
2170
2110
  },
2171
- "async": {
2172
- "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 watching the validation, run \"<%= config.bin %> project deploy resume\". To check the status of the validation, run \"<%= config.bin %> project deploy report\".",
2173
- "name": "async",
2174
- "summary": "Run the command asynchronously.",
2175
- "allowNo": false,
2176
- "type": "boolean"
2111
+ "loglevel": {
2112
+ "deprecated": {
2113
+ "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
2114
+ },
2115
+ "hidden": true,
2116
+ "name": "loglevel",
2117
+ "hasDynamicHelp": false,
2118
+ "multiple": false,
2119
+ "type": "option"
2177
2120
  },
2178
- "concise": {
2179
- "exclusive": [
2180
- "verbose"
2121
+ "root-dir": {
2122
+ "aliases": [
2123
+ "rootdir"
2181
2124
  ],
2182
- "name": "concise",
2183
- "summary": "Show concise output of the validation result.",
2184
- "allowNo": false,
2185
- "type": "boolean"
2186
- },
2187
- "manifest": {
2188
- "char": "x",
2189
- "description": "All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.",
2190
- "helpGroup": "Source Format",
2191
- "name": "manifest",
2192
- "summary": "Full file path for manifest (package.xml) of components to validate for deployment.",
2125
+ "char": "r",
2126
+ "deprecateAliases": true,
2127
+ "name": "root-dir",
2128
+ "required": true,
2129
+ "summary": "Root directory that contains the Metadata API–formatted metadata.",
2193
2130
  "hasDynamicHelp": false,
2194
2131
  "multiple": false,
2195
2132
  "type": "option"
2196
2133
  },
2197
- "metadata": {
2198
- "char": "m",
2199
- "helpGroup": "Source Format",
2200
- "name": "metadata",
2201
- "summary": "Metadata component names to validate for deployment.",
2134
+ "output-dir": {
2135
+ "aliases": [
2136
+ "outputdir"
2137
+ ],
2138
+ "char": "d",
2139
+ "deprecateAliases": true,
2140
+ "name": "output-dir",
2141
+ "summary": "Directory to store your files in after they’re converted to source format; can be an absolute or relative path.",
2202
2142
  "hasDynamicHelp": false,
2203
- "multiple": true,
2143
+ "multiple": false,
2204
2144
  "type": "option"
2205
2145
  },
2206
- "source-dir": {
2207
- "char": "d",
2208
- "description": "The supplied path 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 subdirectories).\n\nIf you specify this flag, don’t specify --metadata or --manifest.",
2209
- "helpGroup": "Source Format",
2210
- "name": "source-dir",
2211
- "summary": "Path to the local source files to validate for deployment.",
2146
+ "manifest": {
2147
+ "char": "x",
2148
+ "description": "If you specify this flag, don’t specify --metadata or --source-dir.",
2149
+ "name": "manifest",
2150
+ "summary": "File path to manifest (package.xml) of metadata types to convert.",
2212
2151
  "hasDynamicHelp": false,
2213
- "multiple": true,
2152
+ "multiple": false,
2214
2153
  "type": "option"
2215
2154
  },
2216
2155
  "metadata-dir": {
2217
- "helpGroup": "Metadata API Format",
2156
+ "aliases": [
2157
+ "metadatapath"
2158
+ ],
2159
+ "char": "p",
2160
+ "deprecateAliases": true,
2161
+ "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.",
2162
+ "exclusive": [
2163
+ "manifest",
2164
+ "metadata"
2165
+ ],
2218
2166
  "name": "metadata-dir",
2219
- "summary": "Root of directory or zip file of metadata formatted files to deploy.",
2167
+ "summary": "Root of directory or zip file of metadata formatted files to convert.",
2168
+ "delimiter": ",",
2220
2169
  "hasDynamicHelp": false,
2221
- "multiple": false,
2170
+ "multiple": true,
2222
2171
  "type": "option"
2223
2172
  },
2224
- "single-package": {
2225
- "dependsOn": [
2226
- "metadata-dir"
2173
+ "metadata": {
2174
+ "char": "m",
2175
+ "exclusive": [
2176
+ "manifest",
2177
+ "metadatapath"
2227
2178
  ],
2228
- "helpGroup": "Metadata API Format",
2229
- "name": "single-package",
2230
- "summary": "Indicates that the metadata zip file points to a directory structure for a single package.",
2179
+ "name": "metadata",
2180
+ "summary": "Metadata component names to convert.",
2181
+ "delimiter": ",",
2182
+ "hasDynamicHelp": false,
2183
+ "multiple": true,
2184
+ "type": "option"
2185
+ }
2186
+ },
2187
+ "hasDynamicHelp": false,
2188
+ "hiddenAliases": [],
2189
+ "id": "project:convert:mdapi",
2190
+ "pluginAlias": "@salesforce/plugin-deploy-retrieve",
2191
+ "pluginName": "@salesforce/plugin-deploy-retrieve",
2192
+ "pluginType": "core",
2193
+ "strict": true,
2194
+ "summary": "Convert metadata retrieved via Metadata API into the source format used in Salesforce DX projects.",
2195
+ "enableJsonFlag": true,
2196
+ "requiresProject": true,
2197
+ "isESM": true,
2198
+ "relativePath": [
2199
+ "lib",
2200
+ "commands",
2201
+ "project",
2202
+ "convert",
2203
+ "mdapi.js"
2204
+ ],
2205
+ "aliasPermutations": [
2206
+ "force:mdapi:convert",
2207
+ "mdapi:force:convert",
2208
+ "mdapi:convert:force",
2209
+ "force:convert:mdapi",
2210
+ "convert:force:mdapi",
2211
+ "convert:mdapi:force"
2212
+ ],
2213
+ "permutations": [
2214
+ "project:convert:mdapi",
2215
+ "convert:project:mdapi",
2216
+ "convert:mdapi:project",
2217
+ "project:mdapi:convert",
2218
+ "mdapi:project:convert",
2219
+ "mdapi:convert:project"
2220
+ ]
2221
+ },
2222
+ "project:convert:source-behavior": {
2223
+ "aliases": [],
2224
+ "args": {},
2225
+ "description": "Specifically, this command updates the \"sourceBehaviorOption\" option in the \"sfdx-project.json\" file and then converts the associated local source files in your project as needed.\n\nFor example, run this command with the \"--behavior decomposePermissionSetBeta\" flag to start decomposing permission sets when you deploy or retrieve them. Decomposing means breaking up the monolithic metadata API format XML file that corresponds to a metadata component into smaller XML files and directories based on its subtypes. Permission sets are not decomposed by default; you must opt-in to start decomposing them by using this command. When the command finishes, your \"sfdx-project.json\" file is updated to always decompose permission sets, and the existing permission set files in your local package directories are converted into the new decomposed format. You run this command only once for a given behavior change.\n\nFor more information about the possible values for the --behavior flag, see the \"sourceBehaviorOptions\" section in the https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_ws_config.htm topic.",
2226
+ "examples": [
2227
+ "Update your Salesforce DX project to decompose custom permission sets:\n<%= config.bin %> <%= command.id %> --behavior decomposePermissionSetBeta",
2228
+ "Display what the command would do, but don't change any existing files:\n<%= config.bin %> <%= command.id %> --behavior decomposePermissionSetBeta --dry-run",
2229
+ "Keep the temporary directory that contains the interim metadata API formatted files:\n<%= config.bin %> <%= command.id %> --behavior decomposePermissionSetBeta --dry-run --preserve-temp-dir"
2230
+ ],
2231
+ "flags": {
2232
+ "json": {
2233
+ "description": "Format output as json.",
2234
+ "helpGroup": "GLOBAL",
2235
+ "name": "json",
2231
2236
  "allowNo": false,
2232
2237
  "type": "boolean"
2233
2238
  },
2234
- "target-org": {
2235
- "char": "o",
2236
- "name": "target-org",
2237
- "noCacheDefault": true,
2238
- "required": true,
2239
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
2240
- "hasDynamicHelp": true,
2241
- "multiple": false,
2242
- "type": "option"
2243
- },
2244
- "tests": {
2245
- "char": "t",
2246
- "description": "If a test name contains a space, enclose it in double quotes.\nFor multiple test names, use one of the following formats:\n\n- Repeat the flag for multiple test names: --tests Test1 --tests Test2 --tests \"Test With Space\"\n- Separate the test names with spaces: --tests Test1 Test2 \"Test With Space\"",
2247
- "helpGroup": "Test",
2248
- "name": "tests",
2249
- "summary": "Apex tests to run when --test-level is RunSpecifiedTests.",
2239
+ "flags-dir": {
2240
+ "helpGroup": "GLOBAL",
2241
+ "name": "flags-dir",
2242
+ "summary": "Import flag values from a directory.",
2250
2243
  "hasDynamicHelp": false,
2251
- "multiple": true,
2244
+ "multiple": false,
2252
2245
  "type": "option"
2253
2246
  },
2254
- "test-level": {
2255
- "char": "l",
2256
- "description": "Valid values are:\n\n- RunSpecifiedTests — Runs only the tests that you specify with the --tests flag. Code coverage requirements differ from the default coverage requirements when using this test level. Executed tests must comprise a minimum of 75% code coverage for each class and trigger in the deployment package. This coverage is computed for each class and trigger individually and is different than the overall coverage percentage.\n\n- RunLocalTests — All tests in your org are run, except the ones that originate from installed managed and unlocked packages. This test level is the default.\n\n- RunAllTestsInOrg — All tests in your org are run, including tests of managed packages.",
2257
- "helpGroup": "Test",
2258
- "name": "test-level",
2259
- "summary": "Deployment Apex testing level.",
2260
- "default": "RunLocalTests",
2247
+ "behavior": {
2248
+ "char": "b",
2249
+ "name": "behavior",
2250
+ "required": true,
2251
+ "summary": "Behavior to enable; the values correspond to the possible values of the \"sourceBehaviorOption\" option in the \"sfdx-project.json\" file.",
2261
2252
  "hasDynamicHelp": false,
2262
2253
  "multiple": false,
2263
2254
  "options": [
2264
- "RunAllTestsInOrg",
2265
- "RunLocalTests",
2266
- "RunSpecifiedTests"
2255
+ "decomposeCustomLabelsBeta2",
2256
+ "decomposeCustomLabelsBeta",
2257
+ "decomposePermissionSetBeta",
2258
+ "decomposePermissionSetBeta2",
2259
+ "decomposeSharingRulesBeta",
2260
+ "decomposeWorkflowBeta",
2261
+ "decomposeExternalServiceRegistrationBeta"
2267
2262
  ],
2268
2263
  "type": "option"
2269
2264
  },
2270
- "verbose": {
2271
- "exclusive": [
2272
- "concise"
2273
- ],
2274
- "name": "verbose",
2275
- "summary": "Show verbose output of the validation result.",
2265
+ "dry-run": {
2266
+ "name": "dry-run",
2267
+ "summary": "Display what the command would do, but don't make any actual changes.",
2276
2268
  "allowNo": false,
2277
2269
  "type": "boolean"
2278
2270
  },
2279
- "wait": {
2280
- "char": "w",
2281
- "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 watching the validation, run \"<%= config.bin %> project deploy resume\". To check the status of the validation, run \"<%= config.bin %> project deploy report\".",
2282
- "name": "wait",
2283
- "summary": "Number of minutes to wait for the command to complete and display results.",
2271
+ "preserve-temp-dir": {
2272
+ "name": "preserve-temp-dir",
2273
+ "summary": "Don't delete the metadata API format temporary directory that this command creates. Useful for debugging.",
2274
+ "allowNo": false,
2275
+ "type": "boolean"
2276
+ },
2277
+ "target-org": {
2278
+ "char": "o",
2279
+ "name": "target-org",
2280
+ "noCacheDefault": true,
2281
+ "summary": "Username or alias of the target org.",
2284
2282
  "hasDynamicHelp": true,
2285
- "helpValue": "<minutes>",
2286
2283
  "multiple": false,
2287
2284
  "type": "option"
2288
- },
2289
- "ignore-warnings": {
2290
- "char": "g",
2291
- "description": "If you specify this flag, and a warning occurs, the success status of the deployment is set to true. If you don't specify this flag, and a warning occurs, then the success status is set to false, and the warning is treated like an error.\n\nThis flag is useful in a CI environment and your deployment includes destructive changes; if you try to delete a component that doesn't exist in the org, you get a warning. In this case, to ensure that the command returns a success value of true, specify this flag.",
2292
- "name": "ignore-warnings",
2293
- "summary": "Ignore warnings and allow a deployment to complete successfully.",
2285
+ }
2286
+ },
2287
+ "hasDynamicHelp": true,
2288
+ "hiddenAliases": [],
2289
+ "id": "project:convert:source-behavior",
2290
+ "pluginAlias": "@salesforce/plugin-deploy-retrieve",
2291
+ "pluginName": "@salesforce/plugin-deploy-retrieve",
2292
+ "pluginType": "core",
2293
+ "state": "beta",
2294
+ "strict": true,
2295
+ "summary": "Enable a behavior of your project source files, and then update your Salesforce DX project to implement the behavior.",
2296
+ "enableJsonFlag": true,
2297
+ "requiresProject": true,
2298
+ "isESM": true,
2299
+ "relativePath": [
2300
+ "lib",
2301
+ "commands",
2302
+ "project",
2303
+ "convert",
2304
+ "source-behavior.js"
2305
+ ],
2306
+ "aliasPermutations": [],
2307
+ "permutations": [
2308
+ "project:convert:source-behavior",
2309
+ "convert:project:source-behavior",
2310
+ "convert:source-behavior:project",
2311
+ "project:source-behavior:convert",
2312
+ "source-behavior:project:convert",
2313
+ "source-behavior:convert:project"
2314
+ ]
2315
+ },
2316
+ "project:convert:source": {
2317
+ "aliases": [
2318
+ "force:source:convert"
2319
+ ],
2320
+ "args": {},
2321
+ "deprecateAliases": true,
2322
+ "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 --source-dir.",
2323
+ "examples": [
2324
+ "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",
2325
+ "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'"
2326
+ ],
2327
+ "flags": {
2328
+ "json": {
2329
+ "description": "Format output as json.",
2330
+ "helpGroup": "GLOBAL",
2331
+ "name": "json",
2294
2332
  "allowNo": false,
2295
2333
  "type": "boolean"
2296
2334
  },
2297
- "coverage-formatters": {
2298
- "description": "For multiple formatters, repeat the flag for each formatter.\n--coverage-formatters lcov --coverage-formatters clover",
2299
- "helpGroup": "Test",
2300
- "name": "coverage-formatters",
2301
- "summary": "Format of the code coverage results.",
2335
+ "flags-dir": {
2336
+ "helpGroup": "GLOBAL",
2337
+ "name": "flags-dir",
2338
+ "summary": "Import flag values from a directory.",
2302
2339
  "hasDynamicHelp": false,
2303
- "multiple": true,
2304
- "options": [
2305
- "clover",
2306
- "cobertura",
2307
- "html-spa",
2308
- "html",
2309
- "json",
2310
- "json-summary",
2311
- "lcovonly",
2312
- "none",
2313
- "teamcity",
2314
- "text",
2315
- "text-summary"
2340
+ "multiple": false,
2341
+ "type": "option"
2342
+ },
2343
+ "api-version": {
2344
+ "aliases": [
2345
+ "apiversion"
2316
2346
  ],
2347
+ "deprecateAliases": true,
2348
+ "description": "Override the api version used for api requests made by this command",
2349
+ "name": "api-version",
2350
+ "summary": "API Version to use in the generated project's manifest. By default, will use the version from sfdx-project.json",
2351
+ "hasDynamicHelp": false,
2352
+ "multiple": false,
2317
2353
  "type": "option"
2318
2354
  },
2319
- "junit": {
2320
- "helpGroup": "Test",
2321
- "name": "junit",
2322
- "summary": "Output JUnit test results.",
2323
- "allowNo": false,
2324
- "type": "boolean"
2355
+ "loglevel": {
2356
+ "deprecated": {
2357
+ "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
2358
+ },
2359
+ "hidden": true,
2360
+ "name": "loglevel",
2361
+ "hasDynamicHelp": false,
2362
+ "multiple": false,
2363
+ "type": "option"
2325
2364
  },
2326
- "results-dir": {
2327
- "helpGroup": "Test",
2328
- "name": "results-dir",
2329
- "relationships": [
2330
- {
2331
- "type": "some",
2332
- "flags": [
2333
- "coverage-formatters",
2334
- "junit"
2335
- ]
2336
- }
2365
+ "root-dir": {
2366
+ "aliases": [
2367
+ "rootdir"
2337
2368
  ],
2338
- "summary": "Output directory for code coverage and JUnit results; defaults to the deploy ID.",
2369
+ "char": "r",
2370
+ "deprecateAliases": true,
2371
+ "name": "root-dir",
2372
+ "summary": "Source directory other than the default package to convert.",
2339
2373
  "hasDynamicHelp": false,
2340
2374
  "multiple": false,
2341
2375
  "type": "option"
2342
2376
  },
2343
- "purge-on-delete": {
2344
- "dependsOn": [
2345
- "manifest"
2346
- ],
2347
- "helpGroup": "Delete",
2348
- "name": "purge-on-delete",
2349
- "relationships": [
2350
- {
2351
- "type": "some",
2352
- "flags": [
2353
- "pre-destructive-changes",
2354
- "post-destructive-changes"
2355
- ]
2356
- }
2377
+ "output-dir": {
2378
+ "aliases": [
2379
+ "outputdir"
2357
2380
  ],
2358
- "summary": "Specify that deleted components in the destructive changes manifest file are immediately eligible for deletion rather than being stored in the Recycle Bin.",
2359
- "allowNo": false,
2360
- "type": "boolean"
2381
+ "char": "d",
2382
+ "deprecateAliases": true,
2383
+ "name": "output-dir",
2384
+ "summary": "Output directory to store the Metadata API–formatted files in.",
2385
+ "default": "metadataPackage_>timestamp<",
2386
+ "hasDynamicHelp": true,
2387
+ "multiple": false,
2388
+ "type": "option"
2361
2389
  },
2362
- "pre-destructive-changes": {
2363
- "dependsOn": [
2364
- "manifest"
2390
+ "package-name": {
2391
+ "aliases": [
2392
+ "packagename"
2365
2393
  ],
2366
- "helpGroup": "Delete",
2367
- "name": "pre-destructive-changes",
2368
- "summary": "File path for a manifest (destructiveChangesPre.xml) of components to delete before the deploy",
2394
+ "char": "n",
2395
+ "deprecateAliases": true,
2396
+ "name": "package-name",
2397
+ "summary": "Name of the package to associate with the metadata-formatted files.",
2369
2398
  "hasDynamicHelp": false,
2370
2399
  "multiple": false,
2371
2400
  "type": "option"
2372
2401
  },
2373
- "post-destructive-changes": {
2374
- "dependsOn": [
2375
- "manifest"
2376
- ],
2377
- "helpGroup": "Delete",
2378
- "name": "post-destructive-changes",
2379
- "summary": "File path for a manifest (destructiveChangesPost.xml) of components to delete after the deploy.",
2402
+ "manifest": {
2403
+ "char": "x",
2404
+ "description": "If you specify this flag, don’t specify --metadata or --source-dir.",
2405
+ "name": "manifest",
2406
+ "summary": "Path to the manifest (package.xml) file that specifies the metadata types to convert.",
2380
2407
  "hasDynamicHelp": false,
2381
2408
  "multiple": false,
2382
2409
  "type": "option"
2410
+ },
2411
+ "source-dir": {
2412
+ "aliases": [
2413
+ "sourcepath"
2414
+ ],
2415
+ "char": "p",
2416
+ "deprecateAliases": true,
2417
+ "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.",
2418
+ "exclusive": [
2419
+ "manifest",
2420
+ "metadata"
2421
+ ],
2422
+ "name": "source-dir",
2423
+ "summary": "Paths to the local source files to convert.",
2424
+ "delimiter": ",",
2425
+ "hasDynamicHelp": false,
2426
+ "multiple": true,
2427
+ "type": "option"
2428
+ },
2429
+ "metadata": {
2430
+ "char": "m",
2431
+ "exclusive": [
2432
+ "manifest",
2433
+ "sourcepath"
2434
+ ],
2435
+ "name": "metadata",
2436
+ "summary": "Metadata component names to convert.",
2437
+ "delimiter": ",",
2438
+ "hasDynamicHelp": false,
2439
+ "multiple": true,
2440
+ "type": "option"
2383
2441
  }
2384
2442
  },
2385
2443
  "hasDynamicHelp": true,
2386
2444
  "hiddenAliases": [],
2387
- "id": "project:deploy:validate",
2445
+ "id": "project:convert:source",
2388
2446
  "pluginAlias": "@salesforce/plugin-deploy-retrieve",
2389
2447
  "pluginName": "@salesforce/plugin-deploy-retrieve",
2390
2448
  "pluginType": "core",
2391
2449
  "strict": true,
2392
- "summary": "Validate a metadata deployment without actually executing it.",
2450
+ "summary": "Convert source-formatted files into metadata that you can deploy using Metadata API.",
2393
2451
  "enableJsonFlag": true,
2394
- "configurationVariablesSection": {
2395
- "header": "CONFIGURATION VARIABLES",
2396
- "body": [
2397
- {
2398
- "name": "target-org",
2399
- "description": "Username or alias of the org that all commands run against by default. (sf only)"
2400
- },
2401
- {
2402
- "name": "org-api-version",
2403
- "description": "API version of your project. Default: API version of your Dev Hub org."
2404
- }
2405
- ]
2406
- },
2407
- "envVariablesSection": {
2408
- "header": "ENVIRONMENT VARIABLES",
2409
- "body": [
2410
- {
2411
- "name": "SF_TARGET_ORG",
2412
- "description": "Username or alias of your default org. Overrides the target-org configuration variable."
2413
- },
2414
- {
2415
- "name": "SF_USE_PROGRESS_BAR",
2416
- "description": "Set to false to disable the progress bar when running the metadata deploy command."
2417
- }
2418
- ]
2419
- },
2420
- "errorCodes": {
2421
- "header": "ERROR CODES",
2422
- "body": [
2423
- {
2424
- "name": "Succeeded (0)",
2425
- "description": "The deploy succeeded."
2426
- },
2427
- {
2428
- "name": "Canceled (1)",
2429
- "description": "The deploy was canceled."
2430
- },
2431
- {
2432
- "name": "Failed (1)",
2433
- "description": "The deploy failed."
2434
- },
2435
- {
2436
- "name": "SucceededPartial (68)",
2437
- "description": "The deploy partially succeeded."
2438
- },
2439
- {
2440
- "name": "InProgress (69)",
2441
- "description": "The deploy is in progress."
2442
- },
2443
- {
2444
- "name": "Pending (69)",
2445
- "description": "The deploy is pending."
2446
- },
2447
- {
2448
- "name": "Canceling (69)",
2449
- "description": "The deploy is being canceled."
2450
- }
2451
- ]
2452
- },
2452
+ "requiresProject": true,
2453
2453
  "isESM": true,
2454
2454
  "relativePath": [
2455
2455
  "lib",
2456
2456
  "commands",
2457
2457
  "project",
2458
- "deploy",
2459
- "validate.js"
2458
+ "convert",
2459
+ "source.js"
2460
2460
  ],
2461
2461
  "aliasPermutations": [
2462
- "deploy:metadata:validate",
2463
- "metadata:deploy:validate",
2464
- "metadata:validate:deploy",
2465
- "deploy:validate:metadata",
2466
- "validate:deploy:metadata",
2467
- "validate:metadata:deploy"
2462
+ "force:source:convert",
2463
+ "source:force:convert",
2464
+ "source:convert:force",
2465
+ "force:convert:source",
2466
+ "convert:force:source",
2467
+ "convert:source:force"
2468
2468
  ],
2469
2469
  "permutations": [
2470
- "project:deploy:validate",
2471
- "deploy:project:validate",
2472
- "deploy:validate:project",
2473
- "project:validate:deploy",
2474
- "validate:project:deploy",
2475
- "validate:deploy:project"
2470
+ "project:convert:source",
2471
+ "convert:project:source",
2472
+ "convert:source:project",
2473
+ "project:source:convert",
2474
+ "source:project:convert",
2475
+ "source:convert:project"
2476
2476
  ]
2477
2477
  },
2478
2478
  "project:list:ignored": {
@@ -3050,5 +3050,5 @@
3050
3050
  ]
3051
3051
  }
3052
3052
  },
3053
- "version": "3.19.1"
3053
+ "version": "3.20.0"
3054
3054
  }