sfdx-hardis 6.8.1 → 6.9.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +5 -0
- package/lib/commands/hardis/misc/servicenow-report.d.ts +1 -0
- package/lib/commands/hardis/misc/servicenow-report.js +40 -2
- package/lib/commands/hardis/misc/servicenow-report.js.map +1 -1
- package/lib/common/notifProvider/teamsProvider.d.ts +7 -0
- package/lib/common/notifProvider/teamsProvider.js +146 -6
- package/lib/common/notifProvider/teamsProvider.js.map +1 -1
- package/oclif.manifest.json +355 -355
- package/package.json +1 -1
package/oclif.manifest.json
CHANGED
|
@@ -57,12 +57,13 @@
|
|
|
57
57
|
"world:hello"
|
|
58
58
|
]
|
|
59
59
|
},
|
|
60
|
-
"hardis:
|
|
60
|
+
"hardis:auth:login": {
|
|
61
61
|
"aliases": [],
|
|
62
62
|
"args": {},
|
|
63
|
-
"description": "\n## Command Behavior\n\n**
|
|
63
|
+
"description": "\n## Command Behavior\n\n**Authenticates to a Salesforce org, primarily designed for CI/CD workflows.**\n\nThis command facilitates secure and automated logins to Salesforce organizations within continuous integration and continuous delivery pipelines. It leverages pre-configured authentication details, ensuring that CI/CD processes can interact with Salesforce without manual intervention.\n\nKey aspects:\n\n- **Configuration-Driven:** It relies on authentication variables and files set up by dedicated configuration commands:\n - For CI/CD repositories: [Configure Org CI Authentication](https://sfdx-hardis.cloudity.com/hardis/project/configure/auth/)\n - For Monitoring repositories: [Configure Org Monitoring](https://sfdx-hardis.cloudity.com/hardis/org/configure/monitoring/)\n- **Technical Org Support:** Supports authentication to a 'technical org' (e.g., for calling Agentforce from another org) by utilizing the `SFDX_AUTH_URL_TECHNICAL_ORG` environment variable. If this variable is set, the command authenticates to this org with the alias `TECHNICAL_ORG`.\n\nTo obtain the `SFDX_AUTH_URL_TECHNICAL_ORG` value, you can run `sf org display --verbose --json` and copy the `sfdxAuthUrl` field from the output.\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical flow involves:\n\n- **Flag Parsing:** It parses command-line flags such as `instanceurl`, `devhub`, `scratchorg`, and `debug` to determine the authentication context.\n- **Authentication Hook:** It triggers an internal authentication hook (`this.config.runHook('auth', ...`)) which is responsible for executing the actual authentication logic based on the provided flags (e.g., whether it's a Dev Hub or a scratch org).\n- **Environment Variable Check:** It checks for the presence of `SFDX_AUTH_URL_TECHNICAL_ORG` or `TECHNICAL_ORG_ALIAS` environment variables.\n- **`authOrg` Utility:** If a technical org is configured, it calls the `authOrg` utility function to perform the authentication for that specific org, ensuring it's connected and available for subsequent operations.\n- **Salesforce CLI Integration:** It integrates with the Salesforce CLI's authentication mechanisms to establish and manage org connections.\n</details>\n",
|
|
64
64
|
"examples": [
|
|
65
|
-
"$ sf hardis:
|
|
65
|
+
"$ sf hardis:auth:login",
|
|
66
|
+
"CI=true CI_COMMIT_REF_NAME=monitoring_myclient sf hardis:auth:login"
|
|
66
67
|
],
|
|
67
68
|
"flags": {
|
|
68
69
|
"json": {
|
|
@@ -80,6 +81,28 @@
|
|
|
80
81
|
"multiple": false,
|
|
81
82
|
"type": "option"
|
|
82
83
|
},
|
|
84
|
+
"instanceurl": {
|
|
85
|
+
"char": "r",
|
|
86
|
+
"description": "URL of org instance",
|
|
87
|
+
"name": "instanceurl",
|
|
88
|
+
"hasDynamicHelp": false,
|
|
89
|
+
"multiple": false,
|
|
90
|
+
"type": "option"
|
|
91
|
+
},
|
|
92
|
+
"devhub": {
|
|
93
|
+
"char": "h",
|
|
94
|
+
"description": "Also connect associated DevHub",
|
|
95
|
+
"name": "devhub",
|
|
96
|
+
"allowNo": false,
|
|
97
|
+
"type": "boolean"
|
|
98
|
+
},
|
|
99
|
+
"scratchorg": {
|
|
100
|
+
"char": "s",
|
|
101
|
+
"description": "Scratch org",
|
|
102
|
+
"name": "scratchorg",
|
|
103
|
+
"allowNo": false,
|
|
104
|
+
"type": "boolean"
|
|
105
|
+
},
|
|
83
106
|
"debug": {
|
|
84
107
|
"char": "d",
|
|
85
108
|
"description": "Activate debug mode (more logs)",
|
|
@@ -103,41 +126,38 @@
|
|
|
103
126
|
},
|
|
104
127
|
"hasDynamicHelp": false,
|
|
105
128
|
"hiddenAliases": [],
|
|
106
|
-
"id": "hardis:
|
|
129
|
+
"id": "hardis:auth:login",
|
|
107
130
|
"pluginAlias": "sfdx-hardis",
|
|
108
131
|
"pluginName": "sfdx-hardis",
|
|
109
132
|
"pluginType": "core",
|
|
110
133
|
"strict": true,
|
|
111
134
|
"enableJsonFlag": true,
|
|
112
|
-
"title": "
|
|
113
|
-
"uiConfig": {
|
|
114
|
-
"hide": true
|
|
115
|
-
},
|
|
135
|
+
"title": "Login",
|
|
116
136
|
"requiresProject": false,
|
|
117
137
|
"isESM": true,
|
|
118
138
|
"relativePath": [
|
|
119
139
|
"lib",
|
|
120
140
|
"commands",
|
|
121
141
|
"hardis",
|
|
122
|
-
"
|
|
123
|
-
"
|
|
142
|
+
"auth",
|
|
143
|
+
"login.js"
|
|
124
144
|
],
|
|
125
145
|
"aliasPermutations": [],
|
|
126
146
|
"permutations": [
|
|
127
|
-
"hardis:
|
|
128
|
-
"
|
|
129
|
-
"
|
|
130
|
-
"hardis:
|
|
131
|
-
"
|
|
132
|
-
"
|
|
147
|
+
"hardis:auth:login",
|
|
148
|
+
"auth:hardis:login",
|
|
149
|
+
"auth:login:hardis",
|
|
150
|
+
"hardis:login:auth",
|
|
151
|
+
"login:hardis:auth",
|
|
152
|
+
"login:auth:hardis"
|
|
133
153
|
]
|
|
134
154
|
},
|
|
135
|
-
"hardis:
|
|
155
|
+
"hardis:cache:clear": {
|
|
136
156
|
"aliases": [],
|
|
137
157
|
"args": {},
|
|
138
|
-
"description": "\n## Command Behavior\n\n**
|
|
158
|
+
"description": "\n## Command Behavior\n\n**Clears the local cache generated by the sfdx-hardis plugin.**\n\nThis command is designed to remove temporary files, stored configurations, and other cached data that sfdx-hardis uses to optimize its operations. Clearing the cache can be beneficial for:\n\n- **Troubleshooting:** Resolving unexpected behavior or inconsistencies.\n- **Disk Space Management:** Freeing up storage on your local machine.\n- **Ensuring Fresh Data:** Guaranteeing that the plugin operates with the most current data and configurations.\n\n## Technical explanations\n\nThe command's technical implementation is straightforward:\n\n- **Direct Function Call:** It directly invokes the `clearCache()` function, which is imported from \buri../../../common/cache/index.js\buri.\n- **Cache Management Logic:** The \buriclearCache()` function encapsulates the logic for identifying and removing the specific files and directories that constitute the sfdx-hardis cache.\n",
|
|
139
159
|
"examples": [
|
|
140
|
-
"$ sf hardis:
|
|
160
|
+
"$ sf hardis:cache:clear"
|
|
141
161
|
],
|
|
142
162
|
"flags": {
|
|
143
163
|
"json": {
|
|
@@ -155,20 +175,6 @@
|
|
|
155
175
|
"multiple": false,
|
|
156
176
|
"type": "option"
|
|
157
177
|
},
|
|
158
|
-
"level": {
|
|
159
|
-
"char": "l",
|
|
160
|
-
"description": "project,branch or user",
|
|
161
|
-
"name": "level",
|
|
162
|
-
"default": "project",
|
|
163
|
-
"hasDynamicHelp": false,
|
|
164
|
-
"multiple": false,
|
|
165
|
-
"options": [
|
|
166
|
-
"project",
|
|
167
|
-
"branch",
|
|
168
|
-
"user"
|
|
169
|
-
],
|
|
170
|
-
"type": "option"
|
|
171
|
-
},
|
|
172
178
|
"debug": {
|
|
173
179
|
"char": "d",
|
|
174
180
|
"description": "Activate debug mode (more logs)",
|
|
@@ -192,39 +198,41 @@
|
|
|
192
198
|
},
|
|
193
199
|
"hasDynamicHelp": false,
|
|
194
200
|
"hiddenAliases": [],
|
|
195
|
-
"id": "hardis:
|
|
201
|
+
"id": "hardis:cache:clear",
|
|
196
202
|
"pluginAlias": "sfdx-hardis",
|
|
197
203
|
"pluginName": "sfdx-hardis",
|
|
198
204
|
"pluginType": "core",
|
|
199
205
|
"strict": true,
|
|
200
206
|
"enableJsonFlag": true,
|
|
201
|
-
"title": "
|
|
207
|
+
"title": "Clear sfdx-hardis cache",
|
|
208
|
+
"uiConfig": {
|
|
209
|
+
"hide": true
|
|
210
|
+
},
|
|
202
211
|
"requiresProject": false,
|
|
203
212
|
"isESM": true,
|
|
204
213
|
"relativePath": [
|
|
205
214
|
"lib",
|
|
206
215
|
"commands",
|
|
207
216
|
"hardis",
|
|
208
|
-
"
|
|
209
|
-
"
|
|
217
|
+
"cache",
|
|
218
|
+
"clear.js"
|
|
210
219
|
],
|
|
211
220
|
"aliasPermutations": [],
|
|
212
221
|
"permutations": [
|
|
213
|
-
"hardis:
|
|
214
|
-
"
|
|
215
|
-
"
|
|
216
|
-
"hardis:
|
|
217
|
-
"
|
|
218
|
-
"
|
|
222
|
+
"hardis:cache:clear",
|
|
223
|
+
"cache:hardis:clear",
|
|
224
|
+
"cache:clear:hardis",
|
|
225
|
+
"hardis:clear:cache",
|
|
226
|
+
"clear:hardis:cache",
|
|
227
|
+
"clear:cache:hardis"
|
|
219
228
|
]
|
|
220
229
|
},
|
|
221
|
-
"hardis:
|
|
230
|
+
"hardis:config:get": {
|
|
222
231
|
"aliases": [],
|
|
223
232
|
"args": {},
|
|
224
|
-
"description": "\n## Command Behavior\n\n**
|
|
233
|
+
"description": "\n## Command Behavior\n\n**Retrieves and displays the sfdx-hardis configuration for a specified level.**\n\nThis command allows you to inspect the configuration that is currently in effect for your project, which is useful for debugging and understanding how sfdx-hardis will behave.\n\n- **Configuration levels:** It can retrieve configuration from three different levels:\n - **Project:** The configuration defined in the project's `.sfdx-hardis.yml` file.\n - **Branch:** The configuration defined in a branch-specific configuration file (e.g., `.sfdx-hardis.production.yml`).\n - **User:** The global user-level configuration.\n\n## Technical explanations\n\nThe command's logic is straightforward:\n\n- **`getConfig` function:** It calls the `getConfig` utility function, passing the desired configuration level as an argument.\n- **Configuration loading:** The `getConfig` function is responsible for finding the appropriate configuration file, reading its contents, and parsing it as YAML or JSON.\n- **Output:** The retrieved configuration is then displayed to the user as a JSON string.\n",
|
|
225
234
|
"examples": [
|
|
226
|
-
"$ sf hardis:
|
|
227
|
-
"CI=true CI_COMMIT_REF_NAME=monitoring_myclient sf hardis:auth:login"
|
|
235
|
+
"$ sf hardis:project:deploy:sources:metadata"
|
|
228
236
|
],
|
|
229
237
|
"flags": {
|
|
230
238
|
"json": {
|
|
@@ -242,28 +250,20 @@
|
|
|
242
250
|
"multiple": false,
|
|
243
251
|
"type": "option"
|
|
244
252
|
},
|
|
245
|
-
"
|
|
246
|
-
"char": "
|
|
247
|
-
"description": "
|
|
248
|
-
"name": "
|
|
253
|
+
"level": {
|
|
254
|
+
"char": "l",
|
|
255
|
+
"description": "project,branch or user",
|
|
256
|
+
"name": "level",
|
|
257
|
+
"default": "project",
|
|
249
258
|
"hasDynamicHelp": false,
|
|
250
259
|
"multiple": false,
|
|
260
|
+
"options": [
|
|
261
|
+
"project",
|
|
262
|
+
"branch",
|
|
263
|
+
"user"
|
|
264
|
+
],
|
|
251
265
|
"type": "option"
|
|
252
266
|
},
|
|
253
|
-
"devhub": {
|
|
254
|
-
"char": "h",
|
|
255
|
-
"description": "Also connect associated DevHub",
|
|
256
|
-
"name": "devhub",
|
|
257
|
-
"allowNo": false,
|
|
258
|
-
"type": "boolean"
|
|
259
|
-
},
|
|
260
|
-
"scratchorg": {
|
|
261
|
-
"char": "s",
|
|
262
|
-
"description": "Scratch org",
|
|
263
|
-
"name": "scratchorg",
|
|
264
|
-
"allowNo": false,
|
|
265
|
-
"type": "boolean"
|
|
266
|
-
},
|
|
267
267
|
"debug": {
|
|
268
268
|
"char": "d",
|
|
269
269
|
"description": "Activate debug mode (more logs)",
|
|
@@ -287,30 +287,30 @@
|
|
|
287
287
|
},
|
|
288
288
|
"hasDynamicHelp": false,
|
|
289
289
|
"hiddenAliases": [],
|
|
290
|
-
"id": "hardis:
|
|
290
|
+
"id": "hardis:config:get",
|
|
291
291
|
"pluginAlias": "sfdx-hardis",
|
|
292
292
|
"pluginName": "sfdx-hardis",
|
|
293
293
|
"pluginType": "core",
|
|
294
294
|
"strict": true,
|
|
295
295
|
"enableJsonFlag": true,
|
|
296
|
-
"title": "
|
|
296
|
+
"title": "Deploy metadata sources to org",
|
|
297
297
|
"requiresProject": false,
|
|
298
298
|
"isESM": true,
|
|
299
299
|
"relativePath": [
|
|
300
300
|
"lib",
|
|
301
301
|
"commands",
|
|
302
302
|
"hardis",
|
|
303
|
-
"
|
|
304
|
-
"
|
|
303
|
+
"config",
|
|
304
|
+
"get.js"
|
|
305
305
|
],
|
|
306
306
|
"aliasPermutations": [],
|
|
307
307
|
"permutations": [
|
|
308
|
-
"hardis:
|
|
309
|
-
"
|
|
310
|
-
"
|
|
311
|
-
"hardis:
|
|
312
|
-
"
|
|
313
|
-
"
|
|
308
|
+
"hardis:config:get",
|
|
309
|
+
"config:hardis:get",
|
|
310
|
+
"config:get:hardis",
|
|
311
|
+
"hardis:get:config",
|
|
312
|
+
"get:hardis:config",
|
|
313
|
+
"get:config:hardis"
|
|
314
314
|
]
|
|
315
315
|
},
|
|
316
316
|
"hardis:doc:fieldusage": {
|
|
@@ -11407,12 +11407,14 @@
|
|
|
11407
11407
|
"profilestopermsets:convert:project:hardis"
|
|
11408
11408
|
]
|
|
11409
11409
|
},
|
|
11410
|
-
"hardis:project:
|
|
11410
|
+
"hardis:project:deploy:notify": {
|
|
11411
11411
|
"aliases": [],
|
|
11412
11412
|
"args": {},
|
|
11413
|
-
"description": "
|
|
11413
|
+
"description": "Post notifications related to:\n\n- **Deployment simulation** _(use with --check-only)_\n\n- **Deployment process** _(to call only if your deployment is successful)_\n\n### Integrations\n\nAccording to the [integrations you configured](https://sfdx-hardis.cloudity.com/salesforce-ci-cd-setup-integrations-home/), notifications can contain deployment information and [Flow Visual Git Diff](https://sfdx-hardis.cloudity.com/salesforce-deployment-assistant-home/#flow-visual-git-diff)\n\n - GitHub, Gitlab, Azure DevOps, Bitbucket comments on Pull Requests (including Flows Visual Git Diff)\n\n - Slack, Microsoft Teams, Email deployment summary after a successful deployment\n\n - JIRA tags and comments on tickets that just has been deployed\n\n\n\n\n\n### Flows Visual Git Diff\n\n- Visually show you the differences on a diagram\n\n- Display the update details without having to open any XML !\n\n🟩 = added\n\n🟥 = removed\n\n🟧 = updated\n\n\n\n\n\n### In custom CI/CD workflow\n\nExample of usage in a custom CI/CD pipeline:\n\n```bash\n# Disable exit-on-error temporarily\nset +e\n\n# Run the deploy command\nsf project deploy start [....]\nRET_CODE=$?\n\n# Re-enable exit-on-error\nset -e\n\n# Determine MYSTATUS based on return code\nif [ $RET_CODE -eq 0 ]; then\n MYSTATUS=\"valid\"\nelse\n MYSTATUS=\"invalid\"\nfi\n\n# Run the notify command with MYSTATUS\nsf hardis:project:deploy:notify --check-only --deploy-status \"$MYSTATUS\"\n```\n\n### Other usages\n\nThis command is for custom SF Cli pipelines, if you are a sfdx-hardis user, it is already embedded in sf hardis:deploy:smart.\n\nYou can also use [sfdx-hardis wrapper commands of SF deployment commands](https://sfdx-hardis.cloudity.com/salesforce-deployment-assistant-setup/#using-custom-cicd-pipeline)\n",
|
|
11414
11414
|
"examples": [
|
|
11415
|
-
"$ sf hardis:project:
|
|
11415
|
+
"$ sf hardis:project:deploy:notify --check-only --deploy-status valid --message \"This deployment check is valid\\n\\nYahooo !!\"",
|
|
11416
|
+
"$ sf hardis:project:deploy:notify --check-only --deploy-status invalid --message \"This deployment check has failed !\\n\\Oh no !!\"",
|
|
11417
|
+
"$ sf hardis:project:deploy:notify --deploy-status valid --message \"This deployment has been processed !\\n\\nYahooo !!\""
|
|
11416
11418
|
],
|
|
11417
11419
|
"flags": {
|
|
11418
11420
|
"json": {
|
|
@@ -11430,11 +11432,32 @@
|
|
|
11430
11432
|
"multiple": false,
|
|
11431
11433
|
"type": "option"
|
|
11432
11434
|
},
|
|
11433
|
-
"
|
|
11434
|
-
"char": "
|
|
11435
|
-
"description": "
|
|
11436
|
-
"name": "
|
|
11437
|
-
"
|
|
11435
|
+
"check-only": {
|
|
11436
|
+
"char": "c",
|
|
11437
|
+
"description": "Use this option to send notifications from a Deployment simulation job",
|
|
11438
|
+
"name": "check-only",
|
|
11439
|
+
"allowNo": false,
|
|
11440
|
+
"type": "boolean"
|
|
11441
|
+
},
|
|
11442
|
+
"deploy-status": {
|
|
11443
|
+
"char": "s",
|
|
11444
|
+
"description": "Send success, failure or unknown (default) to indicate if the deployment or deployment simulation is in success or not",
|
|
11445
|
+
"name": "deploy-status",
|
|
11446
|
+
"default": "unknown",
|
|
11447
|
+
"hasDynamicHelp": false,
|
|
11448
|
+
"multiple": false,
|
|
11449
|
+
"options": [
|
|
11450
|
+
"valid",
|
|
11451
|
+
"invalid",
|
|
11452
|
+
"unknown"
|
|
11453
|
+
],
|
|
11454
|
+
"type": "option"
|
|
11455
|
+
},
|
|
11456
|
+
"message": {
|
|
11457
|
+
"char": "m",
|
|
11458
|
+
"description": "Custom message that you want to be added in notifications (string or markdown format)",
|
|
11459
|
+
"name": "message",
|
|
11460
|
+
"default": "",
|
|
11438
11461
|
"hasDynamicHelp": false,
|
|
11439
11462
|
"multiple": false,
|
|
11440
11463
|
"type": "option"
|
|
@@ -11477,13 +11500,13 @@
|
|
|
11477
11500
|
},
|
|
11478
11501
|
"hasDynamicHelp": true,
|
|
11479
11502
|
"hiddenAliases": [],
|
|
11480
|
-
"id": "hardis:project:
|
|
11503
|
+
"id": "hardis:project:deploy:notify",
|
|
11481
11504
|
"pluginAlias": "sfdx-hardis",
|
|
11482
11505
|
"pluginName": "sfdx-hardis",
|
|
11483
11506
|
"pluginType": "core",
|
|
11484
11507
|
"strict": true,
|
|
11485
11508
|
"enableJsonFlag": true,
|
|
11486
|
-
"title": "
|
|
11509
|
+
"title": "Deployment Notifications",
|
|
11487
11510
|
"requiresProject": true,
|
|
11488
11511
|
"isESM": true,
|
|
11489
11512
|
"relativePath": [
|
|
@@ -11491,281 +11514,43 @@
|
|
|
11491
11514
|
"commands",
|
|
11492
11515
|
"hardis",
|
|
11493
11516
|
"project",
|
|
11494
|
-
"
|
|
11495
|
-
"
|
|
11517
|
+
"deploy",
|
|
11518
|
+
"notify.js"
|
|
11496
11519
|
],
|
|
11497
11520
|
"aliasPermutations": [],
|
|
11498
11521
|
"permutations": [
|
|
11499
|
-
"hardis:project:
|
|
11500
|
-
"project:hardis:
|
|
11501
|
-
"project:
|
|
11502
|
-
"project:
|
|
11503
|
-
"hardis:
|
|
11504
|
-
"
|
|
11505
|
-
"
|
|
11506
|
-
"
|
|
11507
|
-
"hardis:
|
|
11508
|
-
"
|
|
11509
|
-
"
|
|
11510
|
-
"
|
|
11511
|
-
"hardis:project:
|
|
11512
|
-
"project:hardis:
|
|
11513
|
-
"project:
|
|
11514
|
-
"project:
|
|
11515
|
-
"hardis:
|
|
11516
|
-
"
|
|
11517
|
-
"
|
|
11518
|
-
"
|
|
11519
|
-
"hardis:
|
|
11520
|
-
"
|
|
11521
|
-
"
|
|
11522
|
-
"
|
|
11522
|
+
"hardis:project:deploy:notify",
|
|
11523
|
+
"project:hardis:deploy:notify",
|
|
11524
|
+
"project:deploy:hardis:notify",
|
|
11525
|
+
"project:deploy:notify:hardis",
|
|
11526
|
+
"hardis:deploy:project:notify",
|
|
11527
|
+
"deploy:hardis:project:notify",
|
|
11528
|
+
"deploy:project:hardis:notify",
|
|
11529
|
+
"deploy:project:notify:hardis",
|
|
11530
|
+
"hardis:deploy:notify:project",
|
|
11531
|
+
"deploy:hardis:notify:project",
|
|
11532
|
+
"deploy:notify:hardis:project",
|
|
11533
|
+
"deploy:notify:project:hardis",
|
|
11534
|
+
"hardis:project:notify:deploy",
|
|
11535
|
+
"project:hardis:notify:deploy",
|
|
11536
|
+
"project:notify:hardis:deploy",
|
|
11537
|
+
"project:notify:deploy:hardis",
|
|
11538
|
+
"hardis:notify:project:deploy",
|
|
11539
|
+
"notify:hardis:project:deploy",
|
|
11540
|
+
"notify:project:hardis:deploy",
|
|
11541
|
+
"notify:project:deploy:hardis",
|
|
11542
|
+
"hardis:notify:deploy:project",
|
|
11543
|
+
"notify:hardis:deploy:project",
|
|
11544
|
+
"notify:deploy:hardis:project",
|
|
11545
|
+
"notify:deploy:project:hardis"
|
|
11523
11546
|
]
|
|
11524
11547
|
},
|
|
11525
|
-
"hardis:project:
|
|
11526
|
-
"aliases": [
|
|
11527
|
-
|
|
11528
|
-
"description": "\n## Command Behavior\n\n**Fixes Salesforce FlexiPages for compatibility with API Version 53.0 (Winter '22 release) by adding missing identifiers to component instances.**\n\nSalesforce introduced a change in API Version 53.0 that requires `identifier` tags within `componentInstance` and `fieldInstance` elements in FlexiPage metadata. If these identifiers are missing, deployments to orgs with API version 53.0 or higher will fail. This command automates the process of adding these missing identifiers, ensuring your FlexiPages remain deployable.\n\nKey functionalities:\n\n- **Targeted FlexiPage Processing:** Scans all .flexipage-meta.xml files within the specified root folder (defaults to current working directory).\n- **Identifier Injection:** Inserts a unique `identifier` tag (e.g., `SFDX_HARDIS_REPLACEMENT_ID`) into `componentInstance` and `fieldInstance` elements that lack one.\n\n**Important Note:** After running this command, ensure you update your `apiVersion` to `53.0` (or higher) in your `package.xml` and `sfdx-project.json` files.\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **File Discovery:** Uses `glob` to find all .flexipage-meta.xml files.\n- **Content Reading:** Reads the XML content of each FlexiPage file.\n- **Regular Expression Replacement:** Employs a set of regular expressions to identify specific XML patterns (componentName.../componentName.../componentInstance, componentName.../componentName.../visibilityRule, fieldItem.../fieldItem.../fieldInstance) that are missing the `identifier` tag.\n- **Dynamic ID Generation:** For each match, it generates a unique identifier (e.g., `sfdxHardisIdX`) and injects it into the XML structure.\n- **File Writing:** If changes are made, the modified XML content is written back to the FlexiPage file using `fs.writeFile`.\n- **Logging:** Provides messages about which FlexiPages are being processed and a summary of the total number of identifiers added.\n</details>\n",
|
|
11529
|
-
"examples": [
|
|
11530
|
-
"$ sf hardis:project:fix:v53flexipages"
|
|
11548
|
+
"hardis:project:deploy:quick": {
|
|
11549
|
+
"aliases": [
|
|
11550
|
+
"hardis:deploy:quick"
|
|
11531
11551
|
],
|
|
11532
|
-
"
|
|
11533
|
-
|
|
11534
|
-
"description": "Format output as json.",
|
|
11535
|
-
"helpGroup": "GLOBAL",
|
|
11536
|
-
"name": "json",
|
|
11537
|
-
"allowNo": false,
|
|
11538
|
-
"type": "boolean"
|
|
11539
|
-
},
|
|
11540
|
-
"flags-dir": {
|
|
11541
|
-
"helpGroup": "GLOBAL",
|
|
11542
|
-
"name": "flags-dir",
|
|
11543
|
-
"summary": "Import flag values from a directory.",
|
|
11544
|
-
"hasDynamicHelp": false,
|
|
11545
|
-
"multiple": false,
|
|
11546
|
-
"type": "option"
|
|
11547
|
-
},
|
|
11548
|
-
"path": {
|
|
11549
|
-
"char": "p",
|
|
11550
|
-
"description": "Root folder",
|
|
11551
|
-
"name": "path",
|
|
11552
|
-
"default": "/home/runner/work/sfdx-hardis/sfdx-hardis",
|
|
11553
|
-
"hasDynamicHelp": false,
|
|
11554
|
-
"multiple": false,
|
|
11555
|
-
"type": "option"
|
|
11556
|
-
},
|
|
11557
|
-
"debug": {
|
|
11558
|
-
"char": "d",
|
|
11559
|
-
"description": "Activate debug mode (more logs)",
|
|
11560
|
-
"name": "debug",
|
|
11561
|
-
"allowNo": false,
|
|
11562
|
-
"type": "boolean"
|
|
11563
|
-
},
|
|
11564
|
-
"websocket": {
|
|
11565
|
-
"description": "Websocket host:port for VsCode SFDX Hardis UI integration",
|
|
11566
|
-
"name": "websocket",
|
|
11567
|
-
"hasDynamicHelp": false,
|
|
11568
|
-
"multiple": false,
|
|
11569
|
-
"type": "option"
|
|
11570
|
-
},
|
|
11571
|
-
"skipauth": {
|
|
11572
|
-
"description": "Skip authentication check when a default username is required",
|
|
11573
|
-
"name": "skipauth",
|
|
11574
|
-
"allowNo": false,
|
|
11575
|
-
"type": "boolean"
|
|
11576
|
-
}
|
|
11577
|
-
},
|
|
11578
|
-
"hasDynamicHelp": false,
|
|
11579
|
-
"hiddenAliases": [],
|
|
11580
|
-
"id": "hardis:project:fix:v53flexipages",
|
|
11581
|
-
"pluginAlias": "sfdx-hardis",
|
|
11582
|
-
"pluginName": "sfdx-hardis",
|
|
11583
|
-
"pluginType": "core",
|
|
11584
|
-
"strict": true,
|
|
11585
|
-
"enableJsonFlag": true,
|
|
11586
|
-
"title": "Fix flexipages for v53",
|
|
11587
|
-
"requiresProject": true,
|
|
11588
|
-
"isESM": true,
|
|
11589
|
-
"relativePath": [
|
|
11590
|
-
"lib",
|
|
11591
|
-
"commands",
|
|
11592
|
-
"hardis",
|
|
11593
|
-
"project",
|
|
11594
|
-
"fix",
|
|
11595
|
-
"v53flexipages.js"
|
|
11596
|
-
],
|
|
11597
|
-
"aliasPermutations": [],
|
|
11598
|
-
"permutations": [
|
|
11599
|
-
"hardis:project:fix:v53flexipages",
|
|
11600
|
-
"project:hardis:fix:v53flexipages",
|
|
11601
|
-
"project:fix:hardis:v53flexipages",
|
|
11602
|
-
"project:fix:v53flexipages:hardis",
|
|
11603
|
-
"hardis:fix:project:v53flexipages",
|
|
11604
|
-
"fix:hardis:project:v53flexipages",
|
|
11605
|
-
"fix:project:hardis:v53flexipages",
|
|
11606
|
-
"fix:project:v53flexipages:hardis",
|
|
11607
|
-
"hardis:fix:v53flexipages:project",
|
|
11608
|
-
"fix:hardis:v53flexipages:project",
|
|
11609
|
-
"fix:v53flexipages:hardis:project",
|
|
11610
|
-
"fix:v53flexipages:project:hardis",
|
|
11611
|
-
"hardis:project:v53flexipages:fix",
|
|
11612
|
-
"project:hardis:v53flexipages:fix",
|
|
11613
|
-
"project:v53flexipages:hardis:fix",
|
|
11614
|
-
"project:v53flexipages:fix:hardis",
|
|
11615
|
-
"hardis:v53flexipages:project:fix",
|
|
11616
|
-
"v53flexipages:hardis:project:fix",
|
|
11617
|
-
"v53flexipages:project:hardis:fix",
|
|
11618
|
-
"v53flexipages:project:fix:hardis",
|
|
11619
|
-
"hardis:v53flexipages:fix:project",
|
|
11620
|
-
"v53flexipages:hardis:fix:project",
|
|
11621
|
-
"v53flexipages:fix:hardis:project",
|
|
11622
|
-
"v53flexipages:fix:project:hardis"
|
|
11623
|
-
]
|
|
11624
|
-
},
|
|
11625
|
-
"hardis:project:deploy:notify": {
|
|
11626
|
-
"aliases": [],
|
|
11627
|
-
"args": {},
|
|
11628
|
-
"description": "Post notifications related to:\n\n- **Deployment simulation** _(use with --check-only)_\n\n- **Deployment process** _(to call only if your deployment is successful)_\n\n### Integrations\n\nAccording to the [integrations you configured](https://sfdx-hardis.cloudity.com/salesforce-ci-cd-setup-integrations-home/), notifications can contain deployment information and [Flow Visual Git Diff](https://sfdx-hardis.cloudity.com/salesforce-deployment-assistant-home/#flow-visual-git-diff)\n\n - GitHub, Gitlab, Azure DevOps, Bitbucket comments on Pull Requests (including Flows Visual Git Diff)\n\n - Slack, Microsoft Teams, Email deployment summary after a successful deployment\n\n - JIRA tags and comments on tickets that just has been deployed\n\n\n\n\n\n### Flows Visual Git Diff\n\n- Visually show you the differences on a diagram\n\n- Display the update details without having to open any XML !\n\n🟩 = added\n\n🟥 = removed\n\n🟧 = updated\n\n\n\n\n\n### In custom CI/CD workflow\n\nExample of usage in a custom CI/CD pipeline:\n\n```bash\n# Disable exit-on-error temporarily\nset +e\n\n# Run the deploy command\nsf project deploy start [....]\nRET_CODE=$?\n\n# Re-enable exit-on-error\nset -e\n\n# Determine MYSTATUS based on return code\nif [ $RET_CODE -eq 0 ]; then\n MYSTATUS=\"valid\"\nelse\n MYSTATUS=\"invalid\"\nfi\n\n# Run the notify command with MYSTATUS\nsf hardis:project:deploy:notify --check-only --deploy-status \"$MYSTATUS\"\n```\n\n### Other usages\n\nThis command is for custom SF Cli pipelines, if you are a sfdx-hardis user, it is already embedded in sf hardis:deploy:smart.\n\nYou can also use [sfdx-hardis wrapper commands of SF deployment commands](https://sfdx-hardis.cloudity.com/salesforce-deployment-assistant-setup/#using-custom-cicd-pipeline)\n",
|
|
11629
|
-
"examples": [
|
|
11630
|
-
"$ sf hardis:project:deploy:notify --check-only --deploy-status valid --message \"This deployment check is valid\\n\\nYahooo !!\"",
|
|
11631
|
-
"$ sf hardis:project:deploy:notify --check-only --deploy-status invalid --message \"This deployment check has failed !\\n\\Oh no !!\"",
|
|
11632
|
-
"$ sf hardis:project:deploy:notify --deploy-status valid --message \"This deployment has been processed !\\n\\nYahooo !!\""
|
|
11633
|
-
],
|
|
11634
|
-
"flags": {
|
|
11635
|
-
"json": {
|
|
11636
|
-
"description": "Format output as json.",
|
|
11637
|
-
"helpGroup": "GLOBAL",
|
|
11638
|
-
"name": "json",
|
|
11639
|
-
"allowNo": false,
|
|
11640
|
-
"type": "boolean"
|
|
11641
|
-
},
|
|
11642
|
-
"flags-dir": {
|
|
11643
|
-
"helpGroup": "GLOBAL",
|
|
11644
|
-
"name": "flags-dir",
|
|
11645
|
-
"summary": "Import flag values from a directory.",
|
|
11646
|
-
"hasDynamicHelp": false,
|
|
11647
|
-
"multiple": false,
|
|
11648
|
-
"type": "option"
|
|
11649
|
-
},
|
|
11650
|
-
"check-only": {
|
|
11651
|
-
"char": "c",
|
|
11652
|
-
"description": "Use this option to send notifications from a Deployment simulation job",
|
|
11653
|
-
"name": "check-only",
|
|
11654
|
-
"allowNo": false,
|
|
11655
|
-
"type": "boolean"
|
|
11656
|
-
},
|
|
11657
|
-
"deploy-status": {
|
|
11658
|
-
"char": "s",
|
|
11659
|
-
"description": "Send success, failure or unknown (default) to indicate if the deployment or deployment simulation is in success or not",
|
|
11660
|
-
"name": "deploy-status",
|
|
11661
|
-
"default": "unknown",
|
|
11662
|
-
"hasDynamicHelp": false,
|
|
11663
|
-
"multiple": false,
|
|
11664
|
-
"options": [
|
|
11665
|
-
"valid",
|
|
11666
|
-
"invalid",
|
|
11667
|
-
"unknown"
|
|
11668
|
-
],
|
|
11669
|
-
"type": "option"
|
|
11670
|
-
},
|
|
11671
|
-
"message": {
|
|
11672
|
-
"char": "m",
|
|
11673
|
-
"description": "Custom message that you want to be added in notifications (string or markdown format)",
|
|
11674
|
-
"name": "message",
|
|
11675
|
-
"default": "",
|
|
11676
|
-
"hasDynamicHelp": false,
|
|
11677
|
-
"multiple": false,
|
|
11678
|
-
"type": "option"
|
|
11679
|
-
},
|
|
11680
|
-
"debug": {
|
|
11681
|
-
"char": "d",
|
|
11682
|
-
"description": "Activate debug mode (more logs)",
|
|
11683
|
-
"name": "debug",
|
|
11684
|
-
"allowNo": false,
|
|
11685
|
-
"type": "boolean"
|
|
11686
|
-
},
|
|
11687
|
-
"websocket": {
|
|
11688
|
-
"description": "Websocket host:port for VsCode SFDX Hardis UI integration",
|
|
11689
|
-
"name": "websocket",
|
|
11690
|
-
"hasDynamicHelp": false,
|
|
11691
|
-
"multiple": false,
|
|
11692
|
-
"type": "option"
|
|
11693
|
-
},
|
|
11694
|
-
"skipauth": {
|
|
11695
|
-
"description": "Skip authentication check when a default username is required",
|
|
11696
|
-
"name": "skipauth",
|
|
11697
|
-
"allowNo": false,
|
|
11698
|
-
"type": "boolean"
|
|
11699
|
-
},
|
|
11700
|
-
"target-org": {
|
|
11701
|
-
"aliases": [
|
|
11702
|
-
"targetusername",
|
|
11703
|
-
"u"
|
|
11704
|
-
],
|
|
11705
|
-
"char": "o",
|
|
11706
|
-
"deprecateAliases": true,
|
|
11707
|
-
"name": "target-org",
|
|
11708
|
-
"noCacheDefault": true,
|
|
11709
|
-
"required": true,
|
|
11710
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
11711
|
-
"hasDynamicHelp": true,
|
|
11712
|
-
"multiple": false,
|
|
11713
|
-
"type": "option"
|
|
11714
|
-
}
|
|
11715
|
-
},
|
|
11716
|
-
"hasDynamicHelp": true,
|
|
11717
|
-
"hiddenAliases": [],
|
|
11718
|
-
"id": "hardis:project:deploy:notify",
|
|
11719
|
-
"pluginAlias": "sfdx-hardis",
|
|
11720
|
-
"pluginName": "sfdx-hardis",
|
|
11721
|
-
"pluginType": "core",
|
|
11722
|
-
"strict": true,
|
|
11723
|
-
"enableJsonFlag": true,
|
|
11724
|
-
"title": "Deployment Notifications",
|
|
11725
|
-
"requiresProject": true,
|
|
11726
|
-
"isESM": true,
|
|
11727
|
-
"relativePath": [
|
|
11728
|
-
"lib",
|
|
11729
|
-
"commands",
|
|
11730
|
-
"hardis",
|
|
11731
|
-
"project",
|
|
11732
|
-
"deploy",
|
|
11733
|
-
"notify.js"
|
|
11734
|
-
],
|
|
11735
|
-
"aliasPermutations": [],
|
|
11736
|
-
"permutations": [
|
|
11737
|
-
"hardis:project:deploy:notify",
|
|
11738
|
-
"project:hardis:deploy:notify",
|
|
11739
|
-
"project:deploy:hardis:notify",
|
|
11740
|
-
"project:deploy:notify:hardis",
|
|
11741
|
-
"hardis:deploy:project:notify",
|
|
11742
|
-
"deploy:hardis:project:notify",
|
|
11743
|
-
"deploy:project:hardis:notify",
|
|
11744
|
-
"deploy:project:notify:hardis",
|
|
11745
|
-
"hardis:deploy:notify:project",
|
|
11746
|
-
"deploy:hardis:notify:project",
|
|
11747
|
-
"deploy:notify:hardis:project",
|
|
11748
|
-
"deploy:notify:project:hardis",
|
|
11749
|
-
"hardis:project:notify:deploy",
|
|
11750
|
-
"project:hardis:notify:deploy",
|
|
11751
|
-
"project:notify:hardis:deploy",
|
|
11752
|
-
"project:notify:deploy:hardis",
|
|
11753
|
-
"hardis:notify:project:deploy",
|
|
11754
|
-
"notify:hardis:project:deploy",
|
|
11755
|
-
"notify:project:hardis:deploy",
|
|
11756
|
-
"notify:project:deploy:hardis",
|
|
11757
|
-
"hardis:notify:deploy:project",
|
|
11758
|
-
"notify:hardis:deploy:project",
|
|
11759
|
-
"notify:deploy:hardis:project",
|
|
11760
|
-
"notify:deploy:project:hardis"
|
|
11761
|
-
]
|
|
11762
|
-
},
|
|
11763
|
-
"hardis:project:deploy:quick": {
|
|
11764
|
-
"aliases": [
|
|
11765
|
-
"hardis:deploy:quick"
|
|
11766
|
-
],
|
|
11767
|
-
"args": {},
|
|
11768
|
-
"description": "sfdx-hardis wrapper for **sf project deploy quick** that displays tips to solve deployment errors.\n\nNote: Use **--json** argument to have better results\n\n[](https://nicolas.vuillamy.fr/assisted-solving-of-salesforce-deployments-errors-47f3666a9ed0)\n\n[See documentation of Salesforce command](https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_project_commands_unified.htm#cli_reference_project_deploy_quick_unified)\n\n### Deployment pre or post commands\n\nYou can define command lines to run before or after a deployment, with parameters:\n\n- **id**: Unique Id for the command\n- **label**: Human readable label for the command\n- **skipIfError**: If defined to \"true\", the post-command won't be run if there is a deployment failure\n- **context**: Defines the context where the command will be run. Can be **all** (default), **check-deployment-only** or **process-deployment-only**\n- **runOnlyOnceByOrg**: If set to true, the command will be run only one time per org. A record of SfdxHardisTrace__c is stored to make that possible (it needs to be existing in target org)\n\nIf the commands are not the same depending on the target org, you can define them into **config/branches/.sfdx-hardis-BRANCHNAME.yml** instead of root **config/.sfdx-hardis.yml**\n\nExample:\n\n```yaml\ncommandsPreDeploy:\n - id: knowledgeUnassign\n label: Remove KnowledgeUser right to the user who has it\n command: sf data update record --sobject User --where \"UserPermissionsKnowledgeUser='true'\" --values \"UserPermissionsKnowledgeUser='false'\" --json\n - id: knowledgeAssign\n label: Assign Knowledge user to the deployment user\n command: sf data update record --sobject User --where \"Username='deploy.github@myclient.com'\" --values \"UserPermissionsKnowledgeUser='true'\" --json\n\ncommandsPostDeploy:\n - id: knowledgeUnassign\n label: Remove KnowledgeUser right to the user who has it\n command: sf data update record --sobject User --where \"UserPermissionsKnowledgeUser='true'\" --values \"UserPermissionsKnowledgeUser='false'\" --json\n - id: knowledgeAssign\n label: Assign Knowledge user to desired username\n command: sf data update record --sobject User --where \"Username='admin-yser@myclient.com'\" --values \"UserPermissionsKnowledgeUser='true'\" --json\n - id: someActionToRunJustOneTime\n label: And to run only if deployment is success\n command: sf sfdmu:run ...\n skipIfError: true\n context: process-deployment-only\n runOnlyOnceByOrg: true\n```\n",
|
|
11552
|
+
"args": {},
|
|
11553
|
+
"description": "sfdx-hardis wrapper for **sf project deploy quick** that displays tips to solve deployment errors.\n\nNote: Use **--json** argument to have better results\n\n[](https://nicolas.vuillamy.fr/assisted-solving-of-salesforce-deployments-errors-47f3666a9ed0)\n\n[See documentation of Salesforce command](https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_project_commands_unified.htm#cli_reference_project_deploy_quick_unified)\n\n### Deployment pre or post commands\n\nYou can define command lines to run before or after a deployment, with parameters:\n\n- **id**: Unique Id for the command\n- **label**: Human readable label for the command\n- **skipIfError**: If defined to \"true\", the post-command won't be run if there is a deployment failure\n- **context**: Defines the context where the command will be run. Can be **all** (default), **check-deployment-only** or **process-deployment-only**\n- **runOnlyOnceByOrg**: If set to true, the command will be run only one time per org. A record of SfdxHardisTrace__c is stored to make that possible (it needs to be existing in target org)\n\nIf the commands are not the same depending on the target org, you can define them into **config/branches/.sfdx-hardis-BRANCHNAME.yml** instead of root **config/.sfdx-hardis.yml**\n\nExample:\n\n```yaml\ncommandsPreDeploy:\n - id: knowledgeUnassign\n label: Remove KnowledgeUser right to the user who has it\n command: sf data update record --sobject User --where \"UserPermissionsKnowledgeUser='true'\" --values \"UserPermissionsKnowledgeUser='false'\" --json\n - id: knowledgeAssign\n label: Assign Knowledge user to the deployment user\n command: sf data update record --sobject User --where \"Username='deploy.github@myclient.com'\" --values \"UserPermissionsKnowledgeUser='true'\" --json\n\ncommandsPostDeploy:\n - id: knowledgeUnassign\n label: Remove KnowledgeUser right to the user who has it\n command: sf data update record --sobject User --where \"UserPermissionsKnowledgeUser='true'\" --values \"UserPermissionsKnowledgeUser='false'\" --json\n - id: knowledgeAssign\n label: Assign Knowledge user to desired username\n command: sf data update record --sobject User --where \"Username='admin-yser@myclient.com'\" --values \"UserPermissionsKnowledgeUser='true'\" --json\n - id: someActionToRunJustOneTime\n label: And to run only if deployment is success\n command: sf sfdmu:run ...\n skipIfError: true\n context: process-deployment-only\n runOnlyOnceByOrg: true\n```\n",
|
|
11769
11554
|
"flags": {
|
|
11770
11555
|
"json": {
|
|
11771
11556
|
"description": "Format output as json.",
|
|
@@ -12797,6 +12582,221 @@
|
|
|
12797
12582
|
"validate:deploy:project:hardis"
|
|
12798
12583
|
]
|
|
12799
12584
|
},
|
|
12585
|
+
"hardis:project:fix:profiletabs": {
|
|
12586
|
+
"aliases": [],
|
|
12587
|
+
"args": {},
|
|
12588
|
+
"description": "\n## Command Behavior\n\n**Interactively updates tab visibility settings in Salesforce profiles, addressing a common issue where tab visibilities are not correctly retrieved by `sf project retrieve start`.**\n\nThis command provides a user-friendly interface to manage tab settings within your profile XML files, ensuring that your local project accurately reflects the intended tab configurations in your Salesforce org.\n\nKey functionalities:\n\n- **Interactive Tab Selection:** Displays a multi-select menu of all available tabs in your org, allowing you to choose which tabs to update.\n- **Visibility Control:** Lets you set the visibility for the selected tabs to either `DefaultOn` (Visible) or `Hidden`.\n- **Profile Selection:** Presents a multi-select menu of all .profile-meta.xml files in your project, allowing you to apply the tab visibility changes to specific profiles.\n- **XML Updates:** Modifies the <tabVisibilities> section of the selected profile XML files to reflect the chosen tab settings. If a tab visibility setting already exists for a selected tab, it will be updated; otherwise, a new one will be added.\n- **Sorted Output:** The <tabVisibilities> in the updated profile XML files are sorted alphabetically for consistency and readability.\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **SOQL Queries (Tooling API):** It queries the `TabDefinition` object using `soqlQueryTooling` to retrieve a list of all available tabs in the target org.\n- **File Discovery:** Uses `glob` to find all .profile-meta.xml files within the specified project path.\n- **Interactive Prompts:** Leverages the `prompts` library to create interactive menus for selecting tabs, visibility settings, and profiles.\n- **XML Parsing and Manipulation:** Uses `parseXmlFile` to read the content of profile XML files and `writeXmlFile` to write the modified content back. It manipulates the `tabVisibilities` array within the parsed XML to add or update tab settings.\n- **Array Sorting:** Employs the `sort-array` library to sort the `tabVisibilities` alphabetically by tab name.\n- **Logging:** Provides feedback to the user about which profiles have been updated and a summary of the changes.\n</details>\n",
|
|
12589
|
+
"examples": [
|
|
12590
|
+
"$ sf hardis:project:fix:profiletabs"
|
|
12591
|
+
],
|
|
12592
|
+
"flags": {
|
|
12593
|
+
"json": {
|
|
12594
|
+
"description": "Format output as json.",
|
|
12595
|
+
"helpGroup": "GLOBAL",
|
|
12596
|
+
"name": "json",
|
|
12597
|
+
"allowNo": false,
|
|
12598
|
+
"type": "boolean"
|
|
12599
|
+
},
|
|
12600
|
+
"flags-dir": {
|
|
12601
|
+
"helpGroup": "GLOBAL",
|
|
12602
|
+
"name": "flags-dir",
|
|
12603
|
+
"summary": "Import flag values from a directory.",
|
|
12604
|
+
"hasDynamicHelp": false,
|
|
12605
|
+
"multiple": false,
|
|
12606
|
+
"type": "option"
|
|
12607
|
+
},
|
|
12608
|
+
"path": {
|
|
12609
|
+
"char": "p",
|
|
12610
|
+
"description": "Root folder",
|
|
12611
|
+
"name": "path",
|
|
12612
|
+
"default": "/home/runner/work/sfdx-hardis/sfdx-hardis",
|
|
12613
|
+
"hasDynamicHelp": false,
|
|
12614
|
+
"multiple": false,
|
|
12615
|
+
"type": "option"
|
|
12616
|
+
},
|
|
12617
|
+
"debug": {
|
|
12618
|
+
"char": "d",
|
|
12619
|
+
"description": "Activate debug mode (more logs)",
|
|
12620
|
+
"name": "debug",
|
|
12621
|
+
"allowNo": false,
|
|
12622
|
+
"type": "boolean"
|
|
12623
|
+
},
|
|
12624
|
+
"websocket": {
|
|
12625
|
+
"description": "Websocket host:port for VsCode SFDX Hardis UI integration",
|
|
12626
|
+
"name": "websocket",
|
|
12627
|
+
"hasDynamicHelp": false,
|
|
12628
|
+
"multiple": false,
|
|
12629
|
+
"type": "option"
|
|
12630
|
+
},
|
|
12631
|
+
"skipauth": {
|
|
12632
|
+
"description": "Skip authentication check when a default username is required",
|
|
12633
|
+
"name": "skipauth",
|
|
12634
|
+
"allowNo": false,
|
|
12635
|
+
"type": "boolean"
|
|
12636
|
+
},
|
|
12637
|
+
"target-org": {
|
|
12638
|
+
"aliases": [
|
|
12639
|
+
"targetusername",
|
|
12640
|
+
"u"
|
|
12641
|
+
],
|
|
12642
|
+
"char": "o",
|
|
12643
|
+
"deprecateAliases": true,
|
|
12644
|
+
"name": "target-org",
|
|
12645
|
+
"noCacheDefault": true,
|
|
12646
|
+
"required": true,
|
|
12647
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
12648
|
+
"hasDynamicHelp": true,
|
|
12649
|
+
"multiple": false,
|
|
12650
|
+
"type": "option"
|
|
12651
|
+
}
|
|
12652
|
+
},
|
|
12653
|
+
"hasDynamicHelp": true,
|
|
12654
|
+
"hiddenAliases": [],
|
|
12655
|
+
"id": "hardis:project:fix:profiletabs",
|
|
12656
|
+
"pluginAlias": "sfdx-hardis",
|
|
12657
|
+
"pluginName": "sfdx-hardis",
|
|
12658
|
+
"pluginType": "core",
|
|
12659
|
+
"strict": true,
|
|
12660
|
+
"enableJsonFlag": true,
|
|
12661
|
+
"title": "Fix profiles to add tabs that are not retrieved by SF CLI",
|
|
12662
|
+
"requiresProject": true,
|
|
12663
|
+
"isESM": true,
|
|
12664
|
+
"relativePath": [
|
|
12665
|
+
"lib",
|
|
12666
|
+
"commands",
|
|
12667
|
+
"hardis",
|
|
12668
|
+
"project",
|
|
12669
|
+
"fix",
|
|
12670
|
+
"profiletabs.js"
|
|
12671
|
+
],
|
|
12672
|
+
"aliasPermutations": [],
|
|
12673
|
+
"permutations": [
|
|
12674
|
+
"hardis:project:fix:profiletabs",
|
|
12675
|
+
"project:hardis:fix:profiletabs",
|
|
12676
|
+
"project:fix:hardis:profiletabs",
|
|
12677
|
+
"project:fix:profiletabs:hardis",
|
|
12678
|
+
"hardis:fix:project:profiletabs",
|
|
12679
|
+
"fix:hardis:project:profiletabs",
|
|
12680
|
+
"fix:project:hardis:profiletabs",
|
|
12681
|
+
"fix:project:profiletabs:hardis",
|
|
12682
|
+
"hardis:fix:profiletabs:project",
|
|
12683
|
+
"fix:hardis:profiletabs:project",
|
|
12684
|
+
"fix:profiletabs:hardis:project",
|
|
12685
|
+
"fix:profiletabs:project:hardis",
|
|
12686
|
+
"hardis:project:profiletabs:fix",
|
|
12687
|
+
"project:hardis:profiletabs:fix",
|
|
12688
|
+
"project:profiletabs:hardis:fix",
|
|
12689
|
+
"project:profiletabs:fix:hardis",
|
|
12690
|
+
"hardis:profiletabs:project:fix",
|
|
12691
|
+
"profiletabs:hardis:project:fix",
|
|
12692
|
+
"profiletabs:project:hardis:fix",
|
|
12693
|
+
"profiletabs:project:fix:hardis",
|
|
12694
|
+
"hardis:profiletabs:fix:project",
|
|
12695
|
+
"profiletabs:hardis:fix:project",
|
|
12696
|
+
"profiletabs:fix:hardis:project",
|
|
12697
|
+
"profiletabs:fix:project:hardis"
|
|
12698
|
+
]
|
|
12699
|
+
},
|
|
12700
|
+
"hardis:project:fix:v53flexipages": {
|
|
12701
|
+
"aliases": [],
|
|
12702
|
+
"args": {},
|
|
12703
|
+
"description": "\n## Command Behavior\n\n**Fixes Salesforce FlexiPages for compatibility with API Version 53.0 (Winter '22 release) by adding missing identifiers to component instances.**\n\nSalesforce introduced a change in API Version 53.0 that requires `identifier` tags within `componentInstance` and `fieldInstance` elements in FlexiPage metadata. If these identifiers are missing, deployments to orgs with API version 53.0 or higher will fail. This command automates the process of adding these missing identifiers, ensuring your FlexiPages remain deployable.\n\nKey functionalities:\n\n- **Targeted FlexiPage Processing:** Scans all .flexipage-meta.xml files within the specified root folder (defaults to current working directory).\n- **Identifier Injection:** Inserts a unique `identifier` tag (e.g., `SFDX_HARDIS_REPLACEMENT_ID`) into `componentInstance` and `fieldInstance` elements that lack one.\n\n**Important Note:** After running this command, ensure you update your `apiVersion` to `53.0` (or higher) in your `package.xml` and `sfdx-project.json` files.\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **File Discovery:** Uses `glob` to find all .flexipage-meta.xml files.\n- **Content Reading:** Reads the XML content of each FlexiPage file.\n- **Regular Expression Replacement:** Employs a set of regular expressions to identify specific XML patterns (componentName.../componentName.../componentInstance, componentName.../componentName.../visibilityRule, fieldItem.../fieldItem.../fieldInstance) that are missing the `identifier` tag.\n- **Dynamic ID Generation:** For each match, it generates a unique identifier (e.g., `sfdxHardisIdX`) and injects it into the XML structure.\n- **File Writing:** If changes are made, the modified XML content is written back to the FlexiPage file using `fs.writeFile`.\n- **Logging:** Provides messages about which FlexiPages are being processed and a summary of the total number of identifiers added.\n</details>\n",
|
|
12704
|
+
"examples": [
|
|
12705
|
+
"$ sf hardis:project:fix:v53flexipages"
|
|
12706
|
+
],
|
|
12707
|
+
"flags": {
|
|
12708
|
+
"json": {
|
|
12709
|
+
"description": "Format output as json.",
|
|
12710
|
+
"helpGroup": "GLOBAL",
|
|
12711
|
+
"name": "json",
|
|
12712
|
+
"allowNo": false,
|
|
12713
|
+
"type": "boolean"
|
|
12714
|
+
},
|
|
12715
|
+
"flags-dir": {
|
|
12716
|
+
"helpGroup": "GLOBAL",
|
|
12717
|
+
"name": "flags-dir",
|
|
12718
|
+
"summary": "Import flag values from a directory.",
|
|
12719
|
+
"hasDynamicHelp": false,
|
|
12720
|
+
"multiple": false,
|
|
12721
|
+
"type": "option"
|
|
12722
|
+
},
|
|
12723
|
+
"path": {
|
|
12724
|
+
"char": "p",
|
|
12725
|
+
"description": "Root folder",
|
|
12726
|
+
"name": "path",
|
|
12727
|
+
"default": "/home/runner/work/sfdx-hardis/sfdx-hardis",
|
|
12728
|
+
"hasDynamicHelp": false,
|
|
12729
|
+
"multiple": false,
|
|
12730
|
+
"type": "option"
|
|
12731
|
+
},
|
|
12732
|
+
"debug": {
|
|
12733
|
+
"char": "d",
|
|
12734
|
+
"description": "Activate debug mode (more logs)",
|
|
12735
|
+
"name": "debug",
|
|
12736
|
+
"allowNo": false,
|
|
12737
|
+
"type": "boolean"
|
|
12738
|
+
},
|
|
12739
|
+
"websocket": {
|
|
12740
|
+
"description": "Websocket host:port for VsCode SFDX Hardis UI integration",
|
|
12741
|
+
"name": "websocket",
|
|
12742
|
+
"hasDynamicHelp": false,
|
|
12743
|
+
"multiple": false,
|
|
12744
|
+
"type": "option"
|
|
12745
|
+
},
|
|
12746
|
+
"skipauth": {
|
|
12747
|
+
"description": "Skip authentication check when a default username is required",
|
|
12748
|
+
"name": "skipauth",
|
|
12749
|
+
"allowNo": false,
|
|
12750
|
+
"type": "boolean"
|
|
12751
|
+
}
|
|
12752
|
+
},
|
|
12753
|
+
"hasDynamicHelp": false,
|
|
12754
|
+
"hiddenAliases": [],
|
|
12755
|
+
"id": "hardis:project:fix:v53flexipages",
|
|
12756
|
+
"pluginAlias": "sfdx-hardis",
|
|
12757
|
+
"pluginName": "sfdx-hardis",
|
|
12758
|
+
"pluginType": "core",
|
|
12759
|
+
"strict": true,
|
|
12760
|
+
"enableJsonFlag": true,
|
|
12761
|
+
"title": "Fix flexipages for v53",
|
|
12762
|
+
"requiresProject": true,
|
|
12763
|
+
"isESM": true,
|
|
12764
|
+
"relativePath": [
|
|
12765
|
+
"lib",
|
|
12766
|
+
"commands",
|
|
12767
|
+
"hardis",
|
|
12768
|
+
"project",
|
|
12769
|
+
"fix",
|
|
12770
|
+
"v53flexipages.js"
|
|
12771
|
+
],
|
|
12772
|
+
"aliasPermutations": [],
|
|
12773
|
+
"permutations": [
|
|
12774
|
+
"hardis:project:fix:v53flexipages",
|
|
12775
|
+
"project:hardis:fix:v53flexipages",
|
|
12776
|
+
"project:fix:hardis:v53flexipages",
|
|
12777
|
+
"project:fix:v53flexipages:hardis",
|
|
12778
|
+
"hardis:fix:project:v53flexipages",
|
|
12779
|
+
"fix:hardis:project:v53flexipages",
|
|
12780
|
+
"fix:project:hardis:v53flexipages",
|
|
12781
|
+
"fix:project:v53flexipages:hardis",
|
|
12782
|
+
"hardis:fix:v53flexipages:project",
|
|
12783
|
+
"fix:hardis:v53flexipages:project",
|
|
12784
|
+
"fix:v53flexipages:hardis:project",
|
|
12785
|
+
"fix:v53flexipages:project:hardis",
|
|
12786
|
+
"hardis:project:v53flexipages:fix",
|
|
12787
|
+
"project:hardis:v53flexipages:fix",
|
|
12788
|
+
"project:v53flexipages:hardis:fix",
|
|
12789
|
+
"project:v53flexipages:fix:hardis",
|
|
12790
|
+
"hardis:v53flexipages:project:fix",
|
|
12791
|
+
"v53flexipages:hardis:project:fix",
|
|
12792
|
+
"v53flexipages:project:hardis:fix",
|
|
12793
|
+
"v53flexipages:project:fix:hardis",
|
|
12794
|
+
"hardis:v53flexipages:fix:project",
|
|
12795
|
+
"v53flexipages:hardis:fix:project",
|
|
12796
|
+
"v53flexipages:fix:hardis:project",
|
|
12797
|
+
"v53flexipages:fix:project:hardis"
|
|
12798
|
+
]
|
|
12799
|
+
},
|
|
12800
12800
|
"hardis:project:generate:bypass": {
|
|
12801
12801
|
"aliases": [],
|
|
12802
12802
|
"args": {},
|
|
@@ -15370,5 +15370,5 @@
|
|
|
15370
15370
|
]
|
|
15371
15371
|
}
|
|
15372
15372
|
},
|
|
15373
|
-
"version": "6.
|
|
15373
|
+
"version": "6.9.0"
|
|
15374
15374
|
}
|