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