@salesforce/plugin-deploy-retrieve 3.21.2 → 3.21.3

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 +17 -17
  2. package/oclif.manifest.json +1361 -1361
  3. package/package.json +8 -8
package/oclif.manifest.json CHANGED
@@ -1,15 +1,15 @@
1
1
  {
2
2
  "commands": {
3
- "project:convert:mdapi": {
3
+ "project:deploy:cancel": {
4
4
  "aliases": [
5
- "force:mdapi:convert"
5
+ "deploy:metadata:cancel"
6
6
  ],
7
7
  "args": {},
8
8
  "deprecateAliases": true,
9
- "description": "To use Salesforce CLI to work with components that you retrieved via Metadata API, first convert your files from the metadata format to the source format using this command.\n\nTo convert files from the source format back to the metadata format, run \"sf project convert source\".\n\nTo convert multiple metadata components, either set multiple --metadata <name> flags or a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --source-dir.",
9
+ "description": "Use this command to 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.",
10
10
  "examples": [
11
- "Convert metadata formatted files in the specified directory into source formatted files; writes converted files to your default package directory:\n$ <%= config.bin %> <%= command.id %> --root-dir path/to/metadata",
12
- "Similar to previous example, but writes converted files to the specified output directory:\n$ <%= config.bin %> <%= command.id %> --root-dir path/to/metadata --output-dir path/to/outputdir"
11
+ "Cancel a deploy operation using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
12
+ "Cancel the most recent deploy operation:\n<%= config.bin %> <%= command.id %> --use-most-recent"
13
13
  ],
14
14
  "flags": {
15
15
  "json": {
@@ -27,136 +27,103 @@
27
27
  "multiple": false,
28
28
  "type": "option"
29
29
  },
30
- "api-version": {
31
- "aliases": [
32
- "apiversion"
33
- ],
34
- "deprecateAliases": true,
35
- "description": "Override the api version used for api requests made by this command",
36
- "name": "api-version",
37
- "hasDynamicHelp": false,
38
- "multiple": false,
39
- "type": "option"
40
- },
41
- "loglevel": {
42
- "deprecated": {
43
- "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."
44
- },
45
- "hidden": true,
46
- "name": "loglevel",
47
- "hasDynamicHelp": false,
48
- "multiple": false,
49
- "type": "option"
50
- },
51
- "root-dir": {
52
- "aliases": [
53
- "rootdir"
54
- ],
55
- "char": "r",
56
- "deprecateAliases": true,
57
- "name": "root-dir",
58
- "required": true,
59
- "summary": "Root directory that contains the Metadata API–formatted metadata.",
60
- "hasDynamicHelp": false,
30
+ "target-org": {
31
+ "char": "o",
32
+ "name": "target-org",
33
+ "noCacheDefault": true,
34
+ "summary": "Username or alias of the target org.",
35
+ "hasDynamicHelp": true,
61
36
  "multiple": false,
62
37
  "type": "option"
63
38
  },
64
- "output-dir": {
65
- "aliases": [
66
- "outputdir"
39
+ "async": {
40
+ "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\".",
41
+ "exclusive": [
42
+ "wait"
67
43
  ],
68
- "char": "d",
69
- "deprecateAliases": true,
70
- "name": "output-dir",
71
- "summary": "Directory to store your files in after they’re converted to source format; can be an absolute or relative path.",
72
- "hasDynamicHelp": false,
73
- "multiple": false,
74
- "type": "option"
44
+ "name": "async",
45
+ "summary": "Run the command asynchronously.",
46
+ "allowNo": false,
47
+ "type": "boolean"
75
48
  },
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.",
49
+ "job-id": {
50
+ "char": "i",
51
+ "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.",
52
+ "name": "job-id",
53
+ "summary": "Job ID of the deploy operation you want to cancel.",
81
54
  "hasDynamicHelp": false,
82
55
  "multiple": false,
83
56
  "type": "option"
84
57
  },
85
- "metadata-dir": {
86
- "aliases": [
87
- "metadatapath"
88
- ],
89
- "char": "p",
90
- "deprecateAliases": true,
91
- "description": "The supplied paths can be to a single file (in which case the operation is applied to only one file) or to a folder (in which case the operation is applied to all metadata types in the directory and its sub-directories).\n\nIf you specify this flag, don’t specify --manifest or --metadata. If the comma-separated list you’re supplying contains spaces, enclose the entire comma-separated list in one set of double quotes.",
92
- "exclusive": [
93
- "manifest",
94
- "metadata"
95
- ],
96
- "name": "metadata-dir",
97
- "summary": "Root of directory or zip file of metadata formatted files to convert.",
98
- "delimiter": ",",
99
- "hasDynamicHelp": false,
100
- "multiple": true,
101
- "type": "option"
58
+ "use-most-recent": {
59
+ "char": "r",
60
+ "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.",
61
+ "name": "use-most-recent",
62
+ "summary": "Use the job ID of the most recent deploy operation.",
63
+ "allowNo": false,
64
+ "type": "boolean"
102
65
  },
103
- "metadata": {
104
- "char": "m",
66
+ "wait": {
67
+ "char": "w",
68
+ "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\".",
105
69
  "exclusive": [
106
- "manifest",
107
- "metadatapath"
70
+ "async"
108
71
  ],
109
- "name": "metadata",
110
- "summary": "Metadata component names to convert.",
111
- "delimiter": ",",
112
- "hasDynamicHelp": false,
113
- "multiple": true,
72
+ "name": "wait",
73
+ "summary": "Number of minutes to wait for the command to complete and display results.",
74
+ "hasDynamicHelp": true,
75
+ "helpValue": "<minutes>",
76
+ "multiple": false,
114
77
  "type": "option"
115
78
  }
116
79
  },
117
- "hasDynamicHelp": false,
80
+ "hasDynamicHelp": true,
118
81
  "hiddenAliases": [],
119
- "id": "project:convert:mdapi",
82
+ "id": "project:deploy:cancel",
120
83
  "pluginAlias": "@salesforce/plugin-deploy-retrieve",
121
84
  "pluginName": "@salesforce/plugin-deploy-retrieve",
122
85
  "pluginType": "core",
123
86
  "strict": true,
124
- "summary": "Convert metadata retrieved via Metadata API into the source format used in Salesforce DX projects.",
87
+ "summary": "Cancel a deploy operation.",
125
88
  "enableJsonFlag": true,
126
- "requiresProject": true,
127
89
  "isESM": true,
128
90
  "relativePath": [
129
91
  "lib",
130
92
  "commands",
131
93
  "project",
132
- "convert",
133
- "mdapi.js"
94
+ "deploy",
95
+ "cancel.js"
134
96
  ],
135
97
  "aliasPermutations": [
136
- "force:mdapi:convert",
137
- "mdapi:force:convert",
138
- "mdapi:convert:force",
139
- "force:convert:mdapi",
140
- "convert:force:mdapi",
141
- "convert:mdapi:force"
98
+ "deploy:metadata:cancel",
99
+ "metadata:deploy:cancel",
100
+ "metadata:cancel:deploy",
101
+ "deploy:cancel:metadata",
102
+ "cancel:deploy:metadata",
103
+ "cancel:metadata:deploy"
142
104
  ],
143
105
  "permutations": [
144
- "project:convert:mdapi",
145
- "convert:project:mdapi",
146
- "convert:mdapi:project",
147
- "project:mdapi:convert",
148
- "mdapi:project:convert",
149
- "mdapi:convert:project"
106
+ "project:deploy:cancel",
107
+ "deploy:project:cancel",
108
+ "deploy:cancel:project",
109
+ "project:cancel:deploy",
110
+ "cancel:project:deploy",
111
+ "cancel:deploy:project"
150
112
  ]
151
113
  },
152
- "project:convert:source-behavior": {
153
- "aliases": [],
114
+ "project:deploy:preview": {
115
+ "aliases": [
116
+ "deploy:metadata:preview"
117
+ ],
154
118
  "args": {},
155
- "description": "Specifically, this command updates the \"sourceBehaviorOption\" option in the \"sfdx-project.json\" file and then converts the associated local source files in your project as needed.\n\nFor example, run this command with the \"--behavior decomposePermissionSetBeta\" flag to start decomposing permission sets when you deploy or retrieve them. Decomposing means breaking up the monolithic metadata API format XML file that corresponds to a metadata component into smaller XML files and directories based on its subtypes. Permission sets are not decomposed by default; you must opt-in to start decomposing them by using this command. When the command finishes, your \"sfdx-project.json\" file is updated to always decompose permission sets, and the existing permission set files in your local package directories are converted into the new decomposed format. You run this command only once for a given behavior change.\n\nFor more information about the possible values for the --behavior flag, see the \"sourceBehaviorOptions\" section in the https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_ws_config.htm topic.",
119
+ "deprecateAliases": true,
120
+ "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.",
156
121
  "examples": [
157
- "Update your Salesforce DX project to decompose custom permission sets:\n<%= config.bin %> <%= command.id %> --behavior decomposePermissionSetBeta",
158
- "Display what the command would do, but don't change any existing files:\n<%= config.bin %> <%= command.id %> --behavior decomposePermissionSetBeta --dry-run",
159
- "Keep the temporary directory that contains the interim metadata API formatted files:\n<%= config.bin %> <%= command.id %> --behavior decomposePermissionSetBeta --dry-run --preserve-temp-dir"
122
+ "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.",
123
+ "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",
124
+ "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",
125
+ "Preview deployment of a specific Apex class:\n<%= config.bin %> <%= command.id %> --metadata ApexClass:MyApexClass",
126
+ "Preview deployment of all components listed in a manifest:\n<%= config.bin %> <%= command.id %> --manifest path/to/package.xml"
160
127
  ],
161
128
  "flags": {
162
129
  "json": {
@@ -174,55 +141,77 @@
174
141
  "multiple": false,
175
142
  "type": "option"
176
143
  },
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.",
144
+ "ignore-conflicts": {
145
+ "char": "c",
146
+ "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.",
147
+ "name": "ignore-conflicts",
148
+ "summary": "Don't display conflicts in preview of the deployment.",
149
+ "allowNo": false,
150
+ "type": "boolean"
151
+ },
152
+ "manifest": {
153
+ "char": "x",
154
+ "description": "All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.",
155
+ "exclusive": [
156
+ "source-dir",
157
+ "metadata"
158
+ ],
159
+ "name": "manifest",
160
+ "summary": "Full file path for manifest (package.xml) of components to preview.",
182
161
  "hasDynamicHelp": false,
183
162
  "multiple": false,
184
- "options": [
185
- "decomposeCustomLabelsBeta2",
186
- "decomposeCustomLabelsBeta",
187
- "decomposePermissionSetBeta",
188
- "decomposePermissionSetBeta2",
189
- "decomposeSharingRulesBeta",
190
- "decomposeWorkflowBeta",
191
- "decomposeExternalServiceRegistrationBeta"
192
- ],
193
163
  "type": "option"
194
164
  },
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"
165
+ "metadata": {
166
+ "char": "m",
167
+ "exclusive": [
168
+ "manifest",
169
+ "source-dir"
170
+ ],
171
+ "name": "metadata",
172
+ "summary": "Metadata component names to preview.",
173
+ "hasDynamicHelp": false,
174
+ "multiple": true,
175
+ "type": "option"
200
176
  },
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"
177
+ "source-dir": {
178
+ "char": "d",
179
+ "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.",
180
+ "exclusive": [
181
+ "manifest",
182
+ "metadata"
183
+ ],
184
+ "name": "source-dir",
185
+ "summary": "Path to the local source files to preview.",
186
+ "hasDynamicHelp": false,
187
+ "multiple": true,
188
+ "type": "option"
206
189
  },
207
190
  "target-org": {
208
191
  "char": "o",
209
192
  "name": "target-org",
210
193
  "noCacheDefault": true,
211
- "summary": "Username or alias of the target org.",
194
+ "required": true,
195
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
212
196
  "hasDynamicHelp": true,
213
197
  "multiple": false,
214
198
  "type": "option"
199
+ },
200
+ "concise": {
201
+ "name": "concise",
202
+ "summary": "Show only the changes that will be deployed; omits files that are forceignored.",
203
+ "allowNo": false,
204
+ "type": "boolean"
215
205
  }
216
206
  },
217
207
  "hasDynamicHelp": true,
218
208
  "hiddenAliases": [],
219
- "id": "project:convert:source-behavior",
209
+ "id": "project:deploy:preview",
220
210
  "pluginAlias": "@salesforce/plugin-deploy-retrieve",
221
211
  "pluginName": "@salesforce/plugin-deploy-retrieve",
222
212
  "pluginType": "core",
223
- "state": "beta",
224
213
  "strict": true,
225
- "summary": "Enable a behavior of your project source files, and then update your Salesforce DX project to implement the behavior.",
214
+ "summary": "Preview a deployment to see what will deploy to the org, the potential conflicts, and the ignored files.",
226
215
  "enableJsonFlag": true,
227
216
  "requiresProject": true,
228
217
  "isESM": true,
@@ -230,29 +219,36 @@
230
219
  "lib",
231
220
  "commands",
232
221
  "project",
233
- "convert",
234
- "source-behavior.js"
222
+ "deploy",
223
+ "preview.js"
235
224
  ],
236
- "aliasPermutations": [],
237
- "permutations": [
238
- "project:convert:source-behavior",
239
- "convert:project:source-behavior",
240
- "convert:source-behavior:project",
241
- "project:source-behavior:convert",
242
- "source-behavior:project:convert",
243
- "source-behavior:convert:project"
225
+ "aliasPermutations": [
226
+ "deploy:metadata:preview",
227
+ "metadata:deploy:preview",
228
+ "metadata:preview:deploy",
229
+ "deploy:preview:metadata",
230
+ "preview:deploy:metadata",
231
+ "preview:metadata:deploy"
232
+ ],
233
+ "permutations": [
234
+ "project:deploy:preview",
235
+ "deploy:project:preview",
236
+ "deploy:preview:project",
237
+ "project:preview:deploy",
238
+ "preview:project:deploy",
239
+ "preview:deploy:project"
244
240
  ]
245
241
  },
246
- "project:convert:source": {
242
+ "project:deploy:quick": {
247
243
  "aliases": [
248
- "force:source:convert"
244
+ "deploy:metadata:quick"
249
245
  ],
250
246
  "args": {},
251
247
  "deprecateAliases": true,
252
- "description": "To convert source-formatted files into the metadata format, so that you can deploy them using Metadata API, run this command. Then deploy the metadata using \"<%= config.bin %> project deploy\".\n\nTo convert Metadata API–formatted files into the source format, run \"<%= config.bin %> project convert mdapi\".\n\nTo specify a package name that includes spaces, enclose the name in single quotes.\n\nTo convert multiple components, either set multiple --metadata <name> flags or a single --metadata flag with multiple names separated by spaces. Enclose names that contain spaces in one set of double quotes. The same syntax applies to --source-dir.",
248
+ "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.",
253
249
  "examples": [
254
- "Convert source-formatted files in the specified directory into metadata-formatted files; writes converted files into a new directory:\n$ <%= config.bin %> <%= command.id %> --root-dir path/to/source",
255
- "Similar to previous example, but writes converted files to the specified output directory and associates the files with the specified package:\n$ <%= config.bin %> <%= command.id %> --root-dir path/to/source --output-dir path/to/outputdir --package-name 'My Package'"
250
+ "Run a quick deploy to your default org using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
251
+ "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"
256
252
  ],
257
253
  "flags": {
258
254
  "json": {
@@ -270,151 +266,162 @@
270
266
  "multiple": false,
271
267
  "type": "option"
272
268
  },
273
- "api-version": {
274
- "aliases": [
275
- "apiversion"
269
+ "async": {
270
+ "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\".",
271
+ "exclusive": [
272
+ "wait"
276
273
  ],
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"
274
+ "name": "async",
275
+ "summary": "Run the command asynchronously.",
276
+ "allowNo": false,
277
+ "type": "boolean"
294
278
  },
295
- "root-dir": {
296
- "aliases": [
297
- "rootdir"
279
+ "concise": {
280
+ "exclusive": [
281
+ "verbose"
298
282
  ],
299
- "char": "r",
300
- "deprecateAliases": true,
301
- "name": "root-dir",
302
- "summary": "Source directory other than the default package to convert.",
283
+ "name": "concise",
284
+ "summary": "Show concise output of the deploy result.",
285
+ "allowNo": false,
286
+ "type": "boolean"
287
+ },
288
+ "job-id": {
289
+ "char": "i",
290
+ "description": "The job ID is valid for 10 days from when you started the validation.",
291
+ "name": "job-id",
292
+ "summary": "Job ID of the deployment you want to quick deploy.",
303
293
  "hasDynamicHelp": false,
304
294
  "multiple": false,
305
295
  "type": "option"
306
296
  },
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<",
297
+ "target-org": {
298
+ "char": "o",
299
+ "name": "target-org",
300
+ "noCacheDefault": true,
301
+ "summary": "Username or alias of the target org.",
316
302
  "hasDynamicHelp": true,
317
303
  "multiple": false,
318
304
  "type": "option"
319
305
  },
320
- "package-name": {
321
- "aliases": [
322
- "packagename"
323
- ],
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"
331
- },
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.",
337
- "hasDynamicHelp": false,
338
- "multiple": false,
339
- "type": "option"
306
+ "use-most-recent": {
307
+ "char": "r",
308
+ "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.",
309
+ "name": "use-most-recent",
310
+ "summary": "Use the job ID of the most recently validated deployment.",
311
+ "allowNo": false,
312
+ "type": "boolean"
340
313
  },
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.",
314
+ "verbose": {
348
315
  "exclusive": [
349
- "manifest",
350
- "metadata"
316
+ "concise"
351
317
  ],
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"
318
+ "name": "verbose",
319
+ "summary": "Show verbose output of the deploy result.",
320
+ "allowNo": false,
321
+ "type": "boolean"
358
322
  },
359
- "metadata": {
360
- "char": "m",
323
+ "wait": {
324
+ "char": "w",
325
+ "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\".",
361
326
  "exclusive": [
362
- "manifest",
363
- "sourcepath"
327
+ "async"
364
328
  ],
365
- "name": "metadata",
366
- "summary": "Metadata component names to convert.",
367
- "delimiter": ",",
329
+ "name": "wait",
330
+ "summary": "Number of minutes to wait for the command to complete and display results.",
331
+ "default": "33 minutes",
332
+ "hasDynamicHelp": true,
333
+ "helpValue": "<minutes>",
334
+ "multiple": false,
335
+ "type": "option"
336
+ },
337
+ "api-version": {
338
+ "char": "a",
339
+ "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.",
340
+ "name": "api-version",
341
+ "summary": "Target API version for the deploy.",
368
342
  "hasDynamicHelp": false,
369
- "multiple": true,
343
+ "multiple": false,
370
344
  "type": "option"
371
345
  }
372
346
  },
373
347
  "hasDynamicHelp": true,
374
348
  "hiddenAliases": [],
375
- "id": "project:convert:source",
349
+ "id": "project:deploy:quick",
376
350
  "pluginAlias": "@salesforce/plugin-deploy-retrieve",
377
351
  "pluginName": "@salesforce/plugin-deploy-retrieve",
378
352
  "pluginType": "core",
379
353
  "strict": true,
380
- "summary": "Convert source-formatted files into metadata that you can deploy using Metadata API.",
354
+ "summary": "Quickly deploy a validated deployment to an org.",
381
355
  "enableJsonFlag": true,
382
- "requiresProject": true,
356
+ "errorCodes": {
357
+ "header": "ERROR CODES",
358
+ "body": [
359
+ {
360
+ "name": "Succeeded (0)",
361
+ "description": "The deploy succeeded."
362
+ },
363
+ {
364
+ "name": "Canceled (1)",
365
+ "description": "The deploy was canceled."
366
+ },
367
+ {
368
+ "name": "Failed (1)",
369
+ "description": "The deploy failed."
370
+ },
371
+ {
372
+ "name": "SucceededPartial (68)",
373
+ "description": "The deploy partially succeeded."
374
+ },
375
+ {
376
+ "name": "InProgress (69)",
377
+ "description": "The deploy is in progress."
378
+ },
379
+ {
380
+ "name": "Pending (69)",
381
+ "description": "The deploy is pending."
382
+ },
383
+ {
384
+ "name": "Canceling (69)",
385
+ "description": "The deploy is being canceled."
386
+ }
387
+ ]
388
+ },
383
389
  "isESM": true,
384
390
  "relativePath": [
385
391
  "lib",
386
392
  "commands",
387
393
  "project",
388
- "convert",
389
- "source.js"
394
+ "deploy",
395
+ "quick.js"
390
396
  ],
391
397
  "aliasPermutations": [
392
- "force:source:convert",
393
- "source:force:convert",
394
- "source:convert:force",
395
- "force:convert:source",
396
- "convert:force:source",
397
- "convert:source:force"
398
+ "deploy:metadata:quick",
399
+ "metadata:deploy:quick",
400
+ "metadata:quick:deploy",
401
+ "deploy:quick:metadata",
402
+ "quick:deploy:metadata",
403
+ "quick:metadata:deploy"
398
404
  ],
399
405
  "permutations": [
400
- "project:convert:source",
401
- "convert:project:source",
402
- "convert:source:project",
403
- "project:source:convert",
404
- "source:project:convert",
405
- "source:convert:project"
406
+ "project:deploy:quick",
407
+ "deploy:project:quick",
408
+ "deploy:quick:project",
409
+ "project:quick:deploy",
410
+ "quick:project:deploy",
411
+ "quick:deploy:project"
406
412
  ]
407
413
  },
408
- "project:deploy:cancel": {
414
+ "project:deploy:report": {
409
415
  "aliases": [
410
- "deploy:metadata:cancel"
416
+ "deploy:metadata:report"
411
417
  ],
412
418
  "args": {},
413
419
  "deprecateAliases": true,
414
- "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.",
420
+ "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.",
415
421
  "examples": [
416
- "Cancel a deploy operation using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
417
- "Cancel the most recent deploy operation:\n<%= config.bin %> <%= command.id %> --use-most-recent"
422
+ "Check the status using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
423
+ "Check the status of the most recent deploy operation:\n<%= config.bin %> <%= command.id %> --use-most-recent",
424
+ "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"
418
425
  ],
419
426
  "flags": {
420
427
  "json": {
@@ -441,219 +448,124 @@
441
448
  "multiple": false,
442
449
  "type": "option"
443
450
  },
444
- "async": {
445
- "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\".",
446
- "exclusive": [
447
- "wait"
448
- ],
449
- "name": "async",
450
- "summary": "Run the command asynchronously.",
451
- "allowNo": false,
452
- "type": "boolean"
453
- },
454
451
  "job-id": {
455
452
  "char": "i",
456
453
  "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.",
457
454
  "name": "job-id",
458
- "summary": "Job ID of the deploy operation you want to cancel.",
455
+ "summary": "Job ID of the deploy operation you want to check the status of.",
459
456
  "hasDynamicHelp": false,
460
457
  "multiple": false,
461
458
  "type": "option"
462
459
  },
463
460
  "use-most-recent": {
464
461
  "char": "r",
465
- "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.",
462
+ "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.",
466
463
  "name": "use-most-recent",
467
464
  "summary": "Use the job ID of the most recent deploy operation.",
468
465
  "allowNo": false,
469
466
  "type": "boolean"
470
467
  },
471
- "wait": {
472
- "char": "w",
473
- "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\".",
474
- "exclusive": [
475
- "async"
476
- ],
477
- "name": "wait",
478
- "summary": "Number of minutes to wait for the command to complete and display results.",
479
- "hasDynamicHelp": true,
480
- "helpValue": "<minutes>",
481
- "multiple": false,
482
- "type": "option"
483
- }
484
- },
485
- "hasDynamicHelp": true,
486
- "hiddenAliases": [],
487
- "id": "project:deploy:cancel",
488
- "pluginAlias": "@salesforce/plugin-deploy-retrieve",
489
- "pluginName": "@salesforce/plugin-deploy-retrieve",
490
- "pluginType": "core",
491
- "strict": true,
492
- "summary": "Cancel a deploy operation.",
493
- "enableJsonFlag": true,
494
- "isESM": true,
495
- "relativePath": [
496
- "lib",
497
- "commands",
498
- "project",
499
- "deploy",
500
- "cancel.js"
501
- ],
502
- "aliasPermutations": [
503
- "deploy:metadata:cancel",
504
- "metadata:deploy:cancel",
505
- "metadata:cancel:deploy",
506
- "deploy:cancel:metadata",
507
- "cancel:deploy:metadata",
508
- "cancel:metadata:deploy"
509
- ],
510
- "permutations": [
511
- "project:deploy:cancel",
512
- "deploy:project:cancel",
513
- "deploy:cancel:project",
514
- "project:cancel:deploy",
515
- "cancel:project:deploy",
516
- "cancel:deploy:project"
517
- ]
518
- },
519
- "project:deploy:preview": {
520
- "aliases": [
521
- "deploy:metadata:preview"
522
- ],
523
- "args": {},
524
- "deprecateAliases": true,
525
- "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.",
526
- "examples": [
527
- "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.",
528
- "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",
529
- "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",
530
- "Preview deployment of a specific Apex class:\n<%= config.bin %> <%= command.id %> --metadata ApexClass:MyApexClass",
531
- "Preview deployment of all components listed in a manifest:\n<%= config.bin %> <%= command.id %> --manifest path/to/package.xml"
532
- ],
533
- "flags": {
534
- "json": {
535
- "description": "Format output as json.",
536
- "helpGroup": "GLOBAL",
537
- "name": "json",
538
- "allowNo": false,
539
- "type": "boolean"
540
- },
541
- "flags-dir": {
542
- "helpGroup": "GLOBAL",
543
- "name": "flags-dir",
544
- "summary": "Import flag values from a directory.",
468
+ "coverage-formatters": {
469
+ "description": "For multiple formatters, repeat the flag for each formatter.\n--coverage-formatters lcov --coverage-formatters clover",
470
+ "helpGroup": "Test",
471
+ "name": "coverage-formatters",
472
+ "summary": "Format of the code coverage results.",
545
473
  "hasDynamicHelp": false,
546
- "multiple": false,
474
+ "multiple": true,
475
+ "options": [
476
+ "clover",
477
+ "cobertura",
478
+ "html-spa",
479
+ "html",
480
+ "json",
481
+ "json-summary",
482
+ "lcovonly",
483
+ "none",
484
+ "teamcity",
485
+ "text",
486
+ "text-summary"
487
+ ],
547
488
  "type": "option"
548
489
  },
549
- "ignore-conflicts": {
550
- "char": "c",
551
- "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.",
552
- "name": "ignore-conflicts",
553
- "summary": "Don't display conflicts in preview of the deployment.",
490
+ "junit": {
491
+ "helpGroup": "Test",
492
+ "name": "junit",
493
+ "summary": "Output JUnit test results.",
554
494
  "allowNo": false,
555
495
  "type": "boolean"
556
496
  },
557
- "manifest": {
558
- "char": "x",
559
- "description": "All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.",
560
- "exclusive": [
561
- "source-dir",
562
- "metadata"
497
+ "results-dir": {
498
+ "helpGroup": "Test",
499
+ "name": "results-dir",
500
+ "relationships": [
501
+ {
502
+ "type": "some",
503
+ "flags": [
504
+ "coverage-formatters",
505
+ "junit"
506
+ ]
507
+ }
563
508
  ],
564
- "name": "manifest",
565
- "summary": "Full file path for manifest (package.xml) of components to preview.",
509
+ "summary": "Output directory for code coverage and JUnit results; defaults to the deploy ID.",
566
510
  "hasDynamicHelp": false,
567
511
  "multiple": false,
568
512
  "type": "option"
569
513
  },
570
- "metadata": {
571
- "char": "m",
572
- "exclusive": [
573
- "manifest",
574
- "source-dir"
575
- ],
576
- "name": "metadata",
577
- "summary": "Metadata component names to preview.",
578
- "hasDynamicHelp": false,
579
- "multiple": true,
580
- "type": "option"
581
- },
582
- "source-dir": {
583
- "char": "d",
584
- "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.",
585
- "exclusive": [
586
- "manifest",
587
- "metadata"
588
- ],
589
- "name": "source-dir",
590
- "summary": "Path to the local source files to preview.",
591
- "hasDynamicHelp": false,
592
- "multiple": true,
593
- "type": "option"
594
- },
595
- "target-org": {
596
- "char": "o",
597
- "name": "target-org",
598
- "noCacheDefault": true,
599
- "required": true,
600
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
514
+ "wait": {
515
+ "char": "w",
516
+ "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\".",
517
+ "name": "wait",
518
+ "summary": "Number of minutes to wait for command to complete and display results.",
601
519
  "hasDynamicHelp": true,
520
+ "helpValue": "<minutes>",
602
521
  "multiple": false,
603
522
  "type": "option"
604
- },
605
- "concise": {
606
- "name": "concise",
607
- "summary": "Show only the changes that will be deployed; omits files that are forceignored.",
608
- "allowNo": false,
609
- "type": "boolean"
610
523
  }
611
524
  },
612
525
  "hasDynamicHelp": true,
613
526
  "hiddenAliases": [],
614
- "id": "project:deploy:preview",
527
+ "id": "project:deploy:report",
615
528
  "pluginAlias": "@salesforce/plugin-deploy-retrieve",
616
529
  "pluginName": "@salesforce/plugin-deploy-retrieve",
617
530
  "pluginType": "core",
618
531
  "strict": true,
619
- "summary": "Preview a deployment to see what will deploy to the org, the potential conflicts, and the ignored files.",
532
+ "summary": "Check or poll for the status of a deploy operation.",
620
533
  "enableJsonFlag": true,
621
- "requiresProject": true,
622
534
  "isESM": true,
623
535
  "relativePath": [
624
536
  "lib",
625
537
  "commands",
626
538
  "project",
627
539
  "deploy",
628
- "preview.js"
540
+ "report.js"
629
541
  ],
630
542
  "aliasPermutations": [
631
- "deploy:metadata:preview",
632
- "metadata:deploy:preview",
633
- "metadata:preview:deploy",
634
- "deploy:preview:metadata",
635
- "preview:deploy:metadata",
636
- "preview:metadata:deploy"
543
+ "deploy:metadata:report",
544
+ "metadata:deploy:report",
545
+ "metadata:report:deploy",
546
+ "deploy:report:metadata",
547
+ "report:deploy:metadata",
548
+ "report:metadata:deploy"
637
549
  ],
638
550
  "permutations": [
639
- "project:deploy:preview",
640
- "deploy:project:preview",
641
- "deploy:preview:project",
642
- "project:preview:deploy",
643
- "preview:project:deploy",
644
- "preview:deploy:project"
551
+ "project:deploy:report",
552
+ "deploy:project:report",
553
+ "deploy:report:project",
554
+ "project:report:deploy",
555
+ "report:project:deploy",
556
+ "report:deploy:project"
645
557
  ]
646
558
  },
647
- "project:deploy:quick": {
559
+ "project:deploy:resume": {
648
560
  "aliases": [
649
- "deploy:metadata:quick"
561
+ "deploy:metadata:resume"
650
562
  ],
651
563
  "args": {},
652
564
  "deprecateAliases": true,
653
- "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.",
565
+ "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.",
654
566
  "examples": [
655
- "Run a quick deploy to your default org using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
656
- "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"
567
+ "Resume watching a deploy operation using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
568
+ "Resume watching the most recent deploy operation:\n<%= config.bin %> <%= command.id %> --use-most-recent"
657
569
  ],
658
570
  "flags": {
659
571
  "json": {
@@ -671,48 +583,29 @@
671
583
  "multiple": false,
672
584
  "type": "option"
673
585
  },
674
- "async": {
675
- "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\".",
676
- "exclusive": [
677
- "wait"
678
- ],
679
- "name": "async",
680
- "summary": "Run the command asynchronously.",
681
- "allowNo": false,
682
- "type": "boolean"
683
- },
684
586
  "concise": {
685
587
  "exclusive": [
686
588
  "verbose"
687
589
  ],
688
590
  "name": "concise",
689
- "summary": "Show concise output of the deploy result.",
591
+ "summary": "Show concise output of the deploy operation result.",
690
592
  "allowNo": false,
691
593
  "type": "boolean"
692
594
  },
693
595
  "job-id": {
694
596
  "char": "i",
695
- "description": "The job ID is valid for 10 days from when you started the validation.",
597
+ "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.",
696
598
  "name": "job-id",
697
- "summary": "Job ID of the deployment you want to quick deploy.",
599
+ "summary": "Job ID of the deploy operation you want to resume.",
698
600
  "hasDynamicHelp": false,
699
601
  "multiple": false,
700
602
  "type": "option"
701
603
  },
702
- "target-org": {
703
- "char": "o",
704
- "name": "target-org",
705
- "noCacheDefault": true,
706
- "summary": "Username or alias of the target org.",
707
- "hasDynamicHelp": true,
708
- "multiple": false,
709
- "type": "option"
710
- },
711
604
  "use-most-recent": {
712
605
  "char": "r",
713
- "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.",
606
+ "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.",
714
607
  "name": "use-most-recent",
715
- "summary": "Use the job ID of the most recently validated deployment.",
608
+ "summary": "Use the job ID of the most recent deploy operation.",
716
609
  "allowNo": false,
717
610
  "type": "boolean"
718
611
  },
@@ -721,43 +614,85 @@
721
614
  "concise"
722
615
  ],
723
616
  "name": "verbose",
724
- "summary": "Show verbose output of the deploy result.",
617
+ "summary": "Show verbose output of the deploy operation result.",
725
618
  "allowNo": false,
726
619
  "type": "boolean"
727
620
  },
728
621
  "wait": {
729
622
  "char": "w",
730
- "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\".",
731
- "exclusive": [
732
- "async"
733
- ],
623
+ "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\".",
734
624
  "name": "wait",
735
625
  "summary": "Number of minutes to wait for the command to complete and display results.",
736
- "default": "33 minutes",
737
626
  "hasDynamicHelp": true,
738
627
  "helpValue": "<minutes>",
739
628
  "multiple": false,
740
629
  "type": "option"
741
630
  },
742
- "api-version": {
743
- "char": "a",
744
- "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.",
745
- "name": "api-version",
746
- "summary": "Target API version for the deploy.",
631
+ "coverage-formatters": {
632
+ "description": "For multiple formatters, repeat the flag for each formatter.\n--coverage-formatters lcov --coverage-formatters clover",
633
+ "helpGroup": "Test",
634
+ "name": "coverage-formatters",
635
+ "summary": "Format of the code coverage results.",
747
636
  "hasDynamicHelp": false,
748
- "multiple": false,
749
- "type": "option"
750
- }
637
+ "multiple": true,
638
+ "options": [
639
+ "clover",
640
+ "cobertura",
641
+ "html-spa",
642
+ "html",
643
+ "json",
644
+ "json-summary",
645
+ "lcovonly",
646
+ "none",
647
+ "teamcity",
648
+ "text",
649
+ "text-summary"
650
+ ],
651
+ "type": "option"
652
+ },
653
+ "junit": {
654
+ "helpGroup": "Test",
655
+ "name": "junit",
656
+ "summary": "Output JUnit test results.",
657
+ "allowNo": false,
658
+ "type": "boolean"
659
+ },
660
+ "results-dir": {
661
+ "helpGroup": "Test",
662
+ "name": "results-dir",
663
+ "relationships": [
664
+ {
665
+ "type": "some",
666
+ "flags": [
667
+ "coverage-formatters",
668
+ "junit"
669
+ ]
670
+ }
671
+ ],
672
+ "summary": "Output directory for code coverage and JUnit results; defaults to the deploy ID.",
673
+ "hasDynamicHelp": false,
674
+ "multiple": false,
675
+ "type": "option"
676
+ }
751
677
  },
752
678
  "hasDynamicHelp": true,
753
679
  "hiddenAliases": [],
754
- "id": "project:deploy:quick",
680
+ "id": "project:deploy:resume",
755
681
  "pluginAlias": "@salesforce/plugin-deploy-retrieve",
756
682
  "pluginName": "@salesforce/plugin-deploy-retrieve",
757
683
  "pluginType": "core",
758
684
  "strict": true,
759
- "summary": "Quickly deploy a validated deployment to an org.",
685
+ "summary": "Resume watching a deploy operation and update source tracking when the deploy completes.",
760
686
  "enableJsonFlag": true,
687
+ "envVariablesSection": {
688
+ "header": "ENVIRONMENT VARIABLES",
689
+ "body": [
690
+ {
691
+ "name": "SF_USE_PROGRESS_BAR",
692
+ "description": "Set to false to disable the progress bar when running the metadata deploy command."
693
+ }
694
+ ]
695
+ },
761
696
  "errorCodes": {
762
697
  "header": "ERROR CODES",
763
698
  "body": [
@@ -797,36 +732,47 @@
797
732
  "commands",
798
733
  "project",
799
734
  "deploy",
800
- "quick.js"
735
+ "resume.js"
801
736
  ],
802
737
  "aliasPermutations": [
803
- "deploy:metadata:quick",
804
- "metadata:deploy:quick",
805
- "metadata:quick:deploy",
806
- "deploy:quick:metadata",
807
- "quick:deploy:metadata",
808
- "quick:metadata:deploy"
738
+ "deploy:metadata:resume",
739
+ "metadata:deploy:resume",
740
+ "metadata:resume:deploy",
741
+ "deploy:resume:metadata",
742
+ "resume:deploy:metadata",
743
+ "resume:metadata:deploy"
809
744
  ],
810
745
  "permutations": [
811
- "project:deploy:quick",
812
- "deploy:project:quick",
813
- "deploy:quick:project",
814
- "project:quick:deploy",
815
- "quick:project:deploy",
816
- "quick:deploy:project"
746
+ "project:deploy:resume",
747
+ "deploy:project:resume",
748
+ "deploy:resume:project",
749
+ "project:resume:deploy",
750
+ "resume:project:deploy",
751
+ "resume:deploy:project"
817
752
  ]
818
753
  },
819
- "project:deploy:report": {
754
+ "project:deploy:start": {
820
755
  "aliases": [
821
- "deploy:metadata:report"
756
+ "deploy:metadata"
822
757
  ],
823
758
  "args": {},
824
759
  "deprecateAliases": true,
825
- "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.",
760
+ "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.",
826
761
  "examples": [
827
- "Check the status using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
828
- "Check the status of the most recent deploy operation:\n<%= config.bin %> <%= command.id %> --use-most-recent",
829
- "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"
762
+ "Deploy local changes not in the org; uses your default org:\n<%= config.bin %> <%= command.id %>",
763
+ "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",
764
+ "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",
765
+ "Deploy all Apex classes that are in all package directories defined in the \"sfdx-project.json\" file:\n<%= config.bin %> <%= command.id %> --metadata ApexClass",
766
+ "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",
767
+ "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",
768
+ "Deploy a custom object called ExcitingObject that's in the SBQQ namespace:\nsf <%= command.id %> --metadata CustomObject:SBQQ__ExcitingObject",
769
+ "Deploy all custom objects in the SBQQ namespace by using a wildcard and quotes:\nsf <%= command.id %> --metadata 'CustomObject:SBQQ__*'",
770
+ "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",
771
+ "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\"",
772
+ "Deploy all components listed in a manifest:\n<%= config.bin %> <%= command.id %> --manifest path/to/package.xml",
773
+ "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",
774
+ "Deploy all metadata formatted files in the \"MDAPI\" directory:\n<%= config.bin %> <%= command.id %> --metadata-dir MDAPI",
775
+ "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"
830
776
  ],
831
777
  "flags": {
832
778
  "json": {
@@ -844,195 +790,229 @@
844
790
  "multiple": false,
845
791
  "type": "option"
846
792
  },
847
- "target-org": {
848
- "char": "o",
849
- "name": "target-org",
850
- "noCacheDefault": true,
851
- "summary": "Username or alias of the target org.",
852
- "hasDynamicHelp": true,
853
- "multiple": false,
854
- "type": "option"
855
- },
856
- "job-id": {
857
- "char": "i",
858
- "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.",
859
- "name": "job-id",
860
- "summary": "Job ID of the deploy operation you want to check the status of.",
793
+ "api-version": {
794
+ "char": "a",
795
+ "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.",
796
+ "name": "api-version",
797
+ "summary": "Target API version for the deploy.",
861
798
  "hasDynamicHelp": false,
862
799
  "multiple": false,
863
800
  "type": "option"
864
801
  },
865
- "use-most-recent": {
866
- "char": "r",
867
- "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.",
868
- "name": "use-most-recent",
869
- "summary": "Use the job ID of the most recent deploy operation.",
802
+ "async": {
803
+ "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\".",
804
+ "exclusive": [
805
+ "wait"
806
+ ],
807
+ "name": "async",
808
+ "summary": "Run the command asynchronously.",
870
809
  "allowNo": false,
871
810
  "type": "boolean"
872
811
  },
873
- "coverage-formatters": {
874
- "description": "For multiple formatters, repeat the flag for each formatter.\n--coverage-formatters lcov --coverage-formatters clover",
875
- "helpGroup": "Test",
876
- "name": "coverage-formatters",
877
- "summary": "Format of the code coverage results.",
878
- "hasDynamicHelp": false,
879
- "multiple": true,
880
- "options": [
881
- "clover",
882
- "cobertura",
883
- "html-spa",
884
- "html",
885
- "json",
886
- "json-summary",
887
- "lcovonly",
888
- "none",
889
- "teamcity",
890
- "text",
891
- "text-summary"
812
+ "concise": {
813
+ "exclusive": [
814
+ "verbose"
892
815
  ],
893
- "type": "option"
816
+ "name": "concise",
817
+ "summary": "Show concise output of the deploy result.",
818
+ "allowNo": false,
819
+ "type": "boolean"
894
820
  },
895
- "junit": {
896
- "helpGroup": "Test",
897
- "name": "junit",
898
- "summary": "Output JUnit test results.",
821
+ "dry-run": {
822
+ "name": "dry-run",
823
+ "summary": "Validate deploy and run Apex tests but don’t save to the org.",
899
824
  "allowNo": false,
900
825
  "type": "boolean"
901
826
  },
902
- "results-dir": {
903
- "helpGroup": "Test",
904
- "name": "results-dir",
905
- "relationships": [
906
- {
907
- "type": "some",
908
- "flags": [
909
- "coverage-formatters",
910
- "junit"
911
- ]
912
- }
827
+ "ignore-conflicts": {
828
+ "char": "c",
829
+ "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.",
830
+ "name": "ignore-conflicts",
831
+ "summary": "Ignore conflicts and deploy local files, even if they overwrite changes in the org.",
832
+ "allowNo": false,
833
+ "type": "boolean"
834
+ },
835
+ "ignore-errors": {
836
+ "char": "r",
837
+ "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.",
838
+ "name": "ignore-errors",
839
+ "summary": "Ignore any errors and don’t roll back deployment.",
840
+ "allowNo": false,
841
+ "type": "boolean"
842
+ },
843
+ "ignore-warnings": {
844
+ "char": "g",
845
+ "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.",
846
+ "name": "ignore-warnings",
847
+ "summary": "Ignore warnings and allow a deployment to complete successfully.",
848
+ "allowNo": false,
849
+ "type": "boolean"
850
+ },
851
+ "manifest": {
852
+ "char": "x",
853
+ "description": "All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.",
854
+ "exclusive": [
855
+ "source-dir",
856
+ "metadata",
857
+ "metadata-dir"
913
858
  ],
914
- "summary": "Output directory for code coverage and JUnit results; defaults to the deploy ID.",
859
+ "helpGroup": "Source Format",
860
+ "name": "manifest",
861
+ "summary": "Full file path for manifest (package.xml) of components to deploy.",
915
862
  "hasDynamicHelp": false,
916
863
  "multiple": false,
917
864
  "type": "option"
918
865
  },
919
- "wait": {
920
- "char": "w",
921
- "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\".",
922
- "name": "wait",
923
- "summary": "Number of minutes to wait for command to complete and display results.",
924
- "hasDynamicHelp": true,
925
- "helpValue": "<minutes>",
866
+ "metadata": {
867
+ "char": "m",
868
+ "exclusive": [
869
+ "manifest",
870
+ "source-dir",
871
+ "metadata-dir"
872
+ ],
873
+ "helpGroup": "Source Format",
874
+ "name": "metadata",
875
+ "summary": "Metadata component names to deploy. Wildcards (`*` ) supported as long as you use quotes, such as `ApexClass:MyClass*`.",
876
+ "hasDynamicHelp": false,
877
+ "multiple": true,
878
+ "type": "option"
879
+ },
880
+ "metadata-dir": {
881
+ "exclusive": [
882
+ "manifest",
883
+ "source-dir",
884
+ "metadata"
885
+ ],
886
+ "helpGroup": "Metadata API Format",
887
+ "name": "metadata-dir",
888
+ "summary": "Root of directory or zip file of metadata formatted files to deploy.",
889
+ "hasDynamicHelp": false,
926
890
  "multiple": false,
927
891
  "type": "option"
928
- }
929
- },
930
- "hasDynamicHelp": true,
931
- "hiddenAliases": [],
932
- "id": "project:deploy:report",
933
- "pluginAlias": "@salesforce/plugin-deploy-retrieve",
934
- "pluginName": "@salesforce/plugin-deploy-retrieve",
935
- "pluginType": "core",
936
- "strict": true,
937
- "summary": "Check or poll for the status of a deploy operation.",
938
- "enableJsonFlag": true,
939
- "isESM": true,
940
- "relativePath": [
941
- "lib",
942
- "commands",
943
- "project",
944
- "deploy",
945
- "report.js"
946
- ],
947
- "aliasPermutations": [
948
- "deploy:metadata:report",
949
- "metadata:deploy:report",
950
- "metadata:report:deploy",
951
- "deploy:report:metadata",
952
- "report:deploy:metadata",
953
- "report:metadata:deploy"
954
- ],
955
- "permutations": [
956
- "project:deploy:report",
957
- "deploy:project:report",
958
- "deploy:report:project",
959
- "project:report:deploy",
960
- "report:project:deploy",
961
- "report:deploy:project"
962
- ]
963
- },
964
- "project:deploy:resume": {
965
- "aliases": [
966
- "deploy:metadata:resume"
967
- ],
968
- "args": {},
969
- "deprecateAliases": true,
970
- "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.",
971
- "examples": [
972
- "Resume watching a deploy operation using a job ID:\n<%= config.bin %> <%= command.id %> --job-id 0Af0x000017yLUFCA2",
973
- "Resume watching the most recent deploy operation:\n<%= config.bin %> <%= command.id %> --use-most-recent"
974
- ],
975
- "flags": {
976
- "json": {
977
- "description": "Format output as json.",
978
- "helpGroup": "GLOBAL",
979
- "name": "json",
892
+ },
893
+ "single-package": {
894
+ "dependsOn": [
895
+ "metadata-dir"
896
+ ],
897
+ "helpGroup": "Metadata API Format",
898
+ "name": "single-package",
899
+ "summary": "Indicates that the metadata zip file points to a directory structure for a single package.",
980
900
  "allowNo": false,
981
901
  "type": "boolean"
982
902
  },
983
- "flags-dir": {
984
- "helpGroup": "GLOBAL",
985
- "name": "flags-dir",
986
- "summary": "Import flag values from a directory.",
903
+ "source-dir": {
904
+ "char": "d",
905
+ "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.",
906
+ "exclusive": [
907
+ "manifest",
908
+ "metadata",
909
+ "metadata-dir"
910
+ ],
911
+ "helpGroup": "Source Format",
912
+ "name": "source-dir",
913
+ "summary": "Path to the local source files to deploy.",
987
914
  "hasDynamicHelp": false,
915
+ "multiple": true,
916
+ "type": "option"
917
+ },
918
+ "target-org": {
919
+ "char": "o",
920
+ "name": "target-org",
921
+ "noCacheDefault": true,
922
+ "required": true,
923
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
924
+ "hasDynamicHelp": true,
988
925
  "multiple": false,
989
926
  "type": "option"
990
927
  },
991
- "concise": {
992
- "exclusive": [
993
- "verbose"
994
- ],
995
- "name": "concise",
996
- "summary": "Show concise output of the deploy operation result.",
997
- "allowNo": false,
998
- "type": "boolean"
928
+ "tests": {
929
+ "char": "t",
930
+ "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\"",
931
+ "helpGroup": "Test",
932
+ "name": "tests",
933
+ "summary": "Apex tests to run when --test-level is RunSpecifiedTests.",
934
+ "hasDynamicHelp": false,
935
+ "multiple": true,
936
+ "type": "option"
999
937
  },
1000
- "job-id": {
1001
- "char": "i",
1002
- "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.",
1003
- "name": "job-id",
1004
- "summary": "Job ID of the deploy operation you want to resume.",
938
+ "test-level": {
939
+ "char": "l",
940
+ "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\".",
941
+ "helpGroup": "Test",
942
+ "name": "test-level",
943
+ "summary": "Deployment Apex testing level.",
1005
944
  "hasDynamicHelp": false,
1006
945
  "multiple": false,
946
+ "options": [
947
+ "NoTestRun",
948
+ "RunSpecifiedTests",
949
+ "RunLocalTests",
950
+ "RunAllTestsInOrg"
951
+ ],
1007
952
  "type": "option"
1008
953
  },
1009
- "use-most-recent": {
1010
- "char": "r",
1011
- "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.",
1012
- "name": "use-most-recent",
1013
- "summary": "Use the job ID of the most recent deploy operation.",
1014
- "allowNo": false,
1015
- "type": "boolean"
1016
- },
1017
954
  "verbose": {
1018
955
  "exclusive": [
1019
956
  "concise"
1020
957
  ],
1021
958
  "name": "verbose",
1022
- "summary": "Show verbose output of the deploy operation result.",
959
+ "summary": "Show verbose output of the deploy result.",
1023
960
  "allowNo": false,
1024
961
  "type": "boolean"
1025
962
  },
1026
963
  "wait": {
1027
964
  "char": "w",
1028
- "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\".",
965
+ "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\".",
966
+ "exclusive": [
967
+ "async"
968
+ ],
1029
969
  "name": "wait",
1030
- "summary": "Number of minutes to wait for the command to complete and display results.",
970
+ "summary": "Number of minutes to wait for command to complete and display results.",
1031
971
  "hasDynamicHelp": true,
1032
972
  "helpValue": "<minutes>",
1033
973
  "multiple": false,
1034
974
  "type": "option"
1035
975
  },
976
+ "purge-on-delete": {
977
+ "helpGroup": "Delete",
978
+ "name": "purge-on-delete",
979
+ "relationships": [
980
+ {
981
+ "type": "some",
982
+ "flags": [
983
+ "pre-destructive-changes",
984
+ "manifest",
985
+ "metadata-dir",
986
+ "post-destructive-changes"
987
+ ]
988
+ }
989
+ ],
990
+ "summary": "Specify that deleted components in the destructive changes manifest file are immediately eligible for deletion rather than being stored in the Recycle Bin.",
991
+ "allowNo": false,
992
+ "type": "boolean"
993
+ },
994
+ "pre-destructive-changes": {
995
+ "dependsOn": [
996
+ "manifest"
997
+ ],
998
+ "helpGroup": "Delete",
999
+ "name": "pre-destructive-changes",
1000
+ "summary": "File path for a manifest (destructiveChangesPre.xml) of components to delete before the deploy.",
1001
+ "hasDynamicHelp": false,
1002
+ "multiple": false,
1003
+ "type": "option"
1004
+ },
1005
+ "post-destructive-changes": {
1006
+ "dependsOn": [
1007
+ "manifest"
1008
+ ],
1009
+ "helpGroup": "Delete",
1010
+ "name": "post-destructive-changes",
1011
+ "summary": "File path for a manifest (destructiveChangesPost.xml) of components to delete after the deploy.",
1012
+ "hasDynamicHelp": false,
1013
+ "multiple": false,
1014
+ "type": "option"
1015
+ },
1036
1016
  "coverage-formatters": {
1037
1017
  "description": "For multiple formatters, repeat the flag for each formatter.\n--coverage-formatters lcov --coverage-formatters clover",
1038
1018
  "helpGroup": "Test",
@@ -1082,16 +1062,33 @@
1082
1062
  },
1083
1063
  "hasDynamicHelp": true,
1084
1064
  "hiddenAliases": [],
1085
- "id": "project:deploy:resume",
1065
+ "id": "project:deploy:start",
1086
1066
  "pluginAlias": "@salesforce/plugin-deploy-retrieve",
1087
1067
  "pluginName": "@salesforce/plugin-deploy-retrieve",
1088
1068
  "pluginType": "core",
1089
1069
  "strict": true,
1090
- "summary": "Resume watching a deploy operation and update source tracking when the deploy completes.",
1070
+ "summary": "Deploy metadata to an org from your local project.",
1091
1071
  "enableJsonFlag": true,
1072
+ "configurationVariablesSection": {
1073
+ "header": "CONFIGURATION VARIABLES",
1074
+ "body": [
1075
+ {
1076
+ "name": "target-org",
1077
+ "description": "Username or alias of the org that all commands run against by default. (sf only)"
1078
+ },
1079
+ {
1080
+ "name": "org-api-version",
1081
+ "description": "API version of your project. Default: API version of your Dev Hub org."
1082
+ }
1083
+ ]
1084
+ },
1092
1085
  "envVariablesSection": {
1093
1086
  "header": "ENVIRONMENT VARIABLES",
1094
1087
  "body": [
1088
+ {
1089
+ "name": "SF_TARGET_ORG",
1090
+ "description": "Username or alias of your default org. Overrides the target-org configuration variable."
1091
+ },
1095
1092
  {
1096
1093
  "name": "SF_USE_PROGRESS_BAR",
1097
1094
  "description": "Set to false to disable the progress bar when running the metadata deploy command."
@@ -1137,47 +1134,34 @@
1137
1134
  "commands",
1138
1135
  "project",
1139
1136
  "deploy",
1140
- "resume.js"
1137
+ "start.js"
1141
1138
  ],
1142
1139
  "aliasPermutations": [
1143
- "deploy:metadata:resume",
1144
- "metadata:deploy:resume",
1145
- "metadata:resume:deploy",
1146
- "deploy:resume:metadata",
1147
- "resume:deploy:metadata",
1148
- "resume:metadata:deploy"
1140
+ "deploy:metadata",
1141
+ "metadata:deploy"
1149
1142
  ],
1150
1143
  "permutations": [
1151
- "project:deploy:resume",
1152
- "deploy:project:resume",
1153
- "deploy:resume:project",
1154
- "project:resume:deploy",
1155
- "resume:project:deploy",
1156
- "resume:deploy:project"
1144
+ "project:deploy:start",
1145
+ "deploy:project:start",
1146
+ "deploy:start:project",
1147
+ "project:start:deploy",
1148
+ "start:project:deploy",
1149
+ "start:deploy:project"
1157
1150
  ]
1158
1151
  },
1159
- "project:deploy:start": {
1152
+ "project:deploy:validate": {
1160
1153
  "aliases": [
1161
- "deploy:metadata"
1154
+ "deploy:metadata:validate"
1162
1155
  ],
1163
1156
  "args": {},
1164
1157
  "deprecateAliases": true,
1165
- "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.",
1158
+ "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.",
1166
1159
  "examples": [
1167
- "Deploy local changes not in the org; uses your default org:\n<%= config.bin %> <%= command.id %>",
1168
- "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",
1169
- "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",
1170
- "Deploy all Apex classes that are in all package directories defined in the \"sfdx-project.json\" file:\n<%= config.bin %> <%= command.id %> --metadata ApexClass",
1171
- "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",
1172
- "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",
1173
- "Deploy a custom object called ExcitingObject that's in the SBQQ namespace:\nsf <%= command.id %> --metadata CustomObject:SBQQ__ExcitingObject",
1174
- "Deploy all custom objects in the SBQQ namespace by using a wildcard and quotes:\nsf <%= command.id %> --metadata 'CustomObject:SBQQ__*'",
1175
- "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",
1176
- "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\"",
1177
- "Deploy all components listed in a manifest:\n<%= config.bin %> <%= command.id %> --manifest path/to/package.xml",
1178
- "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",
1179
- "Deploy all metadata formatted files in the \"MDAPI\" directory:\n<%= config.bin %> <%= command.id %> --metadata-dir MDAPI",
1180
- "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"
1160
+ "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.",
1161
+ "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",
1162
+ "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",
1163
+ "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",
1164
+ "Validate the deployment of all components listed in a manifest:\n<%= config.bin %> <%= command.id %> --manifest path/to/package.xml"
1181
1165
  ],
1182
1166
  "flags": {
1183
1167
  "json": {
@@ -1199,16 +1183,13 @@
1199
1183
  "char": "a",
1200
1184
  "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.",
1201
1185
  "name": "api-version",
1202
- "summary": "Target API version for the deploy.",
1186
+ "summary": "Target API version for the validation.",
1203
1187
  "hasDynamicHelp": false,
1204
1188
  "multiple": false,
1205
1189
  "type": "option"
1206
1190
  },
1207
1191
  "async": {
1208
- "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\".",
1209
- "exclusive": [
1210
- "wait"
1211
- ],
1192
+ "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\".",
1212
1193
  "name": "async",
1213
1194
  "summary": "Run the command asynchronously.",
1214
1195
  "allowNo": false,
@@ -1219,75 +1200,40 @@
1219
1200
  "verbose"
1220
1201
  ],
1221
1202
  "name": "concise",
1222
- "summary": "Show concise output of the deploy result.",
1203
+ "summary": "Show concise output of the validation result.",
1223
1204
  "allowNo": false,
1224
1205
  "type": "boolean"
1225
1206
  },
1226
- "dry-run": {
1227
- "name": "dry-run",
1228
- "summary": "Validate deploy and run Apex tests but don’t save to the org.",
1229
- "allowNo": false,
1230
- "type": "boolean"
1207
+ "manifest": {
1208
+ "char": "x",
1209
+ "description": "All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.",
1210
+ "helpGroup": "Source Format",
1211
+ "name": "manifest",
1212
+ "summary": "Full file path for manifest (package.xml) of components to validate for deployment.",
1213
+ "hasDynamicHelp": false,
1214
+ "multiple": false,
1215
+ "type": "option"
1231
1216
  },
1232
- "ignore-conflicts": {
1233
- "char": "c",
1234
- "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.",
1235
- "name": "ignore-conflicts",
1236
- "summary": "Ignore conflicts and deploy local files, even if they overwrite changes in the org.",
1237
- "allowNo": false,
1238
- "type": "boolean"
1239
- },
1240
- "ignore-errors": {
1241
- "char": "r",
1242
- "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.",
1243
- "name": "ignore-errors",
1244
- "summary": "Ignore any errors and don’t roll back deployment.",
1245
- "allowNo": false,
1246
- "type": "boolean"
1247
- },
1248
- "ignore-warnings": {
1249
- "char": "g",
1250
- "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.",
1251
- "name": "ignore-warnings",
1252
- "summary": "Ignore warnings and allow a deployment to complete successfully.",
1253
- "allowNo": false,
1254
- "type": "boolean"
1255
- },
1256
- "manifest": {
1257
- "char": "x",
1258
- "description": "All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.",
1259
- "exclusive": [
1260
- "source-dir",
1261
- "metadata",
1262
- "metadata-dir"
1263
- ],
1217
+ "metadata": {
1218
+ "char": "m",
1264
1219
  "helpGroup": "Source Format",
1265
- "name": "manifest",
1266
- "summary": "Full file path for manifest (package.xml) of components to deploy.",
1220
+ "name": "metadata",
1221
+ "summary": "Metadata component names to validate for deployment.",
1267
1222
  "hasDynamicHelp": false,
1268
- "multiple": false,
1223
+ "multiple": true,
1269
1224
  "type": "option"
1270
1225
  },
1271
- "metadata": {
1272
- "char": "m",
1273
- "exclusive": [
1274
- "manifest",
1275
- "source-dir",
1276
- "metadata-dir"
1277
- ],
1226
+ "source-dir": {
1227
+ "char": "d",
1228
+ "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.",
1278
1229
  "helpGroup": "Source Format",
1279
- "name": "metadata",
1280
- "summary": "Metadata component names to deploy. Wildcards (`*` ) supported as long as you use quotes, such as `ApexClass:MyClass*`.",
1230
+ "name": "source-dir",
1231
+ "summary": "Path to the local source files to validate for deployment.",
1281
1232
  "hasDynamicHelp": false,
1282
1233
  "multiple": true,
1283
1234
  "type": "option"
1284
1235
  },
1285
1236
  "metadata-dir": {
1286
- "exclusive": [
1287
- "manifest",
1288
- "source-dir",
1289
- "metadata"
1290
- ],
1291
1237
  "helpGroup": "Metadata API Format",
1292
1238
  "name": "metadata-dir",
1293
1239
  "summary": "Root of directory or zip file of metadata formatted files to deploy.",
@@ -1305,21 +1251,6 @@
1305
1251
  "allowNo": false,
1306
1252
  "type": "boolean"
1307
1253
  },
1308
- "source-dir": {
1309
- "char": "d",
1310
- "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.",
1311
- "exclusive": [
1312
- "manifest",
1313
- "metadata",
1314
- "metadata-dir"
1315
- ],
1316
- "helpGroup": "Source Format",
1317
- "name": "source-dir",
1318
- "summary": "Path to the local source files to deploy.",
1319
- "hasDynamicHelp": false,
1320
- "multiple": true,
1321
- "type": "option"
1322
- },
1323
1254
  "target-org": {
1324
1255
  "char": "o",
1325
1256
  "name": "target-org",
@@ -1342,17 +1273,17 @@
1342
1273
  },
1343
1274
  "test-level": {
1344
1275
  "char": "l",
1345
- "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\".",
1276
+ "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.",
1346
1277
  "helpGroup": "Test",
1347
1278
  "name": "test-level",
1348
1279
  "summary": "Deployment Apex testing level.",
1280
+ "default": "RunLocalTests",
1349
1281
  "hasDynamicHelp": false,
1350
1282
  "multiple": false,
1351
1283
  "options": [
1352
- "NoTestRun",
1353
- "RunSpecifiedTests",
1284
+ "RunAllTestsInOrg",
1354
1285
  "RunLocalTests",
1355
- "RunAllTestsInOrg"
1286
+ "RunSpecifiedTests"
1356
1287
  ],
1357
1288
  "type": "option"
1358
1289
  },
@@ -1361,63 +1292,28 @@
1361
1292
  "concise"
1362
1293
  ],
1363
1294
  "name": "verbose",
1364
- "summary": "Show verbose output of the deploy result.",
1295
+ "summary": "Show verbose output of the validation result.",
1365
1296
  "allowNo": false,
1366
1297
  "type": "boolean"
1367
1298
  },
1368
1299
  "wait": {
1369
1300
  "char": "w",
1370
- "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\".",
1371
- "exclusive": [
1372
- "async"
1373
- ],
1301
+ "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\".",
1374
1302
  "name": "wait",
1375
- "summary": "Number of minutes to wait for command to complete and display results.",
1303
+ "summary": "Number of minutes to wait for the command to complete and display results.",
1376
1304
  "hasDynamicHelp": true,
1377
1305
  "helpValue": "<minutes>",
1378
1306
  "multiple": false,
1379
1307
  "type": "option"
1380
1308
  },
1381
- "purge-on-delete": {
1382
- "helpGroup": "Delete",
1383
- "name": "purge-on-delete",
1384
- "relationships": [
1385
- {
1386
- "type": "some",
1387
- "flags": [
1388
- "pre-destructive-changes",
1389
- "manifest",
1390
- "metadata-dir",
1391
- "post-destructive-changes"
1392
- ]
1393
- }
1394
- ],
1395
- "summary": "Specify that deleted components in the destructive changes manifest file are immediately eligible for deletion rather than being stored in the Recycle Bin.",
1309
+ "ignore-warnings": {
1310
+ "char": "g",
1311
+ "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.",
1312
+ "name": "ignore-warnings",
1313
+ "summary": "Ignore warnings and allow a deployment to complete successfully.",
1396
1314
  "allowNo": false,
1397
1315
  "type": "boolean"
1398
1316
  },
1399
- "pre-destructive-changes": {
1400
- "dependsOn": [
1401
- "manifest"
1402
- ],
1403
- "helpGroup": "Delete",
1404
- "name": "pre-destructive-changes",
1405
- "summary": "File path for a manifest (destructiveChangesPre.xml) of components to delete before the deploy.",
1406
- "hasDynamicHelp": false,
1407
- "multiple": false,
1408
- "type": "option"
1409
- },
1410
- "post-destructive-changes": {
1411
- "dependsOn": [
1412
- "manifest"
1413
- ],
1414
- "helpGroup": "Delete",
1415
- "name": "post-destructive-changes",
1416
- "summary": "File path for a manifest (destructiveChangesPost.xml) of components to delete after the deploy.",
1417
- "hasDynamicHelp": false,
1418
- "multiple": false,
1419
- "type": "option"
1420
- },
1421
1317
  "coverage-formatters": {
1422
1318
  "description": "For multiple formatters, repeat the flag for each formatter.\n--coverage-formatters lcov --coverage-formatters clover",
1423
1319
  "helpGroup": "Test",
@@ -1463,16 +1359,57 @@
1463
1359
  "hasDynamicHelp": false,
1464
1360
  "multiple": false,
1465
1361
  "type": "option"
1362
+ },
1363
+ "purge-on-delete": {
1364
+ "dependsOn": [
1365
+ "manifest"
1366
+ ],
1367
+ "helpGroup": "Delete",
1368
+ "name": "purge-on-delete",
1369
+ "relationships": [
1370
+ {
1371
+ "type": "some",
1372
+ "flags": [
1373
+ "pre-destructive-changes",
1374
+ "post-destructive-changes"
1375
+ ]
1376
+ }
1377
+ ],
1378
+ "summary": "Specify that deleted components in the destructive changes manifest file are immediately eligible for deletion rather than being stored in the Recycle Bin.",
1379
+ "allowNo": false,
1380
+ "type": "boolean"
1381
+ },
1382
+ "pre-destructive-changes": {
1383
+ "dependsOn": [
1384
+ "manifest"
1385
+ ],
1386
+ "helpGroup": "Delete",
1387
+ "name": "pre-destructive-changes",
1388
+ "summary": "File path for a manifest (destructiveChangesPre.xml) of components to delete before the deploy",
1389
+ "hasDynamicHelp": false,
1390
+ "multiple": false,
1391
+ "type": "option"
1392
+ },
1393
+ "post-destructive-changes": {
1394
+ "dependsOn": [
1395
+ "manifest"
1396
+ ],
1397
+ "helpGroup": "Delete",
1398
+ "name": "post-destructive-changes",
1399
+ "summary": "File path for a manifest (destructiveChangesPost.xml) of components to delete after the deploy.",
1400
+ "hasDynamicHelp": false,
1401
+ "multiple": false,
1402
+ "type": "option"
1466
1403
  }
1467
1404
  },
1468
1405
  "hasDynamicHelp": true,
1469
1406
  "hiddenAliases": [],
1470
- "id": "project:deploy:start",
1407
+ "id": "project:deploy:validate",
1471
1408
  "pluginAlias": "@salesforce/plugin-deploy-retrieve",
1472
1409
  "pluginName": "@salesforce/plugin-deploy-retrieve",
1473
1410
  "pluginType": "core",
1474
1411
  "strict": true,
1475
- "summary": "Deploy metadata to an org from your local project.",
1412
+ "summary": "Validate a metadata deployment without actually executing it.",
1476
1413
  "enableJsonFlag": true,
1477
1414
  "configurationVariablesSection": {
1478
1415
  "header": "CONFIGURATION VARIABLES",
@@ -1539,34 +1476,35 @@
1539
1476
  "commands",
1540
1477
  "project",
1541
1478
  "deploy",
1542
- "start.js"
1479
+ "validate.js"
1543
1480
  ],
1544
1481
  "aliasPermutations": [
1545
- "deploy:metadata",
1546
- "metadata:deploy"
1482
+ "deploy:metadata:validate",
1483
+ "metadata:deploy:validate",
1484
+ "metadata:validate:deploy",
1485
+ "deploy:validate:metadata",
1486
+ "validate:deploy:metadata",
1487
+ "validate:metadata:deploy"
1547
1488
  ],
1548
1489
  "permutations": [
1549
- "project:deploy:start",
1550
- "deploy:project:start",
1551
- "deploy:start:project",
1552
- "project:start:deploy",
1553
- "start:project:deploy",
1554
- "start:deploy:project"
1490
+ "project:deploy:validate",
1491
+ "deploy:project:validate",
1492
+ "deploy:validate:project",
1493
+ "project:validate:deploy",
1494
+ "validate:project:deploy",
1495
+ "validate:deploy:project"
1555
1496
  ]
1556
1497
  },
1557
- "project:deploy:validate": {
1498
+ "project:convert:mdapi": {
1558
1499
  "aliases": [
1559
- "deploy:metadata:validate"
1500
+ "force:mdapi:convert"
1560
1501
  ],
1561
1502
  "args": {},
1562
1503
  "deprecateAliases": true,
1563
- "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.",
1504
+ "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.",
1564
1505
  "examples": [
1565
- "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.",
1566
- "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",
1567
- "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",
1568
- "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",
1569
- "Validate the deployment of all components listed in a manifest:\n<%= config.bin %> <%= command.id %> --manifest path/to/package.xml"
1506
+ "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",
1507
+ "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"
1570
1508
  ],
1571
1509
  "flags": {
1572
1510
  "json": {
@@ -1585,514 +1523,201 @@
1585
1523
  "type": "option"
1586
1524
  },
1587
1525
  "api-version": {
1588
- "char": "a",
1589
- "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.",
1526
+ "aliases": [
1527
+ "apiversion"
1528
+ ],
1529
+ "deprecateAliases": true,
1530
+ "description": "Override the api version used for api requests made by this command",
1590
1531
  "name": "api-version",
1591
- "summary": "Target API version for the validation.",
1592
1532
  "hasDynamicHelp": false,
1593
1533
  "multiple": false,
1594
1534
  "type": "option"
1595
1535
  },
1596
- "async": {
1597
- "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\".",
1598
- "name": "async",
1599
- "summary": "Run the command asynchronously.",
1600
- "allowNo": false,
1601
- "type": "boolean"
1602
- },
1603
- "concise": {
1604
- "exclusive": [
1605
- "verbose"
1606
- ],
1607
- "name": "concise",
1608
- "summary": "Show concise output of the validation result.",
1609
- "allowNo": false,
1610
- "type": "boolean"
1611
- },
1612
- "manifest": {
1613
- "char": "x",
1614
- "description": "All child components are included. If you specify this flag, don’t specify --metadata or --source-dir.",
1615
- "helpGroup": "Source Format",
1616
- "name": "manifest",
1617
- "summary": "Full file path for manifest (package.xml) of components to validate for deployment.",
1536
+ "loglevel": {
1537
+ "deprecated": {
1538
+ "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."
1539
+ },
1540
+ "hidden": true,
1541
+ "name": "loglevel",
1618
1542
  "hasDynamicHelp": false,
1619
1543
  "multiple": false,
1620
1544
  "type": "option"
1621
1545
  },
1622
- "metadata": {
1623
- "char": "m",
1624
- "helpGroup": "Source Format",
1625
- "name": "metadata",
1626
- "summary": "Metadata component names to validate for deployment.",
1627
- "hasDynamicHelp": false,
1628
- "multiple": true,
1629
- "type": "option"
1630
- },
1631
- "source-dir": {
1632
- "char": "d",
1633
- "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.",
1634
- "helpGroup": "Source Format",
1635
- "name": "source-dir",
1636
- "summary": "Path to the local source files to validate for deployment.",
1637
- "hasDynamicHelp": false,
1638
- "multiple": true,
1639
- "type": "option"
1640
- },
1641
- "metadata-dir": {
1642
- "helpGroup": "Metadata API Format",
1643
- "name": "metadata-dir",
1644
- "summary": "Root of directory or zip file of metadata formatted files to deploy.",
1645
- "hasDynamicHelp": false,
1646
- "multiple": false,
1647
- "type": "option"
1648
- },
1649
- "single-package": {
1650
- "dependsOn": [
1651
- "metadata-dir"
1546
+ "root-dir": {
1547
+ "aliases": [
1548
+ "rootdir"
1652
1549
  ],
1653
- "helpGroup": "Metadata API Format",
1654
- "name": "single-package",
1655
- "summary": "Indicates that the metadata zip file points to a directory structure for a single package.",
1656
- "allowNo": false,
1657
- "type": "boolean"
1658
- },
1659
- "target-org": {
1660
- "char": "o",
1661
- "name": "target-org",
1662
- "noCacheDefault": true,
1550
+ "char": "r",
1551
+ "deprecateAliases": true,
1552
+ "name": "root-dir",
1663
1553
  "required": true,
1664
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
1665
- "hasDynamicHelp": true,
1666
- "multiple": false,
1667
- "type": "option"
1668
- },
1669
- "tests": {
1670
- "char": "t",
1671
- "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\"",
1672
- "helpGroup": "Test",
1673
- "name": "tests",
1674
- "summary": "Apex tests to run when --test-level is RunSpecifiedTests.",
1675
- "hasDynamicHelp": false,
1676
- "multiple": true,
1677
- "type": "option"
1678
- },
1679
- "test-level": {
1680
- "char": "l",
1681
- "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.",
1682
- "helpGroup": "Test",
1683
- "name": "test-level",
1684
- "summary": "Deployment Apex testing level.",
1685
- "default": "RunLocalTests",
1554
+ "summary": "Root directory that contains the Metadata API–formatted metadata.",
1686
1555
  "hasDynamicHelp": false,
1687
1556
  "multiple": false,
1688
- "options": [
1689
- "RunAllTestsInOrg",
1690
- "RunLocalTests",
1691
- "RunSpecifiedTests"
1692
- ],
1693
1557
  "type": "option"
1694
1558
  },
1695
- "verbose": {
1696
- "exclusive": [
1697
- "concise"
1559
+ "output-dir": {
1560
+ "aliases": [
1561
+ "outputdir"
1698
1562
  ],
1699
- "name": "verbose",
1700
- "summary": "Show verbose output of the validation result.",
1701
- "allowNo": false,
1702
- "type": "boolean"
1703
- },
1704
- "wait": {
1705
- "char": "w",
1706
- "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\".",
1707
- "name": "wait",
1708
- "summary": "Number of minutes to wait for the command to complete and display results.",
1709
- "hasDynamicHelp": true,
1710
- "helpValue": "<minutes>",
1711
- "multiple": false,
1712
- "type": "option"
1713
- },
1714
- "ignore-warnings": {
1715
- "char": "g",
1716
- "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.",
1717
- "name": "ignore-warnings",
1718
- "summary": "Ignore warnings and allow a deployment to complete successfully.",
1719
- "allowNo": false,
1720
- "type": "boolean"
1721
- },
1722
- "coverage-formatters": {
1723
- "description": "For multiple formatters, repeat the flag for each formatter.\n--coverage-formatters lcov --coverage-formatters clover",
1724
- "helpGroup": "Test",
1725
- "name": "coverage-formatters",
1726
- "summary": "Format of the code coverage results.",
1563
+ "char": "d",
1564
+ "deprecateAliases": true,
1565
+ "name": "output-dir",
1566
+ "summary": "Directory to store your files in after they’re converted to source format; can be an absolute or relative path.",
1727
1567
  "hasDynamicHelp": false,
1728
- "multiple": true,
1729
- "options": [
1730
- "clover",
1731
- "cobertura",
1732
- "html-spa",
1733
- "html",
1734
- "json",
1735
- "json-summary",
1736
- "lcovonly",
1737
- "none",
1738
- "teamcity",
1739
- "text",
1740
- "text-summary"
1741
- ],
1568
+ "multiple": false,
1742
1569
  "type": "option"
1743
1570
  },
1744
- "junit": {
1745
- "helpGroup": "Test",
1746
- "name": "junit",
1747
- "summary": "Output JUnit test results.",
1748
- "allowNo": false,
1749
- "type": "boolean"
1750
- },
1751
- "results-dir": {
1752
- "helpGroup": "Test",
1753
- "name": "results-dir",
1754
- "relationships": [
1755
- {
1756
- "type": "some",
1757
- "flags": [
1758
- "coverage-formatters",
1759
- "junit"
1760
- ]
1761
- }
1762
- ],
1763
- "summary": "Output directory for code coverage and JUnit results; defaults to the deploy ID.",
1571
+ "manifest": {
1572
+ "char": "x",
1573
+ "description": "If you specify this flag, don’t specify --metadata or --source-dir.",
1574
+ "name": "manifest",
1575
+ "summary": "File path to manifest (package.xml) of metadata types to convert.",
1764
1576
  "hasDynamicHelp": false,
1765
1577
  "multiple": false,
1766
1578
  "type": "option"
1767
1579
  },
1768
- "purge-on-delete": {
1769
- "dependsOn": [
1770
- "manifest"
1771
- ],
1772
- "helpGroup": "Delete",
1773
- "name": "purge-on-delete",
1774
- "relationships": [
1775
- {
1776
- "type": "some",
1777
- "flags": [
1778
- "pre-destructive-changes",
1779
- "post-destructive-changes"
1780
- ]
1781
- }
1580
+ "metadata-dir": {
1581
+ "aliases": [
1582
+ "metadatapath"
1782
1583
  ],
1783
- "summary": "Specify that deleted components in the destructive changes manifest file are immediately eligible for deletion rather than being stored in the Recycle Bin.",
1784
- "allowNo": false,
1785
- "type": "boolean"
1786
- },
1787
- "pre-destructive-changes": {
1788
- "dependsOn": [
1789
- "manifest"
1584
+ "char": "p",
1585
+ "deprecateAliases": true,
1586
+ "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.",
1587
+ "exclusive": [
1588
+ "manifest",
1589
+ "metadata"
1790
1590
  ],
1791
- "helpGroup": "Delete",
1792
- "name": "pre-destructive-changes",
1793
- "summary": "File path for a manifest (destructiveChangesPre.xml) of components to delete before the deploy",
1591
+ "name": "metadata-dir",
1592
+ "summary": "Root of directory or zip file of metadata formatted files to convert.",
1593
+ "delimiter": ",",
1794
1594
  "hasDynamicHelp": false,
1795
- "multiple": false,
1595
+ "multiple": true,
1796
1596
  "type": "option"
1797
1597
  },
1798
- "post-destructive-changes": {
1799
- "dependsOn": [
1800
- "manifest"
1598
+ "metadata": {
1599
+ "char": "m",
1600
+ "exclusive": [
1601
+ "manifest",
1602
+ "metadatapath"
1801
1603
  ],
1802
- "helpGroup": "Delete",
1803
- "name": "post-destructive-changes",
1804
- "summary": "File path for a manifest (destructiveChangesPost.xml) of components to delete after the deploy.",
1604
+ "name": "metadata",
1605
+ "summary": "Metadata component names to convert.",
1606
+ "delimiter": ",",
1805
1607
  "hasDynamicHelp": false,
1806
- "multiple": false,
1608
+ "multiple": true,
1807
1609
  "type": "option"
1808
1610
  }
1809
1611
  },
1810
- "hasDynamicHelp": true,
1612
+ "hasDynamicHelp": false,
1811
1613
  "hiddenAliases": [],
1812
- "id": "project:deploy:validate",
1614
+ "id": "project:convert:mdapi",
1813
1615
  "pluginAlias": "@salesforce/plugin-deploy-retrieve",
1814
1616
  "pluginName": "@salesforce/plugin-deploy-retrieve",
1815
1617
  "pluginType": "core",
1816
1618
  "strict": true,
1817
- "summary": "Validate a metadata deployment without actually executing it.",
1619
+ "summary": "Convert metadata retrieved via Metadata API into the source format used in Salesforce DX projects.",
1818
1620
  "enableJsonFlag": true,
1819
- "configurationVariablesSection": {
1820
- "header": "CONFIGURATION VARIABLES",
1821
- "body": [
1822
- {
1823
- "name": "target-org",
1824
- "description": "Username or alias of the org that all commands run against by default. (sf only)"
1825
- },
1826
- {
1827
- "name": "org-api-version",
1828
- "description": "API version of your project. Default: API version of your Dev Hub org."
1829
- }
1830
- ]
1831
- },
1832
- "envVariablesSection": {
1833
- "header": "ENVIRONMENT VARIABLES",
1834
- "body": [
1835
- {
1836
- "name": "SF_TARGET_ORG",
1837
- "description": "Username or alias of your default org. Overrides the target-org configuration variable."
1838
- },
1839
- {
1840
- "name": "SF_USE_PROGRESS_BAR",
1841
- "description": "Set to false to disable the progress bar when running the metadata deploy command."
1842
- }
1843
- ]
1844
- },
1845
- "errorCodes": {
1846
- "header": "ERROR CODES",
1847
- "body": [
1848
- {
1849
- "name": "Succeeded (0)",
1850
- "description": "The deploy succeeded."
1851
- },
1852
- {
1853
- "name": "Canceled (1)",
1854
- "description": "The deploy was canceled."
1855
- },
1856
- {
1857
- "name": "Failed (1)",
1858
- "description": "The deploy failed."
1859
- },
1860
- {
1861
- "name": "SucceededPartial (68)",
1862
- "description": "The deploy partially succeeded."
1863
- },
1864
- {
1865
- "name": "InProgress (69)",
1866
- "description": "The deploy is in progress."
1867
- },
1868
- {
1869
- "name": "Pending (69)",
1870
- "description": "The deploy is pending."
1871
- },
1872
- {
1873
- "name": "Canceling (69)",
1874
- "description": "The deploy is being canceled."
1875
- }
1876
- ]
1877
- },
1621
+ "requiresProject": true,
1878
1622
  "isESM": true,
1879
1623
  "relativePath": [
1880
1624
  "lib",
1881
1625
  "commands",
1882
1626
  "project",
1883
- "deploy",
1884
- "validate.js"
1627
+ "convert",
1628
+ "mdapi.js"
1885
1629
  ],
1886
1630
  "aliasPermutations": [
1887
- "deploy:metadata:validate",
1888
- "metadata:deploy:validate",
1889
- "metadata:validate:deploy",
1890
- "deploy:validate:metadata",
1891
- "validate:deploy:metadata",
1892
- "validate:metadata:deploy"
1631
+ "force:mdapi:convert",
1632
+ "mdapi:force:convert",
1633
+ "mdapi:convert:force",
1634
+ "force:convert:mdapi",
1635
+ "convert:force:mdapi",
1636
+ "convert:mdapi:force"
1893
1637
  ],
1894
1638
  "permutations": [
1895
- "project:deploy:validate",
1896
- "deploy:project:validate",
1897
- "deploy:validate:project",
1898
- "project:validate:deploy",
1899
- "validate:project:deploy",
1900
- "validate:deploy:project"
1639
+ "project:convert:mdapi",
1640
+ "convert:project:mdapi",
1641
+ "convert:mdapi:project",
1642
+ "project:mdapi:convert",
1643
+ "mdapi:project:convert",
1644
+ "mdapi:convert:project"
1901
1645
  ]
1902
- },
1903
- "project:delete:source": {
1904
- "aliases": [
1905
- "force:source:delete"
1906
- ],
1907
- "args": {},
1908
- "deprecateAliases": true,
1909
- "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.",
1910
- "examples": [
1911
- "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",
1912
- "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",
1913
- "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",
1914
- "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"
1915
- ],
1916
- "flags": {
1917
- "json": {
1918
- "description": "Format output as json.",
1919
- "helpGroup": "GLOBAL",
1920
- "name": "json",
1921
- "allowNo": false,
1922
- "type": "boolean"
1923
- },
1924
- "flags-dir": {
1925
- "helpGroup": "GLOBAL",
1926
- "name": "flags-dir",
1927
- "summary": "Import flag values from a directory.",
1928
- "hasDynamicHelp": false,
1929
- "multiple": false,
1930
- "type": "option"
1931
- },
1932
- "api-version": {
1933
- "aliases": [
1934
- "apiversion"
1935
- ],
1936
- "deprecateAliases": true,
1937
- "description": "Override the api version used for api requests made by this command",
1938
- "name": "api-version",
1939
- "hasDynamicHelp": false,
1940
- "multiple": false,
1941
- "type": "option"
1942
- },
1943
- "loglevel": {
1944
- "deprecated": {
1945
- "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."
1946
- },
1947
- "hidden": true,
1948
- "name": "loglevel",
1949
- "hasDynamicHelp": false,
1950
- "multiple": false,
1951
- "type": "option"
1952
- },
1953
- "target-org": {
1954
- "aliases": [
1955
- "targetusername",
1956
- "u"
1957
- ],
1958
- "char": "o",
1959
- "deprecateAliases": true,
1960
- "name": "target-org",
1961
- "noCacheDefault": true,
1962
- "required": true,
1963
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
1964
- "hasDynamicHelp": true,
1965
- "multiple": false,
1966
- "type": "option"
1967
- },
1968
- "check-only": {
1969
- "aliases": [
1970
- "checkonly"
1971
- ],
1972
- "char": "c",
1973
- "deprecateAliases": true,
1974
- "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.",
1975
- "name": "check-only",
1976
- "summary": "Validate delete command but don't delete anything from the org or the local project.",
1977
- "allowNo": false,
1978
- "type": "boolean"
1979
- },
1980
- "wait": {
1981
- "char": "w",
1982
- "description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you.",
1983
- "name": "wait",
1984
- "summary": "Number of minutes to wait for the command to finish.",
1985
- "hasDynamicHelp": true,
1986
- "multiple": false,
1987
- "type": "option"
1988
- },
1989
- "tests": {
1990
- "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\"",
1991
- "helpGroup": "Test",
1992
- "name": "tests",
1993
- "summary": "Apex tests to run when --test-level is RunSpecifiedTests.",
1994
- "hasDynamicHelp": false,
1995
- "multiple": true,
1996
- "type": "option"
1997
- },
1998
- "test-level": {
1999
- "aliases": [
2000
- "testlevel"
2001
- ],
2002
- "char": "l",
2003
- "deprecateAliases": true,
2004
- "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.",
2005
- "helpGroup": "Test",
2006
- "name": "test-level",
2007
- "summary": "Deployment Apex testing level.",
2008
- "hasDynamicHelp": false,
2009
- "multiple": false,
2010
- "options": [
2011
- "NoTestRun",
2012
- "RunSpecifiedTests",
2013
- "RunLocalTests",
2014
- "RunAllTestsInOrg"
2015
- ],
2016
- "type": "option"
2017
- },
2018
- "no-prompt": {
2019
- "aliases": [
2020
- "noprompt"
2021
- ],
2022
- "char": "r",
2023
- "deprecateAliases": true,
2024
- "name": "no-prompt",
2025
- "summary": "Don't prompt for delete confirmation.",
1646
+ },
1647
+ "project:convert:source-behavior": {
1648
+ "aliases": [],
1649
+ "args": {},
1650
+ "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.",
1651
+ "examples": [
1652
+ "Update your Salesforce DX project to decompose custom permission sets:\n<%= config.bin %> <%= command.id %> --behavior decomposePermissionSetBeta",
1653
+ "Display what the command would do, but don't change any existing files:\n<%= config.bin %> <%= command.id %> --behavior decomposePermissionSetBeta --dry-run",
1654
+ "Keep the temporary directory that contains the interim metadata API formatted files:\n<%= config.bin %> <%= command.id %> --behavior decomposePermissionSetBeta --dry-run --preserve-temp-dir"
1655
+ ],
1656
+ "flags": {
1657
+ "json": {
1658
+ "description": "Format output as json.",
1659
+ "helpGroup": "GLOBAL",
1660
+ "name": "json",
2026
1661
  "allowNo": false,
2027
1662
  "type": "boolean"
2028
1663
  },
2029
- "metadata": {
2030
- "char": "m",
2031
- "description": "If you specify this flag, don’t specify --source-dir.",
2032
- "name": "metadata",
2033
- "summary": "Metadata components to delete.",
2034
- "delimiter": ",",
1664
+ "flags-dir": {
1665
+ "helpGroup": "GLOBAL",
1666
+ "name": "flags-dir",
1667
+ "summary": "Import flag values from a directory.",
2035
1668
  "hasDynamicHelp": false,
2036
- "multiple": true,
1669
+ "multiple": false,
2037
1670
  "type": "option"
2038
1671
  },
2039
- "source-dir": {
2040
- "aliases": [
2041
- "sourcepath"
2042
- ],
2043
- "char": "p",
2044
- "deprecateAliases": true,
2045
- "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.",
2046
- "name": "source-dir",
2047
- "summary": "Source file paths to delete.",
2048
- "delimiter": ",",
1672
+ "behavior": {
1673
+ "char": "b",
1674
+ "name": "behavior",
1675
+ "required": true,
1676
+ "summary": "Behavior to enable; the values correspond to the possible values of the \"sourceBehaviorOption\" option in the \"sfdx-project.json\" file.",
2049
1677
  "hasDynamicHelp": false,
2050
- "multiple": true,
1678
+ "multiple": false,
1679
+ "options": [
1680
+ "decomposeCustomLabelsBeta2",
1681
+ "decomposeCustomLabelsBeta",
1682
+ "decomposePermissionSetBeta",
1683
+ "decomposePermissionSetBeta2",
1684
+ "decomposeSharingRulesBeta",
1685
+ "decomposeWorkflowBeta",
1686
+ "decomposeExternalServiceRegistrationBeta"
1687
+ ],
2051
1688
  "type": "option"
2052
1689
  },
2053
- "track-source": {
2054
- "aliases": [
2055
- "tracksource"
2056
- ],
2057
- "char": "t",
2058
- "deprecateAliases": true,
2059
- "exclusive": [
2060
- "check-only"
2061
- ],
2062
- "name": "track-source",
2063
- "summary": "If the delete succeeds, update the source tracking information.",
1690
+ "dry-run": {
1691
+ "name": "dry-run",
1692
+ "summary": "Display what the command would do, but don't make any actual changes.",
2064
1693
  "allowNo": false,
2065
1694
  "type": "boolean"
2066
1695
  },
2067
- "force-overwrite": {
2068
- "aliases": [
2069
- "forceoverwrite"
2070
- ],
2071
- "char": "f",
2072
- "dependsOn": [
2073
- "track-source"
2074
- ],
2075
- "deprecateAliases": true,
2076
- "name": "force-overwrite",
2077
- "summary": "Ignore conflict warnings and overwrite changes to the org.",
1696
+ "preserve-temp-dir": {
1697
+ "name": "preserve-temp-dir",
1698
+ "summary": "Don't delete the metadata API format temporary directory that this command creates. Useful for debugging.",
2078
1699
  "allowNo": false,
2079
1700
  "type": "boolean"
2080
1701
  },
2081
- "verbose": {
2082
- "name": "verbose",
2083
- "summary": "Verbose output of the delete result.",
2084
- "allowNo": false,
2085
- "type": "boolean"
1702
+ "target-org": {
1703
+ "char": "o",
1704
+ "name": "target-org",
1705
+ "noCacheDefault": true,
1706
+ "summary": "Username or alias of the target org.",
1707
+ "hasDynamicHelp": true,
1708
+ "multiple": false,
1709
+ "type": "option"
2086
1710
  }
2087
1711
  },
2088
1712
  "hasDynamicHelp": true,
2089
1713
  "hiddenAliases": [],
2090
- "id": "project:delete:source",
1714
+ "id": "project:convert:source-behavior",
2091
1715
  "pluginAlias": "@salesforce/plugin-deploy-retrieve",
2092
1716
  "pluginName": "@salesforce/plugin-deploy-retrieve",
2093
1717
  "pluginType": "core",
1718
+ "state": "beta",
2094
1719
  "strict": true,
2095
- "summary": "Delete source from your project and from a non-source-tracked org.",
1720
+ "summary": "Enable a behavior of your project source files, and then update your Salesforce DX project to implement the behavior.",
2096
1721
  "enableJsonFlag": true,
2097
1722
  "requiresProject": true,
2098
1723
  "isESM": true,
@@ -2100,35 +1725,29 @@
2100
1725
  "lib",
2101
1726
  "commands",
2102
1727
  "project",
2103
- "delete",
2104
- "source.js"
2105
- ],
2106
- "aliasPermutations": [
2107
- "force:source:delete",
2108
- "source:force:delete",
2109
- "source:delete:force",
2110
- "force:delete:source",
2111
- "delete:force:source",
2112
- "delete:source:force"
1728
+ "convert",
1729
+ "source-behavior.js"
2113
1730
  ],
1731
+ "aliasPermutations": [],
2114
1732
  "permutations": [
2115
- "project:delete:source",
2116
- "delete:project:source",
2117
- "delete:source:project",
2118
- "project:source:delete",
2119
- "source:project:delete",
2120
- "source:delete:project"
1733
+ "project:convert:source-behavior",
1734
+ "convert:project:source-behavior",
1735
+ "convert:source-behavior:project",
1736
+ "project:source-behavior:convert",
1737
+ "source-behavior:project:convert",
1738
+ "source-behavior:convert:project"
2121
1739
  ]
2122
1740
  },
2123
- "project:delete:tracking": {
1741
+ "project:convert:source": {
2124
1742
  "aliases": [
2125
- "force:source:tracking:clear"
1743
+ "force:source:convert"
2126
1744
  ],
2127
1745
  "args": {},
2128
1746
  "deprecateAliases": true,
2129
- "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.",
1747
+ "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.",
2130
1748
  "examples": [
2131
- "Delete local source tracking for the org with alias \"my-scratch\":\n$ <%= config.bin %> <%= command.id %> --target-org my-scratch"
1749
+ "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",
1750
+ "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'"
2132
1751
  ],
2133
1752
  "flags": {
2134
1753
  "json": {
@@ -2153,6 +1772,7 @@
2153
1772
  "deprecateAliases": true,
2154
1773
  "description": "Override the api version used for api requests made by this command",
2155
1774
  "name": "api-version",
1775
+ "summary": "API Version to use in the generated project's manifest. By default, will use the version from sfdx-project.json",
2156
1776
  "hasDynamicHelp": false,
2157
1777
  "multiple": false,
2158
1778
  "type": "option"
@@ -2167,84 +1787,117 @@
2167
1787
  "multiple": false,
2168
1788
  "type": "option"
2169
1789
  },
2170
- "target-org": {
1790
+ "root-dir": {
2171
1791
  "aliases": [
2172
- "targetusername",
2173
- "u"
1792
+ "rootdir"
2174
1793
  ],
2175
- "char": "o",
1794
+ "char": "r",
2176
1795
  "deprecateAliases": true,
2177
- "name": "target-org",
2178
- "noCacheDefault": true,
2179
- "required": true,
2180
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
1796
+ "name": "root-dir",
1797
+ "summary": "Source directory other than the default package to convert.",
1798
+ "hasDynamicHelp": false,
1799
+ "multiple": false,
1800
+ "type": "option"
1801
+ },
1802
+ "output-dir": {
1803
+ "aliases": [
1804
+ "outputdir"
1805
+ ],
1806
+ "char": "d",
1807
+ "deprecateAliases": true,
1808
+ "name": "output-dir",
1809
+ "summary": "Output directory to store the Metadata API–formatted files in.",
1810
+ "default": "metadataPackage_>timestamp<",
2181
1811
  "hasDynamicHelp": true,
2182
1812
  "multiple": false,
2183
1813
  "type": "option"
2184
1814
  },
2185
- "no-prompt": {
1815
+ "package-name": {
2186
1816
  "aliases": [
2187
- "noprompt"
1817
+ "packagename"
1818
+ ],
1819
+ "char": "n",
1820
+ "deprecateAliases": true,
1821
+ "name": "package-name",
1822
+ "summary": "Name of the package to associate with the metadata-formatted files.",
1823
+ "hasDynamicHelp": false,
1824
+ "multiple": false,
1825
+ "type": "option"
1826
+ },
1827
+ "manifest": {
1828
+ "char": "x",
1829
+ "description": "If you specify this flag, don’t specify --metadata or --source-dir.",
1830
+ "name": "manifest",
1831
+ "summary": "Path to the manifest (package.xml) file that specifies the metadata types to convert.",
1832
+ "hasDynamicHelp": false,
1833
+ "multiple": false,
1834
+ "type": "option"
1835
+ },
1836
+ "source-dir": {
1837
+ "aliases": [
1838
+ "sourcepath"
2188
1839
  ],
2189
1840
  "char": "p",
2190
1841
  "deprecateAliases": true,
2191
- "name": "no-prompt",
2192
- "summary": "Don't prompt for source tracking override confirmation.",
2193
- "allowNo": false,
2194
- "type": "boolean"
1842
+ "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.",
1843
+ "exclusive": [
1844
+ "manifest",
1845
+ "metadata"
1846
+ ],
1847
+ "name": "source-dir",
1848
+ "summary": "Paths to the local source files to convert.",
1849
+ "delimiter": ",",
1850
+ "hasDynamicHelp": false,
1851
+ "multiple": true,
1852
+ "type": "option"
1853
+ },
1854
+ "metadata": {
1855
+ "char": "m",
1856
+ "exclusive": [
1857
+ "manifest",
1858
+ "sourcepath"
1859
+ ],
1860
+ "name": "metadata",
1861
+ "summary": "Metadata component names to convert.",
1862
+ "delimiter": ",",
1863
+ "hasDynamicHelp": false,
1864
+ "multiple": true,
1865
+ "type": "option"
2195
1866
  }
2196
1867
  },
2197
- "hasDynamicHelp": true,
2198
- "hiddenAliases": [],
2199
- "id": "project:delete:tracking",
2200
- "pluginAlias": "@salesforce/plugin-deploy-retrieve",
2201
- "pluginName": "@salesforce/plugin-deploy-retrieve",
2202
- "pluginType": "core",
2203
- "strict": true,
2204
- "summary": "Delete all local source tracking information.",
2205
- "enableJsonFlag": true,
2206
- "requiresProject": true,
2207
- "isESM": true,
2208
- "relativePath": [
2209
- "lib",
2210
- "commands",
2211
- "project",
2212
- "delete",
2213
- "tracking.js"
2214
- ],
2215
- "aliasPermutations": [
2216
- "force:source:tracking:clear",
2217
- "source:force:tracking:clear",
2218
- "source:tracking:force:clear",
2219
- "source:tracking:clear:force",
2220
- "force:tracking:source:clear",
2221
- "tracking:force:source:clear",
2222
- "tracking:source:force:clear",
2223
- "tracking:source:clear:force",
2224
- "force:tracking:clear:source",
2225
- "tracking:force:clear:source",
2226
- "tracking:clear:force:source",
2227
- "tracking:clear:source:force",
2228
- "force:source:clear:tracking",
2229
- "source:force:clear:tracking",
2230
- "source:clear:force:tracking",
2231
- "source:clear:tracking:force",
2232
- "force:clear:source:tracking",
2233
- "clear:force:source:tracking",
2234
- "clear:source:force:tracking",
2235
- "clear:source:tracking:force",
2236
- "force:clear:tracking:source",
2237
- "clear:force:tracking:source",
2238
- "clear:tracking:force:source",
2239
- "clear:tracking:source:force"
1868
+ "hasDynamicHelp": true,
1869
+ "hiddenAliases": [],
1870
+ "id": "project:convert:source",
1871
+ "pluginAlias": "@salesforce/plugin-deploy-retrieve",
1872
+ "pluginName": "@salesforce/plugin-deploy-retrieve",
1873
+ "pluginType": "core",
1874
+ "strict": true,
1875
+ "summary": "Convert source-formatted files into metadata that you can deploy using Metadata API.",
1876
+ "enableJsonFlag": true,
1877
+ "requiresProject": true,
1878
+ "isESM": true,
1879
+ "relativePath": [
1880
+ "lib",
1881
+ "commands",
1882
+ "project",
1883
+ "convert",
1884
+ "source.js"
1885
+ ],
1886
+ "aliasPermutations": [
1887
+ "force:source:convert",
1888
+ "source:force:convert",
1889
+ "source:convert:force",
1890
+ "force:convert:source",
1891
+ "convert:force:source",
1892
+ "convert:source:force"
2240
1893
  ],
2241
1894
  "permutations": [
2242
- "project:delete:tracking",
2243
- "delete:project:tracking",
2244
- "delete:tracking:project",
2245
- "project:tracking:delete",
2246
- "tracking:project:delete",
2247
- "tracking:delete:project"
1895
+ "project:convert:source",
1896
+ "convert:project:source",
1897
+ "convert:source:project",
1898
+ "project:source:convert",
1899
+ "source:project:convert",
1900
+ "source:convert:project"
2248
1901
  ]
2249
1902
  },
2250
1903
  "project:generate:manifest": {
@@ -2467,24 +2120,243 @@
2467
2120
  "create:manifest:source:force"
2468
2121
  ],
2469
2122
  "permutations": [
2470
- "project:generate:manifest",
2471
- "generate:project:manifest",
2472
- "generate:manifest:project",
2473
- "project:manifest:generate",
2474
- "manifest:project:generate",
2475
- "manifest:generate:project"
2123
+ "project:generate:manifest",
2124
+ "generate:project:manifest",
2125
+ "generate:manifest:project",
2126
+ "project:manifest:generate",
2127
+ "manifest:project:generate",
2128
+ "manifest:generate:project"
2129
+ ]
2130
+ },
2131
+ "project:delete:source": {
2132
+ "aliases": [
2133
+ "force:source:delete"
2134
+ ],
2135
+ "args": {},
2136
+ "deprecateAliases": true,
2137
+ "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.",
2138
+ "examples": [
2139
+ "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",
2140
+ "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",
2141
+ "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",
2142
+ "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"
2143
+ ],
2144
+ "flags": {
2145
+ "json": {
2146
+ "description": "Format output as json.",
2147
+ "helpGroup": "GLOBAL",
2148
+ "name": "json",
2149
+ "allowNo": false,
2150
+ "type": "boolean"
2151
+ },
2152
+ "flags-dir": {
2153
+ "helpGroup": "GLOBAL",
2154
+ "name": "flags-dir",
2155
+ "summary": "Import flag values from a directory.",
2156
+ "hasDynamicHelp": false,
2157
+ "multiple": false,
2158
+ "type": "option"
2159
+ },
2160
+ "api-version": {
2161
+ "aliases": [
2162
+ "apiversion"
2163
+ ],
2164
+ "deprecateAliases": true,
2165
+ "description": "Override the api version used for api requests made by this command",
2166
+ "name": "api-version",
2167
+ "hasDynamicHelp": false,
2168
+ "multiple": false,
2169
+ "type": "option"
2170
+ },
2171
+ "loglevel": {
2172
+ "deprecated": {
2173
+ "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."
2174
+ },
2175
+ "hidden": true,
2176
+ "name": "loglevel",
2177
+ "hasDynamicHelp": false,
2178
+ "multiple": false,
2179
+ "type": "option"
2180
+ },
2181
+ "target-org": {
2182
+ "aliases": [
2183
+ "targetusername",
2184
+ "u"
2185
+ ],
2186
+ "char": "o",
2187
+ "deprecateAliases": true,
2188
+ "name": "target-org",
2189
+ "noCacheDefault": true,
2190
+ "required": true,
2191
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
2192
+ "hasDynamicHelp": true,
2193
+ "multiple": false,
2194
+ "type": "option"
2195
+ },
2196
+ "check-only": {
2197
+ "aliases": [
2198
+ "checkonly"
2199
+ ],
2200
+ "char": "c",
2201
+ "deprecateAliases": true,
2202
+ "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.",
2203
+ "name": "check-only",
2204
+ "summary": "Validate delete command but don't delete anything from the org or the local project.",
2205
+ "allowNo": false,
2206
+ "type": "boolean"
2207
+ },
2208
+ "wait": {
2209
+ "char": "w",
2210
+ "description": "If the command continues to run after the wait period, the CLI returns control of the terminal window to you.",
2211
+ "name": "wait",
2212
+ "summary": "Number of minutes to wait for the command to finish.",
2213
+ "hasDynamicHelp": true,
2214
+ "multiple": false,
2215
+ "type": "option"
2216
+ },
2217
+ "tests": {
2218
+ "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\"",
2219
+ "helpGroup": "Test",
2220
+ "name": "tests",
2221
+ "summary": "Apex tests to run when --test-level is RunSpecifiedTests.",
2222
+ "hasDynamicHelp": false,
2223
+ "multiple": true,
2224
+ "type": "option"
2225
+ },
2226
+ "test-level": {
2227
+ "aliases": [
2228
+ "testlevel"
2229
+ ],
2230
+ "char": "l",
2231
+ "deprecateAliases": true,
2232
+ "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.",
2233
+ "helpGroup": "Test",
2234
+ "name": "test-level",
2235
+ "summary": "Deployment Apex testing level.",
2236
+ "hasDynamicHelp": false,
2237
+ "multiple": false,
2238
+ "options": [
2239
+ "NoTestRun",
2240
+ "RunSpecifiedTests",
2241
+ "RunLocalTests",
2242
+ "RunAllTestsInOrg"
2243
+ ],
2244
+ "type": "option"
2245
+ },
2246
+ "no-prompt": {
2247
+ "aliases": [
2248
+ "noprompt"
2249
+ ],
2250
+ "char": "r",
2251
+ "deprecateAliases": true,
2252
+ "name": "no-prompt",
2253
+ "summary": "Don't prompt for delete confirmation.",
2254
+ "allowNo": false,
2255
+ "type": "boolean"
2256
+ },
2257
+ "metadata": {
2258
+ "char": "m",
2259
+ "description": "If you specify this flag, don’t specify --source-dir.",
2260
+ "name": "metadata",
2261
+ "summary": "Metadata components to delete.",
2262
+ "delimiter": ",",
2263
+ "hasDynamicHelp": false,
2264
+ "multiple": true,
2265
+ "type": "option"
2266
+ },
2267
+ "source-dir": {
2268
+ "aliases": [
2269
+ "sourcepath"
2270
+ ],
2271
+ "char": "p",
2272
+ "deprecateAliases": true,
2273
+ "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.",
2274
+ "name": "source-dir",
2275
+ "summary": "Source file paths to delete.",
2276
+ "delimiter": ",",
2277
+ "hasDynamicHelp": false,
2278
+ "multiple": true,
2279
+ "type": "option"
2280
+ },
2281
+ "track-source": {
2282
+ "aliases": [
2283
+ "tracksource"
2284
+ ],
2285
+ "char": "t",
2286
+ "deprecateAliases": true,
2287
+ "exclusive": [
2288
+ "check-only"
2289
+ ],
2290
+ "name": "track-source",
2291
+ "summary": "If the delete succeeds, update the source tracking information.",
2292
+ "allowNo": false,
2293
+ "type": "boolean"
2294
+ },
2295
+ "force-overwrite": {
2296
+ "aliases": [
2297
+ "forceoverwrite"
2298
+ ],
2299
+ "char": "f",
2300
+ "dependsOn": [
2301
+ "track-source"
2302
+ ],
2303
+ "deprecateAliases": true,
2304
+ "name": "force-overwrite",
2305
+ "summary": "Ignore conflict warnings and overwrite changes to the org.",
2306
+ "allowNo": false,
2307
+ "type": "boolean"
2308
+ },
2309
+ "verbose": {
2310
+ "name": "verbose",
2311
+ "summary": "Verbose output of the delete result.",
2312
+ "allowNo": false,
2313
+ "type": "boolean"
2314
+ }
2315
+ },
2316
+ "hasDynamicHelp": true,
2317
+ "hiddenAliases": [],
2318
+ "id": "project:delete:source",
2319
+ "pluginAlias": "@salesforce/plugin-deploy-retrieve",
2320
+ "pluginName": "@salesforce/plugin-deploy-retrieve",
2321
+ "pluginType": "core",
2322
+ "strict": true,
2323
+ "summary": "Delete source from your project and from a non-source-tracked org.",
2324
+ "enableJsonFlag": true,
2325
+ "requiresProject": true,
2326
+ "isESM": true,
2327
+ "relativePath": [
2328
+ "lib",
2329
+ "commands",
2330
+ "project",
2331
+ "delete",
2332
+ "source.js"
2333
+ ],
2334
+ "aliasPermutations": [
2335
+ "force:source:delete",
2336
+ "source:force:delete",
2337
+ "source:delete:force",
2338
+ "force:delete:source",
2339
+ "delete:force:source",
2340
+ "delete:source:force"
2341
+ ],
2342
+ "permutations": [
2343
+ "project:delete:source",
2344
+ "delete:project:source",
2345
+ "delete:source:project",
2346
+ "project:source:delete",
2347
+ "source:project:delete",
2348
+ "source:delete:project"
2476
2349
  ]
2477
2350
  },
2478
- "project:reset:tracking": {
2351
+ "project:delete:tracking": {
2479
2352
  "aliases": [
2480
- "force:source:tracking:reset"
2353
+ "force:source:tracking:clear"
2481
2354
  ],
2482
2355
  "args": {},
2483
2356
  "deprecateAliases": true,
2484
- "description": "WARNING: This command deletes or overwrites all existing source tracking files. Use with extreme caution.\n\nResets local and remote source tracking so that Salesforce CLI no longer registers differences between your local files and those in the org. When you next run 'project deploy preview', Salesforce CLI returns no results, even though conflicts might actually exist. Salesforce CLI then resumes tracking new source changes as usual.\n\nUse the --revision flag to reset source tracking to a specific revision number of an org source member. To get the revision number, query the SourceMember Tooling API object with the 'data soql' command. For example:\n\n <%= config.bin %> data query --query \"SELECT MemberName, MemberType, RevisionCounter FROM SourceMember\" --use-tooling-api --target-org my-scratch",
2357
+ "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.",
2485
2358
  "examples": [
2486
- "Reset source tracking for the org with alias \"my-scratch\":\n$ <%= config.bin %> <%= command.id %> --target-org my-scratch",
2487
- "Reset source tracking to revision number 30 for your default org:\n$ <%= config.bin %> <%= command.id %> --revision 30"
2359
+ "Delete local source tracking for the org with alias \"my-scratch\":\n$ <%= config.bin %> <%= command.id %> --target-org my-scratch"
2488
2360
  ],
2489
2361
  "flags": {
2490
2362
  "json": {
@@ -2502,21 +2374,6 @@
2502
2374
  "multiple": false,
2503
2375
  "type": "option"
2504
2376
  },
2505
- "target-org": {
2506
- "aliases": [
2507
- "targetusername",
2508
- "u"
2509
- ],
2510
- "char": "o",
2511
- "deprecateAliases": true,
2512
- "name": "target-org",
2513
- "noCacheDefault": true,
2514
- "required": true,
2515
- "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
2516
- "hasDynamicHelp": true,
2517
- "multiple": false,
2518
- "type": "option"
2519
- },
2520
2377
  "api-version": {
2521
2378
  "aliases": [
2522
2379
  "apiversion"
@@ -2538,11 +2395,18 @@
2538
2395
  "multiple": false,
2539
2396
  "type": "option"
2540
2397
  },
2541
- "revision": {
2542
- "char": "r",
2543
- "name": "revision",
2544
- "summary": "SourceMember revision counter number to reset to.",
2545
- "hasDynamicHelp": false,
2398
+ "target-org": {
2399
+ "aliases": [
2400
+ "targetusername",
2401
+ "u"
2402
+ ],
2403
+ "char": "o",
2404
+ "deprecateAliases": true,
2405
+ "name": "target-org",
2406
+ "noCacheDefault": true,
2407
+ "required": true,
2408
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
2409
+ "hasDynamicHelp": true,
2546
2410
  "multiple": false,
2547
2411
  "type": "option"
2548
2412
  },
@@ -2560,12 +2424,12 @@
2560
2424
  },
2561
2425
  "hasDynamicHelp": true,
2562
2426
  "hiddenAliases": [],
2563
- "id": "project:reset:tracking",
2427
+ "id": "project:delete:tracking",
2564
2428
  "pluginAlias": "@salesforce/plugin-deploy-retrieve",
2565
2429
  "pluginName": "@salesforce/plugin-deploy-retrieve",
2566
2430
  "pluginType": "core",
2567
2431
  "strict": true,
2568
- "summary": "Reset local and remote source tracking.",
2432
+ "summary": "Delete all local source tracking information.",
2569
2433
  "enableJsonFlag": true,
2570
2434
  "requiresProject": true,
2571
2435
  "isESM": true,
@@ -2573,42 +2437,42 @@
2573
2437
  "lib",
2574
2438
  "commands",
2575
2439
  "project",
2576
- "reset",
2440
+ "delete",
2577
2441
  "tracking.js"
2578
2442
  ],
2579
2443
  "aliasPermutations": [
2580
- "force:source:tracking:reset",
2581
- "source:force:tracking:reset",
2582
- "source:tracking:force:reset",
2583
- "source:tracking:reset:force",
2584
- "force:tracking:source:reset",
2585
- "tracking:force:source:reset",
2586
- "tracking:source:force:reset",
2587
- "tracking:source:reset:force",
2588
- "force:tracking:reset:source",
2589
- "tracking:force:reset:source",
2590
- "tracking:reset:force:source",
2591
- "tracking:reset:source:force",
2592
- "force:source:reset:tracking",
2593
- "source:force:reset:tracking",
2594
- "source:reset:force:tracking",
2595
- "source:reset:tracking:force",
2596
- "force:reset:source:tracking",
2597
- "reset:force:source:tracking",
2598
- "reset:source:force:tracking",
2599
- "reset:source:tracking:force",
2600
- "force:reset:tracking:source",
2601
- "reset:force:tracking:source",
2602
- "reset:tracking:force:source",
2603
- "reset:tracking:source:force"
2444
+ "force:source:tracking:clear",
2445
+ "source:force:tracking:clear",
2446
+ "source:tracking:force:clear",
2447
+ "source:tracking:clear:force",
2448
+ "force:tracking:source:clear",
2449
+ "tracking:force:source:clear",
2450
+ "tracking:source:force:clear",
2451
+ "tracking:source:clear:force",
2452
+ "force:tracking:clear:source",
2453
+ "tracking:force:clear:source",
2454
+ "tracking:clear:force:source",
2455
+ "tracking:clear:source:force",
2456
+ "force:source:clear:tracking",
2457
+ "source:force:clear:tracking",
2458
+ "source:clear:force:tracking",
2459
+ "source:clear:tracking:force",
2460
+ "force:clear:source:tracking",
2461
+ "clear:force:source:tracking",
2462
+ "clear:source:force:tracking",
2463
+ "clear:source:tracking:force",
2464
+ "force:clear:tracking:source",
2465
+ "clear:force:tracking:source",
2466
+ "clear:tracking:force:source",
2467
+ "clear:tracking:source:force"
2604
2468
  ],
2605
2469
  "permutations": [
2606
- "project:reset:tracking",
2607
- "reset:project:tracking",
2608
- "reset:tracking:project",
2609
- "project:tracking:reset",
2610
- "tracking:project:reset",
2611
- "tracking:reset:project"
2470
+ "project:delete:tracking",
2471
+ "delete:project:tracking",
2472
+ "delete:tracking:project",
2473
+ "project:tracking:delete",
2474
+ "tracking:project:delete",
2475
+ "tracking:delete:project"
2612
2476
  ]
2613
2477
  },
2614
2478
  "project:list:ignored": {
@@ -2705,6 +2569,142 @@
2705
2569
  "ignored:list:project"
2706
2570
  ]
2707
2571
  },
2572
+ "project:reset:tracking": {
2573
+ "aliases": [
2574
+ "force:source:tracking:reset"
2575
+ ],
2576
+ "args": {},
2577
+ "deprecateAliases": true,
2578
+ "description": "WARNING: This command deletes or overwrites all existing source tracking files. Use with extreme caution.\n\nResets local and remote source tracking so that Salesforce CLI no longer registers differences between your local files and those in the org. When you next run 'project deploy preview', Salesforce CLI returns no results, even though conflicts might actually exist. Salesforce CLI then resumes tracking new source changes as usual.\n\nUse the --revision flag to reset source tracking to a specific revision number of an org source member. To get the revision number, query the SourceMember Tooling API object with the 'data soql' command. For example:\n\n <%= config.bin %> data query --query \"SELECT MemberName, MemberType, RevisionCounter FROM SourceMember\" --use-tooling-api --target-org my-scratch",
2579
+ "examples": [
2580
+ "Reset source tracking for the org with alias \"my-scratch\":\n$ <%= config.bin %> <%= command.id %> --target-org my-scratch",
2581
+ "Reset source tracking to revision number 30 for your default org:\n$ <%= config.bin %> <%= command.id %> --revision 30"
2582
+ ],
2583
+ "flags": {
2584
+ "json": {
2585
+ "description": "Format output as json.",
2586
+ "helpGroup": "GLOBAL",
2587
+ "name": "json",
2588
+ "allowNo": false,
2589
+ "type": "boolean"
2590
+ },
2591
+ "flags-dir": {
2592
+ "helpGroup": "GLOBAL",
2593
+ "name": "flags-dir",
2594
+ "summary": "Import flag values from a directory.",
2595
+ "hasDynamicHelp": false,
2596
+ "multiple": false,
2597
+ "type": "option"
2598
+ },
2599
+ "target-org": {
2600
+ "aliases": [
2601
+ "targetusername",
2602
+ "u"
2603
+ ],
2604
+ "char": "o",
2605
+ "deprecateAliases": true,
2606
+ "name": "target-org",
2607
+ "noCacheDefault": true,
2608
+ "required": true,
2609
+ "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
2610
+ "hasDynamicHelp": true,
2611
+ "multiple": false,
2612
+ "type": "option"
2613
+ },
2614
+ "api-version": {
2615
+ "aliases": [
2616
+ "apiversion"
2617
+ ],
2618
+ "deprecateAliases": true,
2619
+ "description": "Override the api version used for api requests made by this command",
2620
+ "name": "api-version",
2621
+ "hasDynamicHelp": false,
2622
+ "multiple": false,
2623
+ "type": "option"
2624
+ },
2625
+ "loglevel": {
2626
+ "deprecated": {
2627
+ "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."
2628
+ },
2629
+ "hidden": true,
2630
+ "name": "loglevel",
2631
+ "hasDynamicHelp": false,
2632
+ "multiple": false,
2633
+ "type": "option"
2634
+ },
2635
+ "revision": {
2636
+ "char": "r",
2637
+ "name": "revision",
2638
+ "summary": "SourceMember revision counter number to reset to.",
2639
+ "hasDynamicHelp": false,
2640
+ "multiple": false,
2641
+ "type": "option"
2642
+ },
2643
+ "no-prompt": {
2644
+ "aliases": [
2645
+ "noprompt"
2646
+ ],
2647
+ "char": "p",
2648
+ "deprecateAliases": true,
2649
+ "name": "no-prompt",
2650
+ "summary": "Don't prompt for source tracking override confirmation.",
2651
+ "allowNo": false,
2652
+ "type": "boolean"
2653
+ }
2654
+ },
2655
+ "hasDynamicHelp": true,
2656
+ "hiddenAliases": [],
2657
+ "id": "project:reset:tracking",
2658
+ "pluginAlias": "@salesforce/plugin-deploy-retrieve",
2659
+ "pluginName": "@salesforce/plugin-deploy-retrieve",
2660
+ "pluginType": "core",
2661
+ "strict": true,
2662
+ "summary": "Reset local and remote source tracking.",
2663
+ "enableJsonFlag": true,
2664
+ "requiresProject": true,
2665
+ "isESM": true,
2666
+ "relativePath": [
2667
+ "lib",
2668
+ "commands",
2669
+ "project",
2670
+ "reset",
2671
+ "tracking.js"
2672
+ ],
2673
+ "aliasPermutations": [
2674
+ "force:source:tracking:reset",
2675
+ "source:force:tracking:reset",
2676
+ "source:tracking:force:reset",
2677
+ "source:tracking:reset:force",
2678
+ "force:tracking:source:reset",
2679
+ "tracking:force:source:reset",
2680
+ "tracking:source:force:reset",
2681
+ "tracking:source:reset:force",
2682
+ "force:tracking:reset:source",
2683
+ "tracking:force:reset:source",
2684
+ "tracking:reset:force:source",
2685
+ "tracking:reset:source:force",
2686
+ "force:source:reset:tracking",
2687
+ "source:force:reset:tracking",
2688
+ "source:reset:force:tracking",
2689
+ "source:reset:tracking:force",
2690
+ "force:reset:source:tracking",
2691
+ "reset:force:source:tracking",
2692
+ "reset:source:force:tracking",
2693
+ "reset:source:tracking:force",
2694
+ "force:reset:tracking:source",
2695
+ "reset:force:tracking:source",
2696
+ "reset:tracking:force:source",
2697
+ "reset:tracking:source:force"
2698
+ ],
2699
+ "permutations": [
2700
+ "project:reset:tracking",
2701
+ "reset:project:tracking",
2702
+ "reset:tracking:project",
2703
+ "project:tracking:reset",
2704
+ "tracking:project:reset",
2705
+ "tracking:reset:project"
2706
+ ]
2707
+ },
2708
2708
  "project:retrieve:preview": {
2709
2709
  "aliases": [
2710
2710
  "retrieve:metadata:preview"
@@ -3050,5 +3050,5 @@
3050
3050
  ]
3051
3051
  }
3052
3052
  },
3053
- "version": "3.21.2"
3053
+ "version": "3.21.3"
3054
3054
  }