sfdx-hardis 6.15.1-beta202512081818.0 → 6.15.2-beta202512140349.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 +8 -0
- package/lib/common/gitProvider/utilsMarkdown.js +3 -0
- package/lib/common/gitProvider/utilsMarkdown.js.map +1 -1
- package/lib/common/ticketProvider/jiraProvider.d.ts +1 -0
- package/lib/common/ticketProvider/jiraProvider.js +4 -2
- package/lib/common/ticketProvider/jiraProvider.js.map +1 -1
- package/lib/common/utils/index.js +5 -0
- package/lib/common/utils/index.js.map +1 -1
- package/oclif.lock +149 -149
- package/oclif.manifest.json +898 -898
- package/package.json +3 -3
- package/yarn.lock +149 -149
package/oclif.manifest.json
CHANGED
|
@@ -132,12 +132,13 @@
|
|
|
132
132
|
"clear:cache:hardis"
|
|
133
133
|
]
|
|
134
134
|
},
|
|
135
|
-
"hardis:
|
|
135
|
+
"hardis:auth:login": {
|
|
136
136
|
"aliases": [],
|
|
137
137
|
"args": {},
|
|
138
|
-
"description": "\n## Command Behavior\n\n**
|
|
138
|
+
"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",
|
|
139
139
|
"examples": [
|
|
140
|
-
"$ sf hardis:
|
|
140
|
+
"$ sf hardis:auth:login",
|
|
141
|
+
"CI=true CI_COMMIT_REF_NAME=monitoring_myclient sf hardis:auth:login"
|
|
141
142
|
],
|
|
142
143
|
"flags": {
|
|
143
144
|
"json": {
|
|
@@ -155,20 +156,28 @@
|
|
|
155
156
|
"multiple": false,
|
|
156
157
|
"type": "option"
|
|
157
158
|
},
|
|
158
|
-
"
|
|
159
|
-
"char": "
|
|
160
|
-
"description": "
|
|
161
|
-
"name": "
|
|
162
|
-
"default": "project",
|
|
159
|
+
"instanceurl": {
|
|
160
|
+
"char": "r",
|
|
161
|
+
"description": "URL of org instance",
|
|
162
|
+
"name": "instanceurl",
|
|
163
163
|
"hasDynamicHelp": false,
|
|
164
164
|
"multiple": false,
|
|
165
|
-
"options": [
|
|
166
|
-
"project",
|
|
167
|
-
"branch",
|
|
168
|
-
"user"
|
|
169
|
-
],
|
|
170
165
|
"type": "option"
|
|
171
166
|
},
|
|
167
|
+
"devhub": {
|
|
168
|
+
"char": "h",
|
|
169
|
+
"description": "Also connect associated DevHub",
|
|
170
|
+
"name": "devhub",
|
|
171
|
+
"allowNo": false,
|
|
172
|
+
"type": "boolean"
|
|
173
|
+
},
|
|
174
|
+
"scratchorg": {
|
|
175
|
+
"char": "s",
|
|
176
|
+
"description": "Scratch org",
|
|
177
|
+
"name": "scratchorg",
|
|
178
|
+
"allowNo": false,
|
|
179
|
+
"type": "boolean"
|
|
180
|
+
},
|
|
172
181
|
"debug": {
|
|
173
182
|
"char": "d",
|
|
174
183
|
"description": "Activate debug mode (more logs)",
|
|
@@ -192,39 +201,38 @@
|
|
|
192
201
|
},
|
|
193
202
|
"hasDynamicHelp": false,
|
|
194
203
|
"hiddenAliases": [],
|
|
195
|
-
"id": "hardis:
|
|
204
|
+
"id": "hardis:auth:login",
|
|
196
205
|
"pluginAlias": "sfdx-hardis",
|
|
197
206
|
"pluginName": "sfdx-hardis",
|
|
198
207
|
"pluginType": "core",
|
|
199
208
|
"strict": true,
|
|
200
209
|
"enableJsonFlag": true,
|
|
201
|
-
"title": "
|
|
210
|
+
"title": "Login",
|
|
202
211
|
"requiresProject": false,
|
|
203
212
|
"isESM": true,
|
|
204
213
|
"relativePath": [
|
|
205
214
|
"lib",
|
|
206
215
|
"commands",
|
|
207
216
|
"hardis",
|
|
208
|
-
"
|
|
209
|
-
"
|
|
217
|
+
"auth",
|
|
218
|
+
"login.js"
|
|
210
219
|
],
|
|
211
220
|
"aliasPermutations": [],
|
|
212
221
|
"permutations": [
|
|
213
|
-
"hardis:
|
|
214
|
-
"
|
|
215
|
-
"
|
|
216
|
-
"hardis:
|
|
217
|
-
"
|
|
218
|
-
"
|
|
222
|
+
"hardis:auth:login",
|
|
223
|
+
"auth:hardis:login",
|
|
224
|
+
"auth:login:hardis",
|
|
225
|
+
"hardis:login:auth",
|
|
226
|
+
"login:hardis:auth",
|
|
227
|
+
"login:auth: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": {
|
|
@@ -3035,12 +3035,12 @@
|
|
|
3035
3035
|
"lint:project:hardis"
|
|
3036
3036
|
]
|
|
3037
3037
|
},
|
|
3038
|
-
"hardis:
|
|
3038
|
+
"hardis:scratch:create": {
|
|
3039
3039
|
"aliases": [],
|
|
3040
3040
|
"args": {},
|
|
3041
|
-
"description": "
|
|
3041
|
+
"description": "\n## Command Behavior\n\n**Creates and fully initializes a Salesforce scratch org with complete development environment setup.**\n\nThis command is a comprehensive scratch org provisioning tool that automates the entire process of creating, configuring, and initializing a Salesforce scratch org for development work. It handles everything from basic org creation to advanced configuration including package installation, metadata deployment, and data initialization.\n\nKey functionalities:\n\n- **Intelligent Org Management:** Automatically generates unique scratch org aliases based on username, git branch, and timestamp, with options to reuse existing orgs or force creation of new ones.\n- **Scratch Org Pool Integration:** Supports fetching pre-configured scratch orgs from pools for faster development cycles and CI/CD optimization.\n- **Custom Scratch Definition:** Dynamically builds project-scratch-def.json files with user-specific configurations including email, username patterns, and org shape settings (set variable **SCRATCH_ORG_SHAPE** to use org shapes).\n- **Package Installation:** Automatically installs all configured packages defined in `installedPackages` configuration property.\n- **Metadata Deployment:** Pushes source code and deploys metadata using optimized deployment strategies for scratch org environments.\n- **Permission Set Assignment:** Assigns specified permission sets defined in `initPermissionSets` configuration to the scratch org user.\n- **Apex Script Execution:** Runs custom Apex initialization scripts defined in `scratchOrgInitApexScripts` for org-specific setup.\n- **Data Loading:** Loads initial data using SFDMU data packages from `dataPackages` configuration for realistic development environments.\n- **User Configuration:** Automatically configures the scratch org admin user with proper names, email, country settings, and marketing user permissions.\n- **Password Generation:** Creates and stores secure passwords for easy scratch org access during development.\n- **CI/CD Integration:** Provides specialized handling for continuous integration environments including automated cleanup and pool management.\n- **Error Handling:** Comprehensive error recovery including scratch org cleanup on failure and detailed troubleshooting messages.\n\nThe command configuration can be customized using:\n\n- `config/.sfdx-hardis.yml` file with properties like `installedPackages`, `initPermissionSets`, `scratchOrgInitApexScripts`, and `dataPackages`.\n- Environment variable **SCRATCH_ORG_SHAPE** with shape org id, if you want to use org shapes\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **Configuration Management:** Loads hierarchical configuration from `.sfdx-hardis.yml`, branch-specific, and user-specific configuration files using `getConfig('user')`.\n- **Alias Generation Logic:** Creates intelligent scratch org aliases using username, git branch, timestamp patterns with CI and pool prefixes for different environments.\n- **Scratch Org Definition Building:** Dynamically constructs `project-scratch-def.json` with user email, custom usernames, org shapes, and feature flags like StateAndCountryPicklist and MarketingUser.\n- **Pool Integration:** Implements scratch org pool fetching using `fetchScratchOrg` for rapid org provisioning in development and CI environments.\n- **Salesforce CLI Integration:** Executes `sf org create scratch` commands with proper parameter handling including wait times, duration, and dev hub targeting.\n- **Package Installation Pipeline:** Uses `installPackages` utility to install managed and unmanaged packages with dependency resolution and error handling.\n- **Metadata Deployment:** Leverages `initOrgMetadatas` for optimized source pushing and metadata deployment specific to scratch org environments.\n- **Permission Set Assignment:** Implements `initPermissionSetAssignments` for automated permission set assignment to scratch org users.\n- **Apex Script Execution:** Runs custom Apex initialization scripts using `initApexScripts` for org-specific configuration and setup.\n- **Data Loading Integration:** Uses SFDMU integration through `initOrgData` for comprehensive data loading from configured data packages.\n- **User Management:** Performs SOQL queries and DML operations to configure scratch org users with proper names, emails, country codes, and permission flags.\n- **Authentication Management:** Handles SFDX auth URL generation and storage for CI/CD environments and scratch org pool management.\n- **Error Recovery:** Implements comprehensive error handling with scratch org cleanup, pool management, and detailed error messaging for troubleshooting.\n- **WebSocket Integration:** Provides real-time status updates and file reporting through WebSocket connections for VS Code extension integration.\n</details>\n",
|
|
3042
3042
|
"examples": [
|
|
3043
|
-
"$ sf hardis:
|
|
3043
|
+
"$ sf hardis:scratch:create"
|
|
3044
3044
|
],
|
|
3045
3045
|
"flags": {
|
|
3046
3046
|
"json": {
|
|
@@ -3058,205 +3058,213 @@
|
|
|
3058
3058
|
"multiple": false,
|
|
3059
3059
|
"type": "option"
|
|
3060
3060
|
},
|
|
3061
|
-
"
|
|
3062
|
-
"char": "
|
|
3063
|
-
"description": "
|
|
3064
|
-
"name": "
|
|
3061
|
+
"forcenew": {
|
|
3062
|
+
"char": "n",
|
|
3063
|
+
"description": "If an existing scratch org exists, do not reuse it but create a new one",
|
|
3064
|
+
"name": "forcenew",
|
|
3065
3065
|
"allowNo": false,
|
|
3066
3066
|
"type": "boolean"
|
|
3067
3067
|
},
|
|
3068
|
-
"
|
|
3069
|
-
"description": "
|
|
3070
|
-
"name": "
|
|
3068
|
+
"pool": {
|
|
3069
|
+
"description": "Creates the scratch org for a scratch org pool",
|
|
3070
|
+
"name": "pool",
|
|
3071
3071
|
"allowNo": false,
|
|
3072
3072
|
"type": "boolean"
|
|
3073
3073
|
},
|
|
3074
|
-
"
|
|
3075
|
-
"char": "
|
|
3076
|
-
"description": "
|
|
3077
|
-
"name": "
|
|
3078
|
-
"
|
|
3074
|
+
"debug": {
|
|
3075
|
+
"char": "d",
|
|
3076
|
+
"description": "Activate debug mode (more logs)",
|
|
3077
|
+
"name": "debug",
|
|
3078
|
+
"allowNo": false,
|
|
3079
|
+
"type": "boolean"
|
|
3080
|
+
},
|
|
3081
|
+
"websocket": {
|
|
3082
|
+
"description": "Websocket host:port for VsCode SFDX Hardis UI integration",
|
|
3083
|
+
"name": "websocket",
|
|
3079
3084
|
"hasDynamicHelp": false,
|
|
3080
3085
|
"multiple": false,
|
|
3081
3086
|
"type": "option"
|
|
3082
3087
|
},
|
|
3083
|
-
"
|
|
3084
|
-
"
|
|
3085
|
-
"
|
|
3086
|
-
"
|
|
3087
|
-
"
|
|
3088
|
-
|
|
3089
|
-
|
|
3090
|
-
"
|
|
3091
|
-
"
|
|
3092
|
-
"RunSpecifiedTests",
|
|
3093
|
-
"RunLocalTests",
|
|
3094
|
-
"RunAllTestsInOrg"
|
|
3088
|
+
"skipauth": {
|
|
3089
|
+
"description": "Skip authentication check when a default username is required",
|
|
3090
|
+
"name": "skipauth",
|
|
3091
|
+
"allowNo": false,
|
|
3092
|
+
"type": "boolean"
|
|
3093
|
+
},
|
|
3094
|
+
"target-dev-hub": {
|
|
3095
|
+
"aliases": [
|
|
3096
|
+
"targetdevhubusername"
|
|
3095
3097
|
],
|
|
3098
|
+
"char": "v",
|
|
3099
|
+
"deprecateAliases": true,
|
|
3100
|
+
"name": "target-dev-hub",
|
|
3101
|
+
"noCacheDefault": true,
|
|
3102
|
+
"required": true,
|
|
3103
|
+
"summary": "Username or alias of the Dev Hub org. Not required if the `target-dev-hub` configuration variable is already set.",
|
|
3104
|
+
"hasDynamicHelp": true,
|
|
3105
|
+
"multiple": false,
|
|
3096
3106
|
"type": "option"
|
|
3107
|
+
}
|
|
3108
|
+
},
|
|
3109
|
+
"hasDynamicHelp": true,
|
|
3110
|
+
"hiddenAliases": [],
|
|
3111
|
+
"id": "hardis:scratch:create",
|
|
3112
|
+
"pluginAlias": "sfdx-hardis",
|
|
3113
|
+
"pluginName": "sfdx-hardis",
|
|
3114
|
+
"pluginType": "core",
|
|
3115
|
+
"strict": true,
|
|
3116
|
+
"enableJsonFlag": true,
|
|
3117
|
+
"title": "Create and initialize scratch org",
|
|
3118
|
+
"requiresProject": true,
|
|
3119
|
+
"requiresSfdxPlugins": [
|
|
3120
|
+
"sfdmu"
|
|
3121
|
+
],
|
|
3122
|
+
"isESM": true,
|
|
3123
|
+
"relativePath": [
|
|
3124
|
+
"lib",
|
|
3125
|
+
"commands",
|
|
3126
|
+
"hardis",
|
|
3127
|
+
"scratch",
|
|
3128
|
+
"create.js"
|
|
3129
|
+
],
|
|
3130
|
+
"aliasPermutations": [],
|
|
3131
|
+
"permutations": [
|
|
3132
|
+
"hardis:scratch:create",
|
|
3133
|
+
"scratch:hardis:create",
|
|
3134
|
+
"scratch:create:hardis",
|
|
3135
|
+
"hardis:create:scratch",
|
|
3136
|
+
"create:hardis:scratch",
|
|
3137
|
+
"create:scratch:hardis"
|
|
3138
|
+
]
|
|
3139
|
+
},
|
|
3140
|
+
"hardis:scratch:delete": {
|
|
3141
|
+
"aliases": [],
|
|
3142
|
+
"args": {},
|
|
3143
|
+
"description": "## Command Behavior\n\n**Provides an assisted menu to delete Salesforce scratch orgs associated with a Dev Hub.**\n\nThis command simplifies the process of cleaning up your Salesforce development environments by allowing you to easily select and delete multiple scratch orgs. This is crucial for managing your scratch org limits and ensuring that you don't accumulate unnecessary or expired orgs.\n\nKey functionalities:\n\n- **Interactive Scratch Org Selection:** Displays a list of all active scratch orgs linked to your Dev Hub, including their usernames, instance URLs, and last used dates.\n- **Multi-Selection:** Allows you to select multiple scratch orgs for deletion.\n- **Confirmation Prompt:** Prompts for confirmation before proceeding with the deletion, ensuring that you don't accidentally delete important orgs.\n- **Dev Hub Integration:** Works with your configured Dev Hub to manage scratch orgs.\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **Salesforce CLI Integration:** It executes the `sf org list` command to retrieve a list of all scratch orgs associated with the current Dev Hub. It then filters this list to show only active orgs.\n- **Interactive Prompts:** Uses the `prompts` library to present a multi-select menu of scratch orgs to the user.\n- **Scratch Org Deletion:** For each selected scratch org, it executes the `sf org delete scratch --no-prompt` command to perform the deletion.\n- **Error Handling:** Includes basic error handling for Salesforce CLI commands.\n- **Data Sorting:** Sorts the list of scratch orgs by username, alias, and instance URL for better readability in the interactive menu.\n</details>\n",
|
|
3144
|
+
"examples": [
|
|
3145
|
+
"$ sf hardis:scratch:delete"
|
|
3146
|
+
],
|
|
3147
|
+
"flags": {
|
|
3148
|
+
"json": {
|
|
3149
|
+
"description": "Format output as json.",
|
|
3150
|
+
"helpGroup": "GLOBAL",
|
|
3151
|
+
"name": "json",
|
|
3152
|
+
"allowNo": false,
|
|
3153
|
+
"type": "boolean"
|
|
3097
3154
|
},
|
|
3098
|
-
"
|
|
3099
|
-
"
|
|
3100
|
-
"
|
|
3101
|
-
"
|
|
3102
|
-
"default": [],
|
|
3155
|
+
"flags-dir": {
|
|
3156
|
+
"helpGroup": "GLOBAL",
|
|
3157
|
+
"name": "flags-dir",
|
|
3158
|
+
"summary": "Import flag values from a directory.",
|
|
3103
3159
|
"hasDynamicHelp": false,
|
|
3104
|
-
"multiple":
|
|
3160
|
+
"multiple": false,
|
|
3105
3161
|
"type": "option"
|
|
3106
3162
|
},
|
|
3107
|
-
"
|
|
3108
|
-
"
|
|
3109
|
-
"
|
|
3163
|
+
"debug": {
|
|
3164
|
+
"char": "d",
|
|
3165
|
+
"description": "Activate debug mode (more logs)",
|
|
3166
|
+
"name": "debug",
|
|
3110
3167
|
"allowNo": false,
|
|
3111
3168
|
"type": "boolean"
|
|
3112
3169
|
},
|
|
3113
|
-
"
|
|
3114
|
-
"
|
|
3115
|
-
"
|
|
3116
|
-
"
|
|
3170
|
+
"websocket": {
|
|
3171
|
+
"description": "Websocket host:port for VsCode SFDX Hardis UI integration",
|
|
3172
|
+
"name": "websocket",
|
|
3173
|
+
"hasDynamicHelp": false,
|
|
3174
|
+
"multiple": false,
|
|
3175
|
+
"type": "option"
|
|
3176
|
+
},
|
|
3177
|
+
"skipauth": {
|
|
3178
|
+
"description": "Skip authentication check when a default username is required",
|
|
3179
|
+
"name": "skipauth",
|
|
3117
3180
|
"allowNo": false,
|
|
3118
3181
|
"type": "boolean"
|
|
3119
3182
|
},
|
|
3120
|
-
"
|
|
3121
|
-
"
|
|
3122
|
-
|
|
3123
|
-
"exclusive": [
|
|
3124
|
-
"manifest",
|
|
3125
|
-
"metadata",
|
|
3126
|
-
"sourcepath",
|
|
3127
|
-
"checkonly",
|
|
3128
|
-
"testlevel",
|
|
3129
|
-
"runtests",
|
|
3130
|
-
"ignoreerrors",
|
|
3131
|
-
"ignorewarnings"
|
|
3132
|
-
],
|
|
3133
|
-
"name": "validateddeployrequestid",
|
|
3134
|
-
"hasDynamicHelp": false,
|
|
3135
|
-
"multiple": false,
|
|
3136
|
-
"type": "option"
|
|
3137
|
-
},
|
|
3138
|
-
"verbose": {
|
|
3139
|
-
"description": "verbose",
|
|
3140
|
-
"name": "verbose",
|
|
3141
|
-
"allowNo": false,
|
|
3142
|
-
"type": "boolean"
|
|
3143
|
-
},
|
|
3144
|
-
"metadata": {
|
|
3145
|
-
"char": "m",
|
|
3146
|
-
"description": "metadata",
|
|
3147
|
-
"exclusive": [
|
|
3148
|
-
"manifest",
|
|
3149
|
-
"sourcepath"
|
|
3150
|
-
],
|
|
3151
|
-
"name": "metadata",
|
|
3152
|
-
"hasDynamicHelp": false,
|
|
3153
|
-
"multiple": true,
|
|
3154
|
-
"type": "option"
|
|
3155
|
-
},
|
|
3156
|
-
"sourcepath": {
|
|
3157
|
-
"char": "p",
|
|
3158
|
-
"description": "sourcePath",
|
|
3159
|
-
"exclusive": [
|
|
3160
|
-
"manifest",
|
|
3161
|
-
"metadata"
|
|
3162
|
-
],
|
|
3163
|
-
"name": "sourcepath",
|
|
3164
|
-
"hasDynamicHelp": false,
|
|
3165
|
-
"multiple": true,
|
|
3166
|
-
"type": "option"
|
|
3167
|
-
},
|
|
3168
|
-
"manifest": {
|
|
3169
|
-
"char": "x",
|
|
3170
|
-
"description": "flagsLong.manifest",
|
|
3171
|
-
"exclusive": [
|
|
3172
|
-
"metadata",
|
|
3173
|
-
"sourcepath"
|
|
3174
|
-
],
|
|
3175
|
-
"name": "manifest",
|
|
3176
|
-
"hasDynamicHelp": false,
|
|
3177
|
-
"multiple": false,
|
|
3178
|
-
"type": "option"
|
|
3179
|
-
},
|
|
3180
|
-
"predestructivechanges": {
|
|
3181
|
-
"dependsOn": [
|
|
3182
|
-
"manifest"
|
|
3183
|
-
],
|
|
3184
|
-
"description": "predestructivechanges",
|
|
3185
|
-
"name": "predestructivechanges",
|
|
3186
|
-
"hasDynamicHelp": false,
|
|
3187
|
-
"multiple": false,
|
|
3188
|
-
"type": "option"
|
|
3189
|
-
},
|
|
3190
|
-
"postdestructivechanges": {
|
|
3191
|
-
"dependsOn": [
|
|
3192
|
-
"manifest"
|
|
3183
|
+
"target-dev-hub": {
|
|
3184
|
+
"aliases": [
|
|
3185
|
+
"targetdevhubusername"
|
|
3193
3186
|
],
|
|
3194
|
-
"
|
|
3195
|
-
"
|
|
3196
|
-
"
|
|
3187
|
+
"char": "v",
|
|
3188
|
+
"deprecateAliases": true,
|
|
3189
|
+
"name": "target-dev-hub",
|
|
3190
|
+
"noCacheDefault": true,
|
|
3191
|
+
"required": true,
|
|
3192
|
+
"summary": "Username or alias of the Dev Hub org. Not required if the `target-dev-hub` configuration variable is already set.",
|
|
3193
|
+
"hasDynamicHelp": true,
|
|
3197
3194
|
"multiple": false,
|
|
3198
3195
|
"type": "option"
|
|
3199
|
-
}
|
|
3200
|
-
|
|
3201
|
-
|
|
3202
|
-
|
|
3203
|
-
|
|
3204
|
-
|
|
3205
|
-
|
|
3206
|
-
|
|
3207
|
-
|
|
3208
|
-
|
|
3209
|
-
|
|
3210
|
-
|
|
3211
|
-
|
|
3212
|
-
|
|
3213
|
-
|
|
3214
|
-
|
|
3215
|
-
|
|
3216
|
-
|
|
3217
|
-
|
|
3196
|
+
}
|
|
3197
|
+
},
|
|
3198
|
+
"hasDynamicHelp": true,
|
|
3199
|
+
"hiddenAliases": [],
|
|
3200
|
+
"id": "hardis:scratch:delete",
|
|
3201
|
+
"pluginAlias": "sfdx-hardis",
|
|
3202
|
+
"pluginName": "sfdx-hardis",
|
|
3203
|
+
"pluginType": "core",
|
|
3204
|
+
"strict": true,
|
|
3205
|
+
"enableJsonFlag": true,
|
|
3206
|
+
"title": "Delete scratch orgs(s)",
|
|
3207
|
+
"isESM": true,
|
|
3208
|
+
"relativePath": [
|
|
3209
|
+
"lib",
|
|
3210
|
+
"commands",
|
|
3211
|
+
"hardis",
|
|
3212
|
+
"scratch",
|
|
3213
|
+
"delete.js"
|
|
3214
|
+
],
|
|
3215
|
+
"aliasPermutations": [],
|
|
3216
|
+
"permutations": [
|
|
3217
|
+
"hardis:scratch:delete",
|
|
3218
|
+
"scratch:hardis:delete",
|
|
3219
|
+
"scratch:delete:hardis",
|
|
3220
|
+
"hardis:delete:scratch",
|
|
3221
|
+
"delete:hardis:scratch",
|
|
3222
|
+
"delete:scratch:hardis"
|
|
3223
|
+
]
|
|
3224
|
+
},
|
|
3225
|
+
"hardis:scratch:pull": {
|
|
3226
|
+
"aliases": [],
|
|
3227
|
+
"args": {},
|
|
3228
|
+
"description": "\n## Command Behavior\n\n**Pulls metadata changes from your scratch org or source-tracked sandbox into your local project files.**\n\nThis command is essential for synchronizing your local development environment with the changes you've made directly in your Salesforce org. After pulling, you can then stage and commit the relevant files to your version control system.\n\nKey features and considerations:\n\n- **Underlying Command:** Internally, this command executes `sf project retrieve start` to fetch the metadata.\n- **Error Handling:** If the pull operation encounters errors, it offers to automatically add the problematic items to your `.forceignore` file and then attempts to pull again, helping you resolve conflicts and ignore unwanted metadata.\n- **Missing Updates:** If you don't see certain updated items in the pull results, you might need to manually retrieve them using the Salesforce Extension's **Org Browser** or the **Salesforce CLI** directly. Refer to the [Retrieve Metadatas documentation](https://sfdx-hardis.cloudity.com/salesforce-ci-cd-publish-task/#retrieve-metadatas) for more details.\n- **Automatic Retrieval:** You can configure the `autoRetrieveWhenPull` property in your `.sfdx-hardis.yml` file to always retrieve specific metadata types (e.g., `CustomApplication`) that might not always be detected as updates by `project:retrieve:start`.\n\nExample `.sfdx-hardis.yml` configuration for `autoRetrieveWhenPull`:\n```yaml\nautoRetrieveWhenPull:\n - CustomApplication:MyCustomApplication\n - CustomApplication:MyOtherCustomApplication\n - CustomApplication:MyThirdCustomApp\n```\n\nFor a visual explanation of the process, watch this video:\n\n<iframe width=\"560\" height=\"315\" src=\"https://www.youtube.com/embed/Ik6whtflmfY\" title=\"YouTube video player\" frameborder=\"0\" allow=\"accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture\" allowfullscreen></iframe>\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation focuses on robust metadata synchronization:\n\n- **Salesforce CLI Wrapper:** It acts as a wrapper around the standard Salesforce CLI `sf project retrieve start` command, providing enhanced error handling and configuration options.\n- **Force Source Pull Utility:** The core logic resides in the `forceSourcePull` utility function, which orchestrates the retrieval process, including handling `.forceignore` updates.\n- **Configuration Integration:** It reads the `autoRetrieveWhenPull` setting from the project's `.sfdx-hardis.yml` to determine additional metadata to retrieve automatically.\n- **User Feedback:** Provides clear messages to the user regarding the pull status and guidance for troubleshooting.\n</details>\n",
|
|
3229
|
+
"examples": [
|
|
3230
|
+
"$ sf hardis:scratch:pull"
|
|
3231
|
+
],
|
|
3232
|
+
"flags": {
|
|
3233
|
+
"json": {
|
|
3234
|
+
"description": "Format output as json.",
|
|
3235
|
+
"helpGroup": "GLOBAL",
|
|
3236
|
+
"name": "json",
|
|
3218
3237
|
"allowNo": false,
|
|
3219
3238
|
"type": "boolean"
|
|
3220
3239
|
},
|
|
3221
|
-
"
|
|
3222
|
-
"
|
|
3223
|
-
"name": "
|
|
3240
|
+
"flags-dir": {
|
|
3241
|
+
"helpGroup": "GLOBAL",
|
|
3242
|
+
"name": "flags-dir",
|
|
3243
|
+
"summary": "Import flag values from a directory.",
|
|
3224
3244
|
"hasDynamicHelp": false,
|
|
3225
3245
|
"multiple": false,
|
|
3226
3246
|
"type": "option"
|
|
3227
3247
|
},
|
|
3228
|
-
"coverageformatters": {
|
|
3229
|
-
"description": "coverageformatters",
|
|
3230
|
-
"name": "coverageformatters",
|
|
3231
|
-
"hasDynamicHelp": false,
|
|
3232
|
-
"multiple": true,
|
|
3233
|
-
"type": "option"
|
|
3234
|
-
},
|
|
3235
|
-
"junit": {
|
|
3236
|
-
"description": "junit",
|
|
3237
|
-
"name": "junit",
|
|
3238
|
-
"allowNo": false,
|
|
3239
|
-
"type": "boolean"
|
|
3240
|
-
},
|
|
3241
|
-
"checkcoverage": {
|
|
3242
|
-
"description": "Check Apex org coverage",
|
|
3243
|
-
"name": "checkcoverage",
|
|
3244
|
-
"allowNo": false,
|
|
3245
|
-
"type": "boolean"
|
|
3246
|
-
},
|
|
3247
3248
|
"debug": {
|
|
3248
|
-
"
|
|
3249
|
+
"char": "d",
|
|
3250
|
+
"description": "Activate debug mode (more logs)",
|
|
3249
3251
|
"name": "debug",
|
|
3250
3252
|
"allowNo": false,
|
|
3251
3253
|
"type": "boolean"
|
|
3252
3254
|
},
|
|
3253
3255
|
"websocket": {
|
|
3254
|
-
"description": "
|
|
3256
|
+
"description": "Websocket host:port for VsCode SFDX Hardis UI integration",
|
|
3255
3257
|
"name": "websocket",
|
|
3256
3258
|
"hasDynamicHelp": false,
|
|
3257
3259
|
"multiple": false,
|
|
3258
3260
|
"type": "option"
|
|
3259
3261
|
},
|
|
3262
|
+
"skipauth": {
|
|
3263
|
+
"description": "Skip authentication check when a default username is required",
|
|
3264
|
+
"name": "skipauth",
|
|
3265
|
+
"allowNo": false,
|
|
3266
|
+
"type": "boolean"
|
|
3267
|
+
},
|
|
3260
3268
|
"target-org": {
|
|
3261
3269
|
"aliases": [
|
|
3262
3270
|
"targetusername",
|
|
@@ -3275,35 +3283,39 @@
|
|
|
3275
3283
|
},
|
|
3276
3284
|
"hasDynamicHelp": true,
|
|
3277
3285
|
"hiddenAliases": [],
|
|
3278
|
-
"id": "hardis:
|
|
3286
|
+
"id": "hardis:scratch:pull",
|
|
3279
3287
|
"pluginAlias": "sfdx-hardis",
|
|
3280
3288
|
"pluginName": "sfdx-hardis",
|
|
3281
3289
|
"pluginType": "core",
|
|
3282
3290
|
"strict": true,
|
|
3283
3291
|
"enableJsonFlag": true,
|
|
3292
|
+
"title": "Scratch PULL",
|
|
3284
3293
|
"requiresProject": true,
|
|
3285
3294
|
"isESM": true,
|
|
3286
3295
|
"relativePath": [
|
|
3287
3296
|
"lib",
|
|
3288
3297
|
"commands",
|
|
3289
3298
|
"hardis",
|
|
3290
|
-
"
|
|
3291
|
-
"
|
|
3299
|
+
"scratch",
|
|
3300
|
+
"pull.js"
|
|
3292
3301
|
],
|
|
3293
3302
|
"aliasPermutations": [],
|
|
3294
3303
|
"permutations": [
|
|
3295
|
-
"hardis:
|
|
3296
|
-
"
|
|
3297
|
-
"
|
|
3298
|
-
"hardis:
|
|
3299
|
-
"
|
|
3300
|
-
"
|
|
3304
|
+
"hardis:scratch:pull",
|
|
3305
|
+
"scratch:hardis:pull",
|
|
3306
|
+
"scratch:pull:hardis",
|
|
3307
|
+
"hardis:pull:scratch",
|
|
3308
|
+
"pull:hardis:scratch",
|
|
3309
|
+
"pull:scratch:hardis"
|
|
3301
3310
|
]
|
|
3302
3311
|
},
|
|
3303
|
-
"hardis:
|
|
3312
|
+
"hardis:scratch:push": {
|
|
3304
3313
|
"aliases": [],
|
|
3305
3314
|
"args": {},
|
|
3306
|
-
"description": "
|
|
3315
|
+
"description": "## Command Behavior\n\n**Pushes local Salesforce DX source files to a scratch org or source-tracked sandbox.**\n\nThis command is a fundamental operation in Salesforce DX development, allowing developers to synchronize their local codebase with their development org. It ensures that changes made locally are reflected in the scratch org, enabling testing and validation.\n\nKey functionalities:\n\n- **Source Synchronization:** Deploys all local changes (metadata and code) to the target scratch org.\n- **Underlying Command:** Internally, this command executes `sf project deploy start` to perform the push operation.\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **Salesforce CLI Wrapper:** It acts as a wrapper around the standard Salesforce CLI `sf project deploy start` command.\n- **`forceSourcePush` Utility:** The core logic resides in the `forceSourcePush` utility function, which orchestrates the deployment process.\n- **Connection Handling:** It uses the connection to the target org to perform the push operation.\n</details>\n",
|
|
3316
|
+
"examples": [
|
|
3317
|
+
"$ sf hardis:scratch:push"
|
|
3318
|
+
],
|
|
3307
3319
|
"flags": {
|
|
3308
3320
|
"json": {
|
|
3309
3321
|
"description": "Format output as json.",
|
|
@@ -3320,48 +3332,26 @@
|
|
|
3320
3332
|
"multiple": false,
|
|
3321
3333
|
"type": "option"
|
|
3322
3334
|
},
|
|
3323
|
-
"forceoverwrite": {
|
|
3324
|
-
"char": "f",
|
|
3325
|
-
"description": "forceoverwrite",
|
|
3326
|
-
"name": "forceoverwrite",
|
|
3327
|
-
"allowNo": false,
|
|
3328
|
-
"type": "boolean"
|
|
3329
|
-
},
|
|
3330
|
-
"wait": {
|
|
3331
|
-
"char": "w",
|
|
3332
|
-
"description": "wait",
|
|
3333
|
-
"name": "wait",
|
|
3334
|
-
"default": 60,
|
|
3335
|
-
"hasDynamicHelp": false,
|
|
3336
|
-
"multiple": false,
|
|
3337
|
-
"type": "option"
|
|
3338
|
-
},
|
|
3339
|
-
"ignorewarnings": {
|
|
3340
|
-
"char": "g",
|
|
3341
|
-
"description": "ignorewarnings",
|
|
3342
|
-
"name": "ignorewarnings",
|
|
3343
|
-
"allowNo": false,
|
|
3344
|
-
"type": "boolean"
|
|
3345
|
-
},
|
|
3346
|
-
"quiet": {
|
|
3347
|
-
"description": "quiet",
|
|
3348
|
-
"name": "quiet",
|
|
3349
|
-
"allowNo": false,
|
|
3350
|
-
"type": "boolean"
|
|
3351
|
-
},
|
|
3352
3335
|
"debug": {
|
|
3353
|
-
"
|
|
3336
|
+
"char": "d",
|
|
3337
|
+
"description": "Activate debug mode (more logs)",
|
|
3354
3338
|
"name": "debug",
|
|
3355
3339
|
"allowNo": false,
|
|
3356
3340
|
"type": "boolean"
|
|
3357
3341
|
},
|
|
3358
3342
|
"websocket": {
|
|
3359
|
-
"description": "
|
|
3343
|
+
"description": "Websocket host:port for VsCode SFDX Hardis UI integration",
|
|
3360
3344
|
"name": "websocket",
|
|
3361
3345
|
"hasDynamicHelp": false,
|
|
3362
3346
|
"multiple": false,
|
|
3363
3347
|
"type": "option"
|
|
3364
3348
|
},
|
|
3349
|
+
"skipauth": {
|
|
3350
|
+
"description": "Skip authentication check when a default username is required",
|
|
3351
|
+
"name": "skipauth",
|
|
3352
|
+
"allowNo": false,
|
|
3353
|
+
"type": "boolean"
|
|
3354
|
+
},
|
|
3365
3355
|
"target-org": {
|
|
3366
3356
|
"aliases": [
|
|
3367
3357
|
"targetusername",
|
|
@@ -3380,36 +3370,39 @@
|
|
|
3380
3370
|
},
|
|
3381
3371
|
"hasDynamicHelp": true,
|
|
3382
3372
|
"hiddenAliases": [],
|
|
3383
|
-
"id": "hardis:
|
|
3373
|
+
"id": "hardis:scratch:push",
|
|
3384
3374
|
"pluginAlias": "sfdx-hardis",
|
|
3385
3375
|
"pluginName": "sfdx-hardis",
|
|
3386
3376
|
"pluginType": "core",
|
|
3387
3377
|
"strict": true,
|
|
3388
3378
|
"enableJsonFlag": true,
|
|
3379
|
+
"title": "Scratch PUSH",
|
|
3389
3380
|
"requiresProject": true,
|
|
3390
3381
|
"isESM": true,
|
|
3391
3382
|
"relativePath": [
|
|
3392
3383
|
"lib",
|
|
3393
3384
|
"commands",
|
|
3394
3385
|
"hardis",
|
|
3395
|
-
"
|
|
3386
|
+
"scratch",
|
|
3396
3387
|
"push.js"
|
|
3397
3388
|
],
|
|
3398
3389
|
"aliasPermutations": [],
|
|
3399
3390
|
"permutations": [
|
|
3400
|
-
"hardis:
|
|
3401
|
-
"
|
|
3402
|
-
"
|
|
3403
|
-
"hardis:push:
|
|
3404
|
-
"push:hardis:
|
|
3405
|
-
"push:
|
|
3391
|
+
"hardis:scratch:push",
|
|
3392
|
+
"scratch:hardis:push",
|
|
3393
|
+
"scratch:push:hardis",
|
|
3394
|
+
"hardis:push:scratch",
|
|
3395
|
+
"push:hardis:scratch",
|
|
3396
|
+
"push:scratch:hardis"
|
|
3406
3397
|
]
|
|
3407
3398
|
},
|
|
3408
|
-
"hardis:source:
|
|
3399
|
+
"hardis:source:deploy": {
|
|
3409
3400
|
"aliases": [],
|
|
3410
3401
|
"args": {},
|
|
3411
|
-
"description": "
|
|
3412
|
-
"examples": [
|
|
3402
|
+
"description": "sfdx-hardis wrapper for sfdx force:source:deploy that displays tips to solve deployment errors.\n\nAdditional to the base command wrapper: If using **--checkonly**, add options **--checkcoverage** and **--coverageformatters json-summary** to check that org coverage is > 75% (or value defined in .sfdx-hardis.yml property **apexTestsMinCoverageOrgWide**)\n\n### Deployment results\n\nYou can also have deployment results as pull request comments, on:\n\n- GitHub (see [GitHub Pull Requests comments config](https://sfdx-hardis.cloudity.com/salesforce-ci-cd-setup-integration-github/))\n- Gitlab (see [Gitlab integration configuration](https://sfdx-hardis.cloudity.com/salesforce-ci-cd-setup-integration-gitlab/))\n- Azure DevOps (see [Azure integration configuration](https://sfdx-hardis.cloudity.com/salesforce-ci-cd-setup-integration-azure/))\n\n\n[](https://nicolas.vuillamy.fr/assisted-solving-of-salesforce-deployments-errors-47f3666a9ed0)\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\nNotes:\n\n- You can disable coloring of errors in red by defining env variable SFDX_HARDIS_DEPLOY_ERR_COLORS=false\n\n[See documentation of Salesforce command](https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_force_source.htm#cli_reference_force_source_deploy)\n",
|
|
3403
|
+
"examples": [
|
|
3404
|
+
"$ sf hardis:source:deploy -x manifest/package.xml --wait 60 --ignorewarnings --testlevel RunLocalTests --postdestructivechanges ./manifest/destructiveChanges.xml --target-org nicolas.vuillamy@cloudity.com.sfdxhardis --checkonly --checkcoverage --verbose --coverageformatters json-summary"
|
|
3405
|
+
],
|
|
3413
3406
|
"flags": {
|
|
3414
3407
|
"json": {
|
|
3415
3408
|
"description": "Format output as json.",
|
|
@@ -3426,12 +3419,99 @@
|
|
|
3426
3419
|
"multiple": false,
|
|
3427
3420
|
"type": "option"
|
|
3428
3421
|
},
|
|
3429
|
-
"
|
|
3430
|
-
"char": "
|
|
3431
|
-
"description": "
|
|
3432
|
-
"name": "
|
|
3422
|
+
"checkonly": {
|
|
3423
|
+
"char": "c",
|
|
3424
|
+
"description": "checkonly",
|
|
3425
|
+
"name": "checkonly",
|
|
3426
|
+
"allowNo": false,
|
|
3427
|
+
"type": "boolean"
|
|
3428
|
+
},
|
|
3429
|
+
"soapdeploy": {
|
|
3430
|
+
"description": "soapDeploy",
|
|
3431
|
+
"name": "soapdeploy",
|
|
3432
|
+
"allowNo": false,
|
|
3433
|
+
"type": "boolean"
|
|
3434
|
+
},
|
|
3435
|
+
"wait": {
|
|
3436
|
+
"char": "w",
|
|
3437
|
+
"description": "wait",
|
|
3438
|
+
"name": "wait",
|
|
3439
|
+
"default": 60,
|
|
3440
|
+
"hasDynamicHelp": false,
|
|
3441
|
+
"multiple": false,
|
|
3442
|
+
"type": "option"
|
|
3443
|
+
},
|
|
3444
|
+
"testlevel": {
|
|
3445
|
+
"char": "l",
|
|
3446
|
+
"description": "testlevel",
|
|
3447
|
+
"name": "testlevel",
|
|
3448
|
+
"default": "NoTestRun",
|
|
3433
3449
|
"hasDynamicHelp": false,
|
|
3434
3450
|
"multiple": false,
|
|
3451
|
+
"options": [
|
|
3452
|
+
"NoTestRun",
|
|
3453
|
+
"RunSpecifiedTests",
|
|
3454
|
+
"RunLocalTests",
|
|
3455
|
+
"RunAllTestsInOrg"
|
|
3456
|
+
],
|
|
3457
|
+
"type": "option"
|
|
3458
|
+
},
|
|
3459
|
+
"runtests": {
|
|
3460
|
+
"char": "r",
|
|
3461
|
+
"description": "runTests",
|
|
3462
|
+
"name": "runtests",
|
|
3463
|
+
"default": [],
|
|
3464
|
+
"hasDynamicHelp": false,
|
|
3465
|
+
"multiple": true,
|
|
3466
|
+
"type": "option"
|
|
3467
|
+
},
|
|
3468
|
+
"ignoreerrors": {
|
|
3469
|
+
"description": "ignoreErrors",
|
|
3470
|
+
"name": "ignoreerrors",
|
|
3471
|
+
"allowNo": false,
|
|
3472
|
+
"type": "boolean"
|
|
3473
|
+
},
|
|
3474
|
+
"ignorewarnings": {
|
|
3475
|
+
"char": "g",
|
|
3476
|
+
"description": "ignoreWarnings",
|
|
3477
|
+
"name": "ignorewarnings",
|
|
3478
|
+
"allowNo": false,
|
|
3479
|
+
"type": "boolean"
|
|
3480
|
+
},
|
|
3481
|
+
"validateddeployrequestid": {
|
|
3482
|
+
"char": "q",
|
|
3483
|
+
"description": "validateDeployRequestId",
|
|
3484
|
+
"exclusive": [
|
|
3485
|
+
"manifest",
|
|
3486
|
+
"metadata",
|
|
3487
|
+
"sourcepath",
|
|
3488
|
+
"checkonly",
|
|
3489
|
+
"testlevel",
|
|
3490
|
+
"runtests",
|
|
3491
|
+
"ignoreerrors",
|
|
3492
|
+
"ignorewarnings"
|
|
3493
|
+
],
|
|
3494
|
+
"name": "validateddeployrequestid",
|
|
3495
|
+
"hasDynamicHelp": false,
|
|
3496
|
+
"multiple": false,
|
|
3497
|
+
"type": "option"
|
|
3498
|
+
},
|
|
3499
|
+
"verbose": {
|
|
3500
|
+
"description": "verbose",
|
|
3501
|
+
"name": "verbose",
|
|
3502
|
+
"allowNo": false,
|
|
3503
|
+
"type": "boolean"
|
|
3504
|
+
},
|
|
3505
|
+
"metadata": {
|
|
3506
|
+
"char": "m",
|
|
3507
|
+
"description": "metadata",
|
|
3508
|
+
"exclusive": [
|
|
3509
|
+
"manifest",
|
|
3510
|
+
"sourcepath"
|
|
3511
|
+
],
|
|
3512
|
+
"name": "metadata",
|
|
3513
|
+
"hasDynamicHelp": false,
|
|
3514
|
+
"multiple": true,
|
|
3435
3515
|
"type": "option"
|
|
3436
3516
|
},
|
|
3437
3517
|
"sourcepath": {
|
|
@@ -3446,17 +3526,9 @@
|
|
|
3446
3526
|
"multiple": true,
|
|
3447
3527
|
"type": "option"
|
|
3448
3528
|
},
|
|
3449
|
-
"wait": {
|
|
3450
|
-
"char": "w",
|
|
3451
|
-
"description": "wait",
|
|
3452
|
-
"name": "wait",
|
|
3453
|
-
"hasDynamicHelp": false,
|
|
3454
|
-
"multiple": false,
|
|
3455
|
-
"type": "option"
|
|
3456
|
-
},
|
|
3457
3529
|
"manifest": {
|
|
3458
3530
|
"char": "x",
|
|
3459
|
-
"description": "manifest",
|
|
3531
|
+
"description": "flagsLong.manifest",
|
|
3460
3532
|
"exclusive": [
|
|
3461
3533
|
"metadata",
|
|
3462
3534
|
"sourcepath"
|
|
@@ -3466,29 +3538,33 @@
|
|
|
3466
3538
|
"multiple": false,
|
|
3467
3539
|
"type": "option"
|
|
3468
3540
|
},
|
|
3469
|
-
"
|
|
3470
|
-
"
|
|
3471
|
-
|
|
3472
|
-
"exclusive": [
|
|
3473
|
-
"manifest",
|
|
3474
|
-
"sourcepath"
|
|
3541
|
+
"predestructivechanges": {
|
|
3542
|
+
"dependsOn": [
|
|
3543
|
+
"manifest"
|
|
3475
3544
|
],
|
|
3476
|
-
"
|
|
3545
|
+
"description": "predestructivechanges",
|
|
3546
|
+
"name": "predestructivechanges",
|
|
3477
3547
|
"hasDynamicHelp": false,
|
|
3478
|
-
"multiple":
|
|
3548
|
+
"multiple": false,
|
|
3479
3549
|
"type": "option"
|
|
3480
3550
|
},
|
|
3481
|
-
"
|
|
3482
|
-
"
|
|
3483
|
-
|
|
3484
|
-
|
|
3551
|
+
"postdestructivechanges": {
|
|
3552
|
+
"dependsOn": [
|
|
3553
|
+
"manifest"
|
|
3554
|
+
],
|
|
3555
|
+
"description": "postdestructivechanges",
|
|
3556
|
+
"name": "postdestructivechanges",
|
|
3485
3557
|
"hasDynamicHelp": false,
|
|
3486
|
-
"multiple":
|
|
3558
|
+
"multiple": false,
|
|
3487
3559
|
"type": "option"
|
|
3488
3560
|
},
|
|
3489
3561
|
"tracksource": {
|
|
3490
3562
|
"char": "t",
|
|
3491
3563
|
"description": "tracksource",
|
|
3564
|
+
"exclusive": [
|
|
3565
|
+
"checkonly",
|
|
3566
|
+
"validateddeployrequestid"
|
|
3567
|
+
],
|
|
3492
3568
|
"name": "tracksource",
|
|
3493
3569
|
"allowNo": false,
|
|
3494
3570
|
"type": "boolean"
|
|
@@ -3503,141 +3579,56 @@
|
|
|
3503
3579
|
"allowNo": false,
|
|
3504
3580
|
"type": "boolean"
|
|
3505
3581
|
},
|
|
3506
|
-
"
|
|
3507
|
-
"description": "
|
|
3508
|
-
"name": "
|
|
3509
|
-
"allowNo": false,
|
|
3510
|
-
"type": "boolean"
|
|
3511
|
-
},
|
|
3512
|
-
"debug": {
|
|
3513
|
-
"char": "d",
|
|
3514
|
-
"description": "debugMode",
|
|
3515
|
-
"name": "debug",
|
|
3516
|
-
"allowNo": false,
|
|
3517
|
-
"type": "boolean"
|
|
3518
|
-
},
|
|
3519
|
-
"websocket": {
|
|
3520
|
-
"description": "websocket",
|
|
3521
|
-
"name": "websocket",
|
|
3582
|
+
"resultsdir": {
|
|
3583
|
+
"description": "resultsdir",
|
|
3584
|
+
"name": "resultsdir",
|
|
3522
3585
|
"hasDynamicHelp": false,
|
|
3523
3586
|
"multiple": false,
|
|
3524
3587
|
"type": "option"
|
|
3525
3588
|
},
|
|
3526
|
-
"
|
|
3527
|
-
"description": "
|
|
3528
|
-
"name": "
|
|
3529
|
-
"allowNo": false,
|
|
3530
|
-
"type": "boolean"
|
|
3531
|
-
},
|
|
3532
|
-
"target-org": {
|
|
3533
|
-
"aliases": [
|
|
3534
|
-
"targetusername",
|
|
3535
|
-
"u"
|
|
3536
|
-
],
|
|
3537
|
-
"char": "o",
|
|
3538
|
-
"deprecateAliases": true,
|
|
3539
|
-
"name": "target-org",
|
|
3540
|
-
"noCacheDefault": true,
|
|
3541
|
-
"required": true,
|
|
3542
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
3543
|
-
"hasDynamicHelp": true,
|
|
3544
|
-
"multiple": false,
|
|
3545
|
-
"type": "option"
|
|
3546
|
-
}
|
|
3547
|
-
},
|
|
3548
|
-
"hasDynamicHelp": true,
|
|
3549
|
-
"hiddenAliases": [],
|
|
3550
|
-
"id": "hardis:source:retrieve",
|
|
3551
|
-
"pluginAlias": "sfdx-hardis",
|
|
3552
|
-
"pluginName": "sfdx-hardis",
|
|
3553
|
-
"pluginType": "core",
|
|
3554
|
-
"strict": true,
|
|
3555
|
-
"enableJsonFlag": true,
|
|
3556
|
-
"requiresProject": true,
|
|
3557
|
-
"isESM": true,
|
|
3558
|
-
"relativePath": [
|
|
3559
|
-
"lib",
|
|
3560
|
-
"commands",
|
|
3561
|
-
"hardis",
|
|
3562
|
-
"source",
|
|
3563
|
-
"retrieve.js"
|
|
3564
|
-
],
|
|
3565
|
-
"aliasPermutations": [],
|
|
3566
|
-
"permutations": [
|
|
3567
|
-
"hardis:source:retrieve",
|
|
3568
|
-
"source:hardis:retrieve",
|
|
3569
|
-
"source:retrieve:hardis",
|
|
3570
|
-
"hardis:retrieve:source",
|
|
3571
|
-
"retrieve:hardis:source",
|
|
3572
|
-
"retrieve:source:hardis"
|
|
3573
|
-
]
|
|
3574
|
-
},
|
|
3575
|
-
"hardis:scratch:create": {
|
|
3576
|
-
"aliases": [],
|
|
3577
|
-
"args": {},
|
|
3578
|
-
"description": "\n## Command Behavior\n\n**Creates and fully initializes a Salesforce scratch org with complete development environment setup.**\n\nThis command is a comprehensive scratch org provisioning tool that automates the entire process of creating, configuring, and initializing a Salesforce scratch org for development work. It handles everything from basic org creation to advanced configuration including package installation, metadata deployment, and data initialization.\n\nKey functionalities:\n\n- **Intelligent Org Management:** Automatically generates unique scratch org aliases based on username, git branch, and timestamp, with options to reuse existing orgs or force creation of new ones.\n- **Scratch Org Pool Integration:** Supports fetching pre-configured scratch orgs from pools for faster development cycles and CI/CD optimization.\n- **Custom Scratch Definition:** Dynamically builds project-scratch-def.json files with user-specific configurations including email, username patterns, and org shape settings (set variable **SCRATCH_ORG_SHAPE** to use org shapes).\n- **Package Installation:** Automatically installs all configured packages defined in `installedPackages` configuration property.\n- **Metadata Deployment:** Pushes source code and deploys metadata using optimized deployment strategies for scratch org environments.\n- **Permission Set Assignment:** Assigns specified permission sets defined in `initPermissionSets` configuration to the scratch org user.\n- **Apex Script Execution:** Runs custom Apex initialization scripts defined in `scratchOrgInitApexScripts` for org-specific setup.\n- **Data Loading:** Loads initial data using SFDMU data packages from `dataPackages` configuration for realistic development environments.\n- **User Configuration:** Automatically configures the scratch org admin user with proper names, email, country settings, and marketing user permissions.\n- **Password Generation:** Creates and stores secure passwords for easy scratch org access during development.\n- **CI/CD Integration:** Provides specialized handling for continuous integration environments including automated cleanup and pool management.\n- **Error Handling:** Comprehensive error recovery including scratch org cleanup on failure and detailed troubleshooting messages.\n\nThe command configuration can be customized using:\n\n- `config/.sfdx-hardis.yml` file with properties like `installedPackages`, `initPermissionSets`, `scratchOrgInitApexScripts`, and `dataPackages`.\n- Environment variable **SCRATCH_ORG_SHAPE** with shape org id, if you want to use org shapes\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **Configuration Management:** Loads hierarchical configuration from `.sfdx-hardis.yml`, branch-specific, and user-specific configuration files using `getConfig('user')`.\n- **Alias Generation Logic:** Creates intelligent scratch org aliases using username, git branch, timestamp patterns with CI and pool prefixes for different environments.\n- **Scratch Org Definition Building:** Dynamically constructs `project-scratch-def.json` with user email, custom usernames, org shapes, and feature flags like StateAndCountryPicklist and MarketingUser.\n- **Pool Integration:** Implements scratch org pool fetching using `fetchScratchOrg` for rapid org provisioning in development and CI environments.\n- **Salesforce CLI Integration:** Executes `sf org create scratch` commands with proper parameter handling including wait times, duration, and dev hub targeting.\n- **Package Installation Pipeline:** Uses `installPackages` utility to install managed and unmanaged packages with dependency resolution and error handling.\n- **Metadata Deployment:** Leverages `initOrgMetadatas` for optimized source pushing and metadata deployment specific to scratch org environments.\n- **Permission Set Assignment:** Implements `initPermissionSetAssignments` for automated permission set assignment to scratch org users.\n- **Apex Script Execution:** Runs custom Apex initialization scripts using `initApexScripts` for org-specific configuration and setup.\n- **Data Loading Integration:** Uses SFDMU integration through `initOrgData` for comprehensive data loading from configured data packages.\n- **User Management:** Performs SOQL queries and DML operations to configure scratch org users with proper names, emails, country codes, and permission flags.\n- **Authentication Management:** Handles SFDX auth URL generation and storage for CI/CD environments and scratch org pool management.\n- **Error Recovery:** Implements comprehensive error handling with scratch org cleanup, pool management, and detailed error messaging for troubleshooting.\n- **WebSocket Integration:** Provides real-time status updates and file reporting through WebSocket connections for VS Code extension integration.\n</details>\n",
|
|
3579
|
-
"examples": [
|
|
3580
|
-
"$ sf hardis:scratch:create"
|
|
3581
|
-
],
|
|
3582
|
-
"flags": {
|
|
3583
|
-
"json": {
|
|
3584
|
-
"description": "Format output as json.",
|
|
3585
|
-
"helpGroup": "GLOBAL",
|
|
3586
|
-
"name": "json",
|
|
3587
|
-
"allowNo": false,
|
|
3588
|
-
"type": "boolean"
|
|
3589
|
-
},
|
|
3590
|
-
"flags-dir": {
|
|
3591
|
-
"helpGroup": "GLOBAL",
|
|
3592
|
-
"name": "flags-dir",
|
|
3593
|
-
"summary": "Import flag values from a directory.",
|
|
3589
|
+
"coverageformatters": {
|
|
3590
|
+
"description": "coverageformatters",
|
|
3591
|
+
"name": "coverageformatters",
|
|
3594
3592
|
"hasDynamicHelp": false,
|
|
3595
|
-
"multiple":
|
|
3593
|
+
"multiple": true,
|
|
3596
3594
|
"type": "option"
|
|
3597
3595
|
},
|
|
3598
|
-
"
|
|
3599
|
-
"
|
|
3600
|
-
"
|
|
3601
|
-
"name": "forcenew",
|
|
3596
|
+
"junit": {
|
|
3597
|
+
"description": "junit",
|
|
3598
|
+
"name": "junit",
|
|
3602
3599
|
"allowNo": false,
|
|
3603
3600
|
"type": "boolean"
|
|
3604
3601
|
},
|
|
3605
|
-
"
|
|
3606
|
-
"description": "
|
|
3607
|
-
"name": "
|
|
3602
|
+
"checkcoverage": {
|
|
3603
|
+
"description": "Check Apex org coverage",
|
|
3604
|
+
"name": "checkcoverage",
|
|
3608
3605
|
"allowNo": false,
|
|
3609
3606
|
"type": "boolean"
|
|
3610
3607
|
},
|
|
3611
|
-
"debug": {
|
|
3612
|
-
"
|
|
3613
|
-
"description": "Activate debug mode (more logs)",
|
|
3608
|
+
"debug": {
|
|
3609
|
+
"description": "debug",
|
|
3614
3610
|
"name": "debug",
|
|
3615
3611
|
"allowNo": false,
|
|
3616
3612
|
"type": "boolean"
|
|
3617
3613
|
},
|
|
3618
3614
|
"websocket": {
|
|
3619
|
-
"description": "
|
|
3615
|
+
"description": "websocket",
|
|
3620
3616
|
"name": "websocket",
|
|
3621
3617
|
"hasDynamicHelp": false,
|
|
3622
3618
|
"multiple": false,
|
|
3623
3619
|
"type": "option"
|
|
3624
3620
|
},
|
|
3625
|
-
"
|
|
3626
|
-
"description": "Skip authentication check when a default username is required",
|
|
3627
|
-
"name": "skipauth",
|
|
3628
|
-
"allowNo": false,
|
|
3629
|
-
"type": "boolean"
|
|
3630
|
-
},
|
|
3631
|
-
"target-dev-hub": {
|
|
3621
|
+
"target-org": {
|
|
3632
3622
|
"aliases": [
|
|
3633
|
-
"
|
|
3623
|
+
"targetusername",
|
|
3624
|
+
"u"
|
|
3634
3625
|
],
|
|
3635
|
-
"char": "
|
|
3626
|
+
"char": "o",
|
|
3636
3627
|
"deprecateAliases": true,
|
|
3637
|
-
"name": "target-
|
|
3628
|
+
"name": "target-org",
|
|
3638
3629
|
"noCacheDefault": true,
|
|
3639
3630
|
"required": true,
|
|
3640
|
-
"summary": "Username or alias of the
|
|
3631
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
3641
3632
|
"hasDynamicHelp": true,
|
|
3642
3633
|
"multiple": false,
|
|
3643
3634
|
"type": "option"
|
|
@@ -3645,42 +3636,35 @@
|
|
|
3645
3636
|
},
|
|
3646
3637
|
"hasDynamicHelp": true,
|
|
3647
3638
|
"hiddenAliases": [],
|
|
3648
|
-
"id": "hardis:
|
|
3639
|
+
"id": "hardis:source:deploy",
|
|
3649
3640
|
"pluginAlias": "sfdx-hardis",
|
|
3650
3641
|
"pluginName": "sfdx-hardis",
|
|
3651
3642
|
"pluginType": "core",
|
|
3652
3643
|
"strict": true,
|
|
3653
3644
|
"enableJsonFlag": true,
|
|
3654
|
-
"title": "Create and initialize scratch org",
|
|
3655
3645
|
"requiresProject": true,
|
|
3656
|
-
"requiresSfdxPlugins": [
|
|
3657
|
-
"sfdmu"
|
|
3658
|
-
],
|
|
3659
3646
|
"isESM": true,
|
|
3660
3647
|
"relativePath": [
|
|
3661
3648
|
"lib",
|
|
3662
3649
|
"commands",
|
|
3663
3650
|
"hardis",
|
|
3664
|
-
"
|
|
3665
|
-
"
|
|
3651
|
+
"source",
|
|
3652
|
+
"deploy.js"
|
|
3666
3653
|
],
|
|
3667
3654
|
"aliasPermutations": [],
|
|
3668
3655
|
"permutations": [
|
|
3669
|
-
"hardis:
|
|
3670
|
-
"
|
|
3671
|
-
"
|
|
3672
|
-
"hardis:
|
|
3673
|
-
"
|
|
3674
|
-
"
|
|
3656
|
+
"hardis:source:deploy",
|
|
3657
|
+
"source:hardis:deploy",
|
|
3658
|
+
"source:deploy:hardis",
|
|
3659
|
+
"hardis:deploy:source",
|
|
3660
|
+
"deploy:hardis:source",
|
|
3661
|
+
"deploy:source:hardis"
|
|
3675
3662
|
]
|
|
3676
3663
|
},
|
|
3677
|
-
"hardis:
|
|
3664
|
+
"hardis:source:push": {
|
|
3678
3665
|
"aliases": [],
|
|
3679
3666
|
"args": {},
|
|
3680
|
-
"description": "
|
|
3681
|
-
"examples": [
|
|
3682
|
-
"$ sf hardis:scratch:delete"
|
|
3683
|
-
],
|
|
3667
|
+
"description": "sfdx-hardis wrapper for sfdx force:source:push that displays tips to solve deployment errors.\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_force_source.htm#cli_reference_force_source_push)\n",
|
|
3684
3668
|
"flags": {
|
|
3685
3669
|
"json": {
|
|
3686
3670
|
"description": "Format output as json.",
|
|
@@ -3697,111 +3681,48 @@
|
|
|
3697
3681
|
"multiple": false,
|
|
3698
3682
|
"type": "option"
|
|
3699
3683
|
},
|
|
3700
|
-
"
|
|
3701
|
-
"char": "
|
|
3702
|
-
"description": "
|
|
3703
|
-
"name": "
|
|
3684
|
+
"forceoverwrite": {
|
|
3685
|
+
"char": "f",
|
|
3686
|
+
"description": "forceoverwrite",
|
|
3687
|
+
"name": "forceoverwrite",
|
|
3704
3688
|
"allowNo": false,
|
|
3705
3689
|
"type": "boolean"
|
|
3706
3690
|
},
|
|
3707
|
-
"
|
|
3708
|
-
"
|
|
3709
|
-
"
|
|
3691
|
+
"wait": {
|
|
3692
|
+
"char": "w",
|
|
3693
|
+
"description": "wait",
|
|
3694
|
+
"name": "wait",
|
|
3695
|
+
"default": 60,
|
|
3710
3696
|
"hasDynamicHelp": false,
|
|
3711
3697
|
"multiple": false,
|
|
3712
3698
|
"type": "option"
|
|
3713
3699
|
},
|
|
3714
|
-
"
|
|
3715
|
-
"
|
|
3716
|
-
"
|
|
3700
|
+
"ignorewarnings": {
|
|
3701
|
+
"char": "g",
|
|
3702
|
+
"description": "ignorewarnings",
|
|
3703
|
+
"name": "ignorewarnings",
|
|
3717
3704
|
"allowNo": false,
|
|
3718
3705
|
"type": "boolean"
|
|
3719
3706
|
},
|
|
3720
|
-
"
|
|
3721
|
-
"
|
|
3722
|
-
|
|
3723
|
-
],
|
|
3724
|
-
"char": "v",
|
|
3725
|
-
"deprecateAliases": true,
|
|
3726
|
-
"name": "target-dev-hub",
|
|
3727
|
-
"noCacheDefault": true,
|
|
3728
|
-
"required": true,
|
|
3729
|
-
"summary": "Username or alias of the Dev Hub org. Not required if the `target-dev-hub` configuration variable is already set.",
|
|
3730
|
-
"hasDynamicHelp": true,
|
|
3731
|
-
"multiple": false,
|
|
3732
|
-
"type": "option"
|
|
3733
|
-
}
|
|
3734
|
-
},
|
|
3735
|
-
"hasDynamicHelp": true,
|
|
3736
|
-
"hiddenAliases": [],
|
|
3737
|
-
"id": "hardis:scratch:delete",
|
|
3738
|
-
"pluginAlias": "sfdx-hardis",
|
|
3739
|
-
"pluginName": "sfdx-hardis",
|
|
3740
|
-
"pluginType": "core",
|
|
3741
|
-
"strict": true,
|
|
3742
|
-
"enableJsonFlag": true,
|
|
3743
|
-
"title": "Delete scratch orgs(s)",
|
|
3744
|
-
"isESM": true,
|
|
3745
|
-
"relativePath": [
|
|
3746
|
-
"lib",
|
|
3747
|
-
"commands",
|
|
3748
|
-
"hardis",
|
|
3749
|
-
"scratch",
|
|
3750
|
-
"delete.js"
|
|
3751
|
-
],
|
|
3752
|
-
"aliasPermutations": [],
|
|
3753
|
-
"permutations": [
|
|
3754
|
-
"hardis:scratch:delete",
|
|
3755
|
-
"scratch:hardis:delete",
|
|
3756
|
-
"scratch:delete:hardis",
|
|
3757
|
-
"hardis:delete:scratch",
|
|
3758
|
-
"delete:hardis:scratch",
|
|
3759
|
-
"delete:scratch:hardis"
|
|
3760
|
-
]
|
|
3761
|
-
},
|
|
3762
|
-
"hardis:scratch:pull": {
|
|
3763
|
-
"aliases": [],
|
|
3764
|
-
"args": {},
|
|
3765
|
-
"description": "\n## Command Behavior\n\n**Pulls metadata changes from your scratch org or source-tracked sandbox into your local project files.**\n\nThis command is essential for synchronizing your local development environment with the changes you've made directly in your Salesforce org. After pulling, you can then stage and commit the relevant files to your version control system.\n\nKey features and considerations:\n\n- **Underlying Command:** Internally, this command executes `sf project retrieve start` to fetch the metadata.\n- **Error Handling:** If the pull operation encounters errors, it offers to automatically add the problematic items to your `.forceignore` file and then attempts to pull again, helping you resolve conflicts and ignore unwanted metadata.\n- **Missing Updates:** If you don't see certain updated items in the pull results, you might need to manually retrieve them using the Salesforce Extension's **Org Browser** or the **Salesforce CLI** directly. Refer to the [Retrieve Metadatas documentation](https://sfdx-hardis.cloudity.com/salesforce-ci-cd-publish-task/#retrieve-metadatas) for more details.\n- **Automatic Retrieval:** You can configure the `autoRetrieveWhenPull` property in your `.sfdx-hardis.yml` file to always retrieve specific metadata types (e.g., `CustomApplication`) that might not always be detected as updates by `project:retrieve:start`.\n\nExample `.sfdx-hardis.yml` configuration for `autoRetrieveWhenPull`:\n```yaml\nautoRetrieveWhenPull:\n - CustomApplication:MyCustomApplication\n - CustomApplication:MyOtherCustomApplication\n - CustomApplication:MyThirdCustomApp\n```\n\nFor a visual explanation of the process, watch this video:\n\n<iframe width=\"560\" height=\"315\" src=\"https://www.youtube.com/embed/Ik6whtflmfY\" title=\"YouTube video player\" frameborder=\"0\" allow=\"accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture\" allowfullscreen></iframe>\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation focuses on robust metadata synchronization:\n\n- **Salesforce CLI Wrapper:** It acts as a wrapper around the standard Salesforce CLI `sf project retrieve start` command, providing enhanced error handling and configuration options.\n- **Force Source Pull Utility:** The core logic resides in the `forceSourcePull` utility function, which orchestrates the retrieval process, including handling `.forceignore` updates.\n- **Configuration Integration:** It reads the `autoRetrieveWhenPull` setting from the project's `.sfdx-hardis.yml` to determine additional metadata to retrieve automatically.\n- **User Feedback:** Provides clear messages to the user regarding the pull status and guidance for troubleshooting.\n</details>\n",
|
|
3766
|
-
"examples": [
|
|
3767
|
-
"$ sf hardis:scratch:pull"
|
|
3768
|
-
],
|
|
3769
|
-
"flags": {
|
|
3770
|
-
"json": {
|
|
3771
|
-
"description": "Format output as json.",
|
|
3772
|
-
"helpGroup": "GLOBAL",
|
|
3773
|
-
"name": "json",
|
|
3707
|
+
"quiet": {
|
|
3708
|
+
"description": "quiet",
|
|
3709
|
+
"name": "quiet",
|
|
3774
3710
|
"allowNo": false,
|
|
3775
3711
|
"type": "boolean"
|
|
3776
3712
|
},
|
|
3777
|
-
"flags-dir": {
|
|
3778
|
-
"helpGroup": "GLOBAL",
|
|
3779
|
-
"name": "flags-dir",
|
|
3780
|
-
"summary": "Import flag values from a directory.",
|
|
3781
|
-
"hasDynamicHelp": false,
|
|
3782
|
-
"multiple": false,
|
|
3783
|
-
"type": "option"
|
|
3784
|
-
},
|
|
3785
3713
|
"debug": {
|
|
3786
|
-
"
|
|
3787
|
-
"description": "Activate debug mode (more logs)",
|
|
3714
|
+
"description": "debug",
|
|
3788
3715
|
"name": "debug",
|
|
3789
3716
|
"allowNo": false,
|
|
3790
3717
|
"type": "boolean"
|
|
3791
3718
|
},
|
|
3792
3719
|
"websocket": {
|
|
3793
|
-
"description": "
|
|
3720
|
+
"description": "websocket",
|
|
3794
3721
|
"name": "websocket",
|
|
3795
3722
|
"hasDynamicHelp": false,
|
|
3796
3723
|
"multiple": false,
|
|
3797
3724
|
"type": "option"
|
|
3798
3725
|
},
|
|
3799
|
-
"skipauth": {
|
|
3800
|
-
"description": "Skip authentication check when a default username is required",
|
|
3801
|
-
"name": "skipauth",
|
|
3802
|
-
"allowNo": false,
|
|
3803
|
-
"type": "boolean"
|
|
3804
|
-
},
|
|
3805
3726
|
"target-org": {
|
|
3806
3727
|
"aliases": [
|
|
3807
3728
|
"targetusername",
|
|
@@ -3820,39 +3741,36 @@
|
|
|
3820
3741
|
},
|
|
3821
3742
|
"hasDynamicHelp": true,
|
|
3822
3743
|
"hiddenAliases": [],
|
|
3823
|
-
"id": "hardis:
|
|
3744
|
+
"id": "hardis:source:push",
|
|
3824
3745
|
"pluginAlias": "sfdx-hardis",
|
|
3825
3746
|
"pluginName": "sfdx-hardis",
|
|
3826
3747
|
"pluginType": "core",
|
|
3827
3748
|
"strict": true,
|
|
3828
3749
|
"enableJsonFlag": true,
|
|
3829
|
-
"title": "Scratch PULL",
|
|
3830
3750
|
"requiresProject": true,
|
|
3831
3751
|
"isESM": true,
|
|
3832
3752
|
"relativePath": [
|
|
3833
3753
|
"lib",
|
|
3834
3754
|
"commands",
|
|
3835
3755
|
"hardis",
|
|
3836
|
-
"
|
|
3837
|
-
"
|
|
3756
|
+
"source",
|
|
3757
|
+
"push.js"
|
|
3838
3758
|
],
|
|
3839
3759
|
"aliasPermutations": [],
|
|
3840
3760
|
"permutations": [
|
|
3841
|
-
"hardis:
|
|
3842
|
-
"
|
|
3843
|
-
"
|
|
3844
|
-
"hardis:
|
|
3845
|
-
"
|
|
3846
|
-
"
|
|
3761
|
+
"hardis:source:push",
|
|
3762
|
+
"source:hardis:push",
|
|
3763
|
+
"source:push:hardis",
|
|
3764
|
+
"hardis:push:source",
|
|
3765
|
+
"push:hardis:source",
|
|
3766
|
+
"push:source:hardis"
|
|
3847
3767
|
]
|
|
3848
3768
|
},
|
|
3849
|
-
"hardis:
|
|
3769
|
+
"hardis:source:retrieve": {
|
|
3850
3770
|
"aliases": [],
|
|
3851
3771
|
"args": {},
|
|
3852
|
-
"description": "## Command Behavior\n\n**
|
|
3853
|
-
"examples": [
|
|
3854
|
-
"$ sf hardis:scratch:push"
|
|
3855
|
-
],
|
|
3772
|
+
"description": "\n## Command Behavior\n\n**A wrapper command for Salesforce CLI's `sf project retrieve start` (formerly `sfdx force:source:retrieve`), with enhanced interactive features.**\n\nThis command facilitates the retrieval of metadata from a Salesforce org into your local project. It provides an assisted experience, especially when no specific retrieval constraints are provided.\n\nKey features:\n\n- **Assisted Metadata Selection:** If no `sourcepath`, `manifest`, `metadata`, or `packagenames` flags are specified, an interactive menu will prompt you to select the metadata types you wish to retrieve.\n- **Assisted Org Selection:** If no target org is specified, an interactive menu will guide you to choose an org for the retrieval operation.\n- **Backward Compatibility:** While this command wraps the newer `sf project retrieve start`, it maintains compatibility with the older `sfdx force:source:retrieve` flags.\n\n**Important Note:** The underlying Salesforce CLI command `sfdx force:source:retrieve` is being deprecated by Salesforce in November 2024. It is recommended to migrate to `sf project retrieve start` for future compatibility. See [Salesforce CLI Migration Guide](https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_mig_deploy_retrieve.htm) for more information.\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThis command acts as an intelligent wrapper around the Salesforce CLI's source retrieval functionality:\n\n- **Command Wrapping:** It uses the `wrapSfdxCoreCommand` utility to execute the `sfdx force:source:retrieve` (or its equivalent `sf project retrieve start`) command, passing through all relevant flags and arguments.\n- **Interactive Prompts:** It leverages `MetadataUtils.promptMetadataTypes()` and `promptOrgUsernameDefault()` to provide interactive menus for metadata and org selection when the user does not provide them as flags.\n- **Argument Transformation:** It dynamically constructs the command-line arguments for the underlying Salesforce CLI command based on user selections and provided flags.\n- **Error Handling:** It includes basic error handling, such as prompting the user to re-select an org if an issue occurs during org selection.\n- **Deprecation Warning:** It explicitly logs warnings about the deprecation of `sfdx force:source:retrieve` to inform users about upcoming changes.\n</details>\n",
|
|
3773
|
+
"examples": [],
|
|
3856
3774
|
"flags": {
|
|
3857
3775
|
"json": {
|
|
3858
3776
|
"description": "Format output as json.",
|
|
@@ -3869,15 +3787,98 @@
|
|
|
3869
3787
|
"multiple": false,
|
|
3870
3788
|
"type": "option"
|
|
3871
3789
|
},
|
|
3790
|
+
"apiversion": {
|
|
3791
|
+
"char": "a",
|
|
3792
|
+
"description": "Override the api version used for api requests made by this command",
|
|
3793
|
+
"name": "apiversion",
|
|
3794
|
+
"hasDynamicHelp": false,
|
|
3795
|
+
"multiple": false,
|
|
3796
|
+
"type": "option"
|
|
3797
|
+
},
|
|
3798
|
+
"sourcepath": {
|
|
3799
|
+
"char": "p",
|
|
3800
|
+
"description": "sourcePath",
|
|
3801
|
+
"exclusive": [
|
|
3802
|
+
"manifest",
|
|
3803
|
+
"metadata"
|
|
3804
|
+
],
|
|
3805
|
+
"name": "sourcepath",
|
|
3806
|
+
"hasDynamicHelp": false,
|
|
3807
|
+
"multiple": true,
|
|
3808
|
+
"type": "option"
|
|
3809
|
+
},
|
|
3810
|
+
"wait": {
|
|
3811
|
+
"char": "w",
|
|
3812
|
+
"description": "wait",
|
|
3813
|
+
"name": "wait",
|
|
3814
|
+
"hasDynamicHelp": false,
|
|
3815
|
+
"multiple": false,
|
|
3816
|
+
"type": "option"
|
|
3817
|
+
},
|
|
3818
|
+
"manifest": {
|
|
3819
|
+
"char": "x",
|
|
3820
|
+
"description": "manifest",
|
|
3821
|
+
"exclusive": [
|
|
3822
|
+
"metadata",
|
|
3823
|
+
"sourcepath"
|
|
3824
|
+
],
|
|
3825
|
+
"name": "manifest",
|
|
3826
|
+
"hasDynamicHelp": false,
|
|
3827
|
+
"multiple": false,
|
|
3828
|
+
"type": "option"
|
|
3829
|
+
},
|
|
3830
|
+
"metadata": {
|
|
3831
|
+
"char": "m",
|
|
3832
|
+
"description": "metadata",
|
|
3833
|
+
"exclusive": [
|
|
3834
|
+
"manifest",
|
|
3835
|
+
"sourcepath"
|
|
3836
|
+
],
|
|
3837
|
+
"name": "metadata",
|
|
3838
|
+
"hasDynamicHelp": false,
|
|
3839
|
+
"multiple": true,
|
|
3840
|
+
"type": "option"
|
|
3841
|
+
},
|
|
3842
|
+
"packagenames": {
|
|
3843
|
+
"char": "n",
|
|
3844
|
+
"description": "packagenames",
|
|
3845
|
+
"name": "packagenames",
|
|
3846
|
+
"hasDynamicHelp": false,
|
|
3847
|
+
"multiple": true,
|
|
3848
|
+
"type": "option"
|
|
3849
|
+
},
|
|
3850
|
+
"tracksource": {
|
|
3851
|
+
"char": "t",
|
|
3852
|
+
"description": "tracksource",
|
|
3853
|
+
"name": "tracksource",
|
|
3854
|
+
"allowNo": false,
|
|
3855
|
+
"type": "boolean"
|
|
3856
|
+
},
|
|
3857
|
+
"forceoverwrite": {
|
|
3858
|
+
"char": "f",
|
|
3859
|
+
"dependsOn": [
|
|
3860
|
+
"tracksource"
|
|
3861
|
+
],
|
|
3862
|
+
"description": "forceoverwrite",
|
|
3863
|
+
"name": "forceoverwrite",
|
|
3864
|
+
"allowNo": false,
|
|
3865
|
+
"type": "boolean"
|
|
3866
|
+
},
|
|
3867
|
+
"verbose": {
|
|
3868
|
+
"description": "verbose",
|
|
3869
|
+
"name": "verbose",
|
|
3870
|
+
"allowNo": false,
|
|
3871
|
+
"type": "boolean"
|
|
3872
|
+
},
|
|
3872
3873
|
"debug": {
|
|
3873
3874
|
"char": "d",
|
|
3874
|
-
"description": "
|
|
3875
|
+
"description": "debugMode",
|
|
3875
3876
|
"name": "debug",
|
|
3876
3877
|
"allowNo": false,
|
|
3877
3878
|
"type": "boolean"
|
|
3878
3879
|
},
|
|
3879
3880
|
"websocket": {
|
|
3880
|
-
"description": "
|
|
3881
|
+
"description": "websocket",
|
|
3881
3882
|
"name": "websocket",
|
|
3882
3883
|
"hasDynamicHelp": false,
|
|
3883
3884
|
"multiple": false,
|
|
@@ -3907,30 +3908,29 @@
|
|
|
3907
3908
|
},
|
|
3908
3909
|
"hasDynamicHelp": true,
|
|
3909
3910
|
"hiddenAliases": [],
|
|
3910
|
-
"id": "hardis:
|
|
3911
|
+
"id": "hardis:source:retrieve",
|
|
3911
3912
|
"pluginAlias": "sfdx-hardis",
|
|
3912
3913
|
"pluginName": "sfdx-hardis",
|
|
3913
3914
|
"pluginType": "core",
|
|
3914
3915
|
"strict": true,
|
|
3915
3916
|
"enableJsonFlag": true,
|
|
3916
|
-
"title": "Scratch PUSH",
|
|
3917
3917
|
"requiresProject": true,
|
|
3918
3918
|
"isESM": true,
|
|
3919
3919
|
"relativePath": [
|
|
3920
3920
|
"lib",
|
|
3921
3921
|
"commands",
|
|
3922
3922
|
"hardis",
|
|
3923
|
-
"
|
|
3924
|
-
"
|
|
3923
|
+
"source",
|
|
3924
|
+
"retrieve.js"
|
|
3925
3925
|
],
|
|
3926
3926
|
"aliasPermutations": [],
|
|
3927
3927
|
"permutations": [
|
|
3928
|
-
"hardis:
|
|
3929
|
-
"
|
|
3930
|
-
"
|
|
3931
|
-
"hardis:
|
|
3932
|
-
"
|
|
3933
|
-
"
|
|
3928
|
+
"hardis:source:retrieve",
|
|
3929
|
+
"source:hardis:retrieve",
|
|
3930
|
+
"source:retrieve:hardis",
|
|
3931
|
+
"hardis:retrieve:source",
|
|
3932
|
+
"retrieve:hardis:source",
|
|
3933
|
+
"retrieve:source:hardis"
|
|
3934
3934
|
]
|
|
3935
3935
|
},
|
|
3936
3936
|
"hardis:work:new": {
|
|
@@ -5808,6 +5808,121 @@
|
|
|
5808
5808
|
"import:files:org:hardis"
|
|
5809
5809
|
]
|
|
5810
5810
|
},
|
|
5811
|
+
"hardis:org:fix:listviewmine": {
|
|
5812
|
+
"aliases": [],
|
|
5813
|
+
"args": {},
|
|
5814
|
+
"description": "Fix listviews whose scope Mine has been replaced by Everything\n\n[](https://nicolas.vuillamy.fr/invalid-scope-mine-not-allowed-deploy-your-listviews-anyway-443aceca8ac7)\n\nList of ListViews can be:\n\n- read from .sfdx-hardis.yml file in property **listViewsToSetToMine**\n- sent in argument listviews\n\nNote: property **listViewsToSetToMine** can be auto-generated by command hardis:work:save if .sfdx-hardis.yml contains the following configuration\n\n```yaml\nautoCleanTypes:\n - listViewsMine\n```\n\n- Example of sfdx-hardis.yml property `listViewsToSetToMine`:\n\n```yaml\nlistViewsToSetToMine:\n - \"force-app/main/default/objects/Operation__c/listViews/MyCurrentOperations.listView-meta.xml\"\n - \"force-app/main/default/objects/Operation__c/listViews/MyFinalizedOperations.listView-meta.xml\"\n - \"force-app/main/default/objects/Opportunity/listViews/Default_Opportunity_Pipeline.listView-meta.xml\"\n - \"force-app/main/default/objects/Opportunity/listViews/MyCurrentSubscriptions.listView-meta.xml\"\n - \"force-app/main/default/objects/Opportunity/listViews/MySubscriptions.listView-meta.xml\"\n - \"force-app/main/default/objects/Account/listViews/MyActivePartners.listView-meta.xml\"\n```\n\n- If manually written, this could also be:\n\n```yaml\nlistViewsToSetToMine:\n - \"Operation__c:MyCurrentOperations\"\n - \"Operation__c:MyFinalizedOperations\"\n - \"Opportunity:Default_Opportunity_Pipeline\"\n - \"Opportunity:MyCurrentSubscriptions\"\n - \"Opportunity:MySubscriptions\"\n - \"Account:MyActivePartners\"\n```\n\nTroubleshooting: if you need to run this command from an alpine-linux based docker image, use this workaround in your dockerfile:\n\n```dockerfile\n# Do not use puppeteer embedded chromium\nRUN apk add --update --no-cache chromium\nENV PUPPETEER_SKIP_CHROMIUM_DOWNLOAD=\"true\"\nENV CHROMIUM_PATH=\"/usr/bin/chromium-browser\"\nENV PUPPETEER_EXECUTABLE_PATH=\"$\\{CHROMIUM_PATH}\" // remove \\ before {\n```\n",
|
|
5815
|
+
"examples": [
|
|
5816
|
+
"$ sf hardis:org:fix:listviewmine",
|
|
5817
|
+
"$ sf hardis:org:fix:listviewmine --listviews Opportunity:MySubscriptions,Account:MyActivePartners"
|
|
5818
|
+
],
|
|
5819
|
+
"flags": {
|
|
5820
|
+
"json": {
|
|
5821
|
+
"description": "Format output as json.",
|
|
5822
|
+
"helpGroup": "GLOBAL",
|
|
5823
|
+
"name": "json",
|
|
5824
|
+
"allowNo": false,
|
|
5825
|
+
"type": "boolean"
|
|
5826
|
+
},
|
|
5827
|
+
"flags-dir": {
|
|
5828
|
+
"helpGroup": "GLOBAL",
|
|
5829
|
+
"name": "flags-dir",
|
|
5830
|
+
"summary": "Import flag values from a directory.",
|
|
5831
|
+
"hasDynamicHelp": false,
|
|
5832
|
+
"multiple": false,
|
|
5833
|
+
"type": "option"
|
|
5834
|
+
},
|
|
5835
|
+
"listviews": {
|
|
5836
|
+
"char": "l",
|
|
5837
|
+
"description": "Comma-separated list of listviews following format Object:ListViewName\nExample: Contact:MyContacts,Contact:MyActiveContacts,Opportunity:MYClosedOpportunities",
|
|
5838
|
+
"name": "listviews",
|
|
5839
|
+
"hasDynamicHelp": false,
|
|
5840
|
+
"multiple": false,
|
|
5841
|
+
"type": "option"
|
|
5842
|
+
},
|
|
5843
|
+
"debug": {
|
|
5844
|
+
"char": "d",
|
|
5845
|
+
"description": "Activate debug mode (more logs)",
|
|
5846
|
+
"name": "debug",
|
|
5847
|
+
"allowNo": false,
|
|
5848
|
+
"type": "boolean"
|
|
5849
|
+
},
|
|
5850
|
+
"websocket": {
|
|
5851
|
+
"description": "Websocket host:port for VsCode SFDX Hardis UI integration",
|
|
5852
|
+
"name": "websocket",
|
|
5853
|
+
"hasDynamicHelp": false,
|
|
5854
|
+
"multiple": false,
|
|
5855
|
+
"type": "option"
|
|
5856
|
+
},
|
|
5857
|
+
"skipauth": {
|
|
5858
|
+
"description": "Skip authentication check when a default username is required",
|
|
5859
|
+
"name": "skipauth",
|
|
5860
|
+
"allowNo": false,
|
|
5861
|
+
"type": "boolean"
|
|
5862
|
+
},
|
|
5863
|
+
"target-org": {
|
|
5864
|
+
"aliases": [
|
|
5865
|
+
"targetusername",
|
|
5866
|
+
"u"
|
|
5867
|
+
],
|
|
5868
|
+
"char": "o",
|
|
5869
|
+
"deprecateAliases": true,
|
|
5870
|
+
"name": "target-org",
|
|
5871
|
+
"noCacheDefault": true,
|
|
5872
|
+
"required": true,
|
|
5873
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
5874
|
+
"hasDynamicHelp": true,
|
|
5875
|
+
"multiple": false,
|
|
5876
|
+
"type": "option"
|
|
5877
|
+
}
|
|
5878
|
+
},
|
|
5879
|
+
"hasDynamicHelp": true,
|
|
5880
|
+
"hiddenAliases": [],
|
|
5881
|
+
"id": "hardis:org:fix:listviewmine",
|
|
5882
|
+
"pluginAlias": "sfdx-hardis",
|
|
5883
|
+
"pluginName": "sfdx-hardis",
|
|
5884
|
+
"pluginType": "core",
|
|
5885
|
+
"strict": true,
|
|
5886
|
+
"enableJsonFlag": true,
|
|
5887
|
+
"title": "Fix listviews with ",
|
|
5888
|
+
"requiresProject": true,
|
|
5889
|
+
"isESM": true,
|
|
5890
|
+
"relativePath": [
|
|
5891
|
+
"lib",
|
|
5892
|
+
"commands",
|
|
5893
|
+
"hardis",
|
|
5894
|
+
"org",
|
|
5895
|
+
"fix",
|
|
5896
|
+
"listviewmine.js"
|
|
5897
|
+
],
|
|
5898
|
+
"aliasPermutations": [],
|
|
5899
|
+
"permutations": [
|
|
5900
|
+
"hardis:org:fix:listviewmine",
|
|
5901
|
+
"org:hardis:fix:listviewmine",
|
|
5902
|
+
"org:fix:hardis:listviewmine",
|
|
5903
|
+
"org:fix:listviewmine:hardis",
|
|
5904
|
+
"hardis:fix:org:listviewmine",
|
|
5905
|
+
"fix:hardis:org:listviewmine",
|
|
5906
|
+
"fix:org:hardis:listviewmine",
|
|
5907
|
+
"fix:org:listviewmine:hardis",
|
|
5908
|
+
"hardis:fix:listviewmine:org",
|
|
5909
|
+
"fix:hardis:listviewmine:org",
|
|
5910
|
+
"fix:listviewmine:hardis:org",
|
|
5911
|
+
"fix:listviewmine:org:hardis",
|
|
5912
|
+
"hardis:org:listviewmine:fix",
|
|
5913
|
+
"org:hardis:listviewmine:fix",
|
|
5914
|
+
"org:listviewmine:hardis:fix",
|
|
5915
|
+
"org:listviewmine:fix:hardis",
|
|
5916
|
+
"hardis:listviewmine:org:fix",
|
|
5917
|
+
"listviewmine:hardis:org:fix",
|
|
5918
|
+
"listviewmine:org:hardis:fix",
|
|
5919
|
+
"listviewmine:org:fix:hardis",
|
|
5920
|
+
"hardis:listviewmine:fix:org",
|
|
5921
|
+
"listviewmine:hardis:fix:org",
|
|
5922
|
+
"listviewmine:fix:hardis:org",
|
|
5923
|
+
"listviewmine:fix:org:hardis"
|
|
5924
|
+
]
|
|
5925
|
+
},
|
|
5811
5926
|
"hardis:org:diagnose:audittrail": {
|
|
5812
5927
|
"aliases": [],
|
|
5813
5928
|
"args": {},
|
|
@@ -7206,121 +7321,6 @@
|
|
|
7206
7321
|
"unusedusers:diagnose:org:hardis"
|
|
7207
7322
|
]
|
|
7208
7323
|
},
|
|
7209
|
-
"hardis:org:fix:listviewmine": {
|
|
7210
|
-
"aliases": [],
|
|
7211
|
-
"args": {},
|
|
7212
|
-
"description": "Fix listviews whose scope Mine has been replaced by Everything\n\n[](https://nicolas.vuillamy.fr/invalid-scope-mine-not-allowed-deploy-your-listviews-anyway-443aceca8ac7)\n\nList of ListViews can be:\n\n- read from .sfdx-hardis.yml file in property **listViewsToSetToMine**\n- sent in argument listviews\n\nNote: property **listViewsToSetToMine** can be auto-generated by command hardis:work:save if .sfdx-hardis.yml contains the following configuration\n\n```yaml\nautoCleanTypes:\n - listViewsMine\n```\n\n- Example of sfdx-hardis.yml property `listViewsToSetToMine`:\n\n```yaml\nlistViewsToSetToMine:\n - \"force-app/main/default/objects/Operation__c/listViews/MyCurrentOperations.listView-meta.xml\"\n - \"force-app/main/default/objects/Operation__c/listViews/MyFinalizedOperations.listView-meta.xml\"\n - \"force-app/main/default/objects/Opportunity/listViews/Default_Opportunity_Pipeline.listView-meta.xml\"\n - \"force-app/main/default/objects/Opportunity/listViews/MyCurrentSubscriptions.listView-meta.xml\"\n - \"force-app/main/default/objects/Opportunity/listViews/MySubscriptions.listView-meta.xml\"\n - \"force-app/main/default/objects/Account/listViews/MyActivePartners.listView-meta.xml\"\n```\n\n- If manually written, this could also be:\n\n```yaml\nlistViewsToSetToMine:\n - \"Operation__c:MyCurrentOperations\"\n - \"Operation__c:MyFinalizedOperations\"\n - \"Opportunity:Default_Opportunity_Pipeline\"\n - \"Opportunity:MyCurrentSubscriptions\"\n - \"Opportunity:MySubscriptions\"\n - \"Account:MyActivePartners\"\n```\n\nTroubleshooting: if you need to run this command from an alpine-linux based docker image, use this workaround in your dockerfile:\n\n```dockerfile\n# Do not use puppeteer embedded chromium\nRUN apk add --update --no-cache chromium\nENV PUPPETEER_SKIP_CHROMIUM_DOWNLOAD=\"true\"\nENV CHROMIUM_PATH=\"/usr/bin/chromium-browser\"\nENV PUPPETEER_EXECUTABLE_PATH=\"$\\{CHROMIUM_PATH}\" // remove \\ before {\n```\n",
|
|
7213
|
-
"examples": [
|
|
7214
|
-
"$ sf hardis:org:fix:listviewmine",
|
|
7215
|
-
"$ sf hardis:org:fix:listviewmine --listviews Opportunity:MySubscriptions,Account:MyActivePartners"
|
|
7216
|
-
],
|
|
7217
|
-
"flags": {
|
|
7218
|
-
"json": {
|
|
7219
|
-
"description": "Format output as json.",
|
|
7220
|
-
"helpGroup": "GLOBAL",
|
|
7221
|
-
"name": "json",
|
|
7222
|
-
"allowNo": false,
|
|
7223
|
-
"type": "boolean"
|
|
7224
|
-
},
|
|
7225
|
-
"flags-dir": {
|
|
7226
|
-
"helpGroup": "GLOBAL",
|
|
7227
|
-
"name": "flags-dir",
|
|
7228
|
-
"summary": "Import flag values from a directory.",
|
|
7229
|
-
"hasDynamicHelp": false,
|
|
7230
|
-
"multiple": false,
|
|
7231
|
-
"type": "option"
|
|
7232
|
-
},
|
|
7233
|
-
"listviews": {
|
|
7234
|
-
"char": "l",
|
|
7235
|
-
"description": "Comma-separated list of listviews following format Object:ListViewName\nExample: Contact:MyContacts,Contact:MyActiveContacts,Opportunity:MYClosedOpportunities",
|
|
7236
|
-
"name": "listviews",
|
|
7237
|
-
"hasDynamicHelp": false,
|
|
7238
|
-
"multiple": false,
|
|
7239
|
-
"type": "option"
|
|
7240
|
-
},
|
|
7241
|
-
"debug": {
|
|
7242
|
-
"char": "d",
|
|
7243
|
-
"description": "Activate debug mode (more logs)",
|
|
7244
|
-
"name": "debug",
|
|
7245
|
-
"allowNo": false,
|
|
7246
|
-
"type": "boolean"
|
|
7247
|
-
},
|
|
7248
|
-
"websocket": {
|
|
7249
|
-
"description": "Websocket host:port for VsCode SFDX Hardis UI integration",
|
|
7250
|
-
"name": "websocket",
|
|
7251
|
-
"hasDynamicHelp": false,
|
|
7252
|
-
"multiple": false,
|
|
7253
|
-
"type": "option"
|
|
7254
|
-
},
|
|
7255
|
-
"skipauth": {
|
|
7256
|
-
"description": "Skip authentication check when a default username is required",
|
|
7257
|
-
"name": "skipauth",
|
|
7258
|
-
"allowNo": false,
|
|
7259
|
-
"type": "boolean"
|
|
7260
|
-
},
|
|
7261
|
-
"target-org": {
|
|
7262
|
-
"aliases": [
|
|
7263
|
-
"targetusername",
|
|
7264
|
-
"u"
|
|
7265
|
-
],
|
|
7266
|
-
"char": "o",
|
|
7267
|
-
"deprecateAliases": true,
|
|
7268
|
-
"name": "target-org",
|
|
7269
|
-
"noCacheDefault": true,
|
|
7270
|
-
"required": true,
|
|
7271
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
7272
|
-
"hasDynamicHelp": true,
|
|
7273
|
-
"multiple": false,
|
|
7274
|
-
"type": "option"
|
|
7275
|
-
}
|
|
7276
|
-
},
|
|
7277
|
-
"hasDynamicHelp": true,
|
|
7278
|
-
"hiddenAliases": [],
|
|
7279
|
-
"id": "hardis:org:fix:listviewmine",
|
|
7280
|
-
"pluginAlias": "sfdx-hardis",
|
|
7281
|
-
"pluginName": "sfdx-hardis",
|
|
7282
|
-
"pluginType": "core",
|
|
7283
|
-
"strict": true,
|
|
7284
|
-
"enableJsonFlag": true,
|
|
7285
|
-
"title": "Fix listviews with ",
|
|
7286
|
-
"requiresProject": true,
|
|
7287
|
-
"isESM": true,
|
|
7288
|
-
"relativePath": [
|
|
7289
|
-
"lib",
|
|
7290
|
-
"commands",
|
|
7291
|
-
"hardis",
|
|
7292
|
-
"org",
|
|
7293
|
-
"fix",
|
|
7294
|
-
"listviewmine.js"
|
|
7295
|
-
],
|
|
7296
|
-
"aliasPermutations": [],
|
|
7297
|
-
"permutations": [
|
|
7298
|
-
"hardis:org:fix:listviewmine",
|
|
7299
|
-
"org:hardis:fix:listviewmine",
|
|
7300
|
-
"org:fix:hardis:listviewmine",
|
|
7301
|
-
"org:fix:listviewmine:hardis",
|
|
7302
|
-
"hardis:fix:org:listviewmine",
|
|
7303
|
-
"fix:hardis:org:listviewmine",
|
|
7304
|
-
"fix:org:hardis:listviewmine",
|
|
7305
|
-
"fix:org:listviewmine:hardis",
|
|
7306
|
-
"hardis:fix:listviewmine:org",
|
|
7307
|
-
"fix:hardis:listviewmine:org",
|
|
7308
|
-
"fix:listviewmine:hardis:org",
|
|
7309
|
-
"fix:listviewmine:org:hardis",
|
|
7310
|
-
"hardis:org:listviewmine:fix",
|
|
7311
|
-
"org:hardis:listviewmine:fix",
|
|
7312
|
-
"org:listviewmine:hardis:fix",
|
|
7313
|
-
"org:listviewmine:fix:hardis",
|
|
7314
|
-
"hardis:listviewmine:org:fix",
|
|
7315
|
-
"listviewmine:hardis:org:fix",
|
|
7316
|
-
"listviewmine:org:hardis:fix",
|
|
7317
|
-
"listviewmine:org:fix:hardis",
|
|
7318
|
-
"hardis:listviewmine:fix:org",
|
|
7319
|
-
"listviewmine:hardis:fix:org",
|
|
7320
|
-
"listviewmine:fix:hardis:org",
|
|
7321
|
-
"listviewmine:fix:org:hardis"
|
|
7322
|
-
]
|
|
7323
|
-
},
|
|
7324
7324
|
"hardis:org:generate:packagexmlfull": {
|
|
7325
7325
|
"aliases": [],
|
|
7326
7326
|
"args": {},
|
|
@@ -11714,262 +11714,47 @@
|
|
|
11714
11714
|
"hiddenAliases": [],
|
|
11715
11715
|
"id": "hardis:project:clean:xml",
|
|
11716
11716
|
"pluginAlias": "sfdx-hardis",
|
|
11717
|
-
"pluginName": "sfdx-hardis",
|
|
11718
|
-
"pluginType": "core",
|
|
11719
|
-
"strict": true,
|
|
11720
|
-
"enableJsonFlag": true,
|
|
11721
|
-
"title": "Clean retrieved empty items in dx sources",
|
|
11722
|
-
"requiresProject": true,
|
|
11723
|
-
"isESM": true,
|
|
11724
|
-
"relativePath": [
|
|
11725
|
-
"lib",
|
|
11726
|
-
"commands",
|
|
11727
|
-
"hardis",
|
|
11728
|
-
"project",
|
|
11729
|
-
"clean",
|
|
11730
|
-
"xml.js"
|
|
11731
|
-
],
|
|
11732
|
-
"aliasPermutations": [],
|
|
11733
|
-
"permutations": [
|
|
11734
|
-
"hardis:project:clean:xml",
|
|
11735
|
-
"project:hardis:clean:xml",
|
|
11736
|
-
"project:clean:hardis:xml",
|
|
11737
|
-
"project:clean:xml:hardis",
|
|
11738
|
-
"hardis:clean:project:xml",
|
|
11739
|
-
"clean:hardis:project:xml",
|
|
11740
|
-
"clean:project:hardis:xml",
|
|
11741
|
-
"clean:project:xml:hardis",
|
|
11742
|
-
"hardis:clean:xml:project",
|
|
11743
|
-
"clean:hardis:xml:project",
|
|
11744
|
-
"clean:xml:hardis:project",
|
|
11745
|
-
"clean:xml:project:hardis",
|
|
11746
|
-
"hardis:project:xml:clean",
|
|
11747
|
-
"project:hardis:xml:clean",
|
|
11748
|
-
"project:xml:hardis:clean",
|
|
11749
|
-
"project:xml:clean:hardis",
|
|
11750
|
-
"hardis:xml:project:clean",
|
|
11751
|
-
"xml:hardis:project:clean",
|
|
11752
|
-
"xml:project:hardis:clean",
|
|
11753
|
-
"xml:project:clean:hardis",
|
|
11754
|
-
"hardis:xml:clean:project",
|
|
11755
|
-
"xml:hardis:clean:project",
|
|
11756
|
-
"xml:clean:hardis:project",
|
|
11757
|
-
"xml:clean:project:hardis"
|
|
11758
|
-
]
|
|
11759
|
-
},
|
|
11760
|
-
"hardis:project:fix:profiletabs": {
|
|
11761
|
-
"aliases": [],
|
|
11762
|
-
"args": {},
|
|
11763
|
-
"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",
|
|
11764
|
-
"examples": [
|
|
11765
|
-
"$ sf hardis:project:fix:profiletabs"
|
|
11766
|
-
],
|
|
11767
|
-
"flags": {
|
|
11768
|
-
"json": {
|
|
11769
|
-
"description": "Format output as json.",
|
|
11770
|
-
"helpGroup": "GLOBAL",
|
|
11771
|
-
"name": "json",
|
|
11772
|
-
"allowNo": false,
|
|
11773
|
-
"type": "boolean"
|
|
11774
|
-
},
|
|
11775
|
-
"flags-dir": {
|
|
11776
|
-
"helpGroup": "GLOBAL",
|
|
11777
|
-
"name": "flags-dir",
|
|
11778
|
-
"summary": "Import flag values from a directory.",
|
|
11779
|
-
"hasDynamicHelp": false,
|
|
11780
|
-
"multiple": false,
|
|
11781
|
-
"type": "option"
|
|
11782
|
-
},
|
|
11783
|
-
"path": {
|
|
11784
|
-
"char": "p",
|
|
11785
|
-
"description": "Root folder",
|
|
11786
|
-
"name": "path",
|
|
11787
|
-
"default": "/home/runner/work/sfdx-hardis/sfdx-hardis",
|
|
11788
|
-
"hasDynamicHelp": false,
|
|
11789
|
-
"multiple": false,
|
|
11790
|
-
"type": "option"
|
|
11791
|
-
},
|
|
11792
|
-
"debug": {
|
|
11793
|
-
"char": "d",
|
|
11794
|
-
"description": "Activate debug mode (more logs)",
|
|
11795
|
-
"name": "debug",
|
|
11796
|
-
"allowNo": false,
|
|
11797
|
-
"type": "boolean"
|
|
11798
|
-
},
|
|
11799
|
-
"websocket": {
|
|
11800
|
-
"description": "Websocket host:port for VsCode SFDX Hardis UI integration",
|
|
11801
|
-
"name": "websocket",
|
|
11802
|
-
"hasDynamicHelp": false,
|
|
11803
|
-
"multiple": false,
|
|
11804
|
-
"type": "option"
|
|
11805
|
-
},
|
|
11806
|
-
"skipauth": {
|
|
11807
|
-
"description": "Skip authentication check when a default username is required",
|
|
11808
|
-
"name": "skipauth",
|
|
11809
|
-
"allowNo": false,
|
|
11810
|
-
"type": "boolean"
|
|
11811
|
-
},
|
|
11812
|
-
"target-org": {
|
|
11813
|
-
"aliases": [
|
|
11814
|
-
"targetusername",
|
|
11815
|
-
"u"
|
|
11816
|
-
],
|
|
11817
|
-
"char": "o",
|
|
11818
|
-
"deprecateAliases": true,
|
|
11819
|
-
"name": "target-org",
|
|
11820
|
-
"noCacheDefault": true,
|
|
11821
|
-
"required": true,
|
|
11822
|
-
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
11823
|
-
"hasDynamicHelp": true,
|
|
11824
|
-
"multiple": false,
|
|
11825
|
-
"type": "option"
|
|
11826
|
-
}
|
|
11827
|
-
},
|
|
11828
|
-
"hasDynamicHelp": true,
|
|
11829
|
-
"hiddenAliases": [],
|
|
11830
|
-
"id": "hardis:project:fix:profiletabs",
|
|
11831
|
-
"pluginAlias": "sfdx-hardis",
|
|
11832
|
-
"pluginName": "sfdx-hardis",
|
|
11833
|
-
"pluginType": "core",
|
|
11834
|
-
"strict": true,
|
|
11835
|
-
"enableJsonFlag": true,
|
|
11836
|
-
"title": "Fix profiles to add tabs that are not retrieved by SF CLI",
|
|
11837
|
-
"requiresProject": true,
|
|
11838
|
-
"isESM": true,
|
|
11839
|
-
"relativePath": [
|
|
11840
|
-
"lib",
|
|
11841
|
-
"commands",
|
|
11842
|
-
"hardis",
|
|
11843
|
-
"project",
|
|
11844
|
-
"fix",
|
|
11845
|
-
"profiletabs.js"
|
|
11846
|
-
],
|
|
11847
|
-
"aliasPermutations": [],
|
|
11848
|
-
"permutations": [
|
|
11849
|
-
"hardis:project:fix:profiletabs",
|
|
11850
|
-
"project:hardis:fix:profiletabs",
|
|
11851
|
-
"project:fix:hardis:profiletabs",
|
|
11852
|
-
"project:fix:profiletabs:hardis",
|
|
11853
|
-
"hardis:fix:project:profiletabs",
|
|
11854
|
-
"fix:hardis:project:profiletabs",
|
|
11855
|
-
"fix:project:hardis:profiletabs",
|
|
11856
|
-
"fix:project:profiletabs:hardis",
|
|
11857
|
-
"hardis:fix:profiletabs:project",
|
|
11858
|
-
"fix:hardis:profiletabs:project",
|
|
11859
|
-
"fix:profiletabs:hardis:project",
|
|
11860
|
-
"fix:profiletabs:project:hardis",
|
|
11861
|
-
"hardis:project:profiletabs:fix",
|
|
11862
|
-
"project:hardis:profiletabs:fix",
|
|
11863
|
-
"project:profiletabs:hardis:fix",
|
|
11864
|
-
"project:profiletabs:fix:hardis",
|
|
11865
|
-
"hardis:profiletabs:project:fix",
|
|
11866
|
-
"profiletabs:hardis:project:fix",
|
|
11867
|
-
"profiletabs:project:hardis:fix",
|
|
11868
|
-
"profiletabs:project:fix:hardis",
|
|
11869
|
-
"hardis:profiletabs:fix:project",
|
|
11870
|
-
"profiletabs:hardis:fix:project",
|
|
11871
|
-
"profiletabs:fix:hardis:project",
|
|
11872
|
-
"profiletabs:fix:project:hardis"
|
|
11873
|
-
]
|
|
11874
|
-
},
|
|
11875
|
-
"hardis:project:fix:v53flexipages": {
|
|
11876
|
-
"aliases": [],
|
|
11877
|
-
"args": {},
|
|
11878
|
-
"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",
|
|
11879
|
-
"examples": [
|
|
11880
|
-
"$ sf hardis:project:fix:v53flexipages"
|
|
11881
|
-
],
|
|
11882
|
-
"flags": {
|
|
11883
|
-
"json": {
|
|
11884
|
-
"description": "Format output as json.",
|
|
11885
|
-
"helpGroup": "GLOBAL",
|
|
11886
|
-
"name": "json",
|
|
11887
|
-
"allowNo": false,
|
|
11888
|
-
"type": "boolean"
|
|
11889
|
-
},
|
|
11890
|
-
"flags-dir": {
|
|
11891
|
-
"helpGroup": "GLOBAL",
|
|
11892
|
-
"name": "flags-dir",
|
|
11893
|
-
"summary": "Import flag values from a directory.",
|
|
11894
|
-
"hasDynamicHelp": false,
|
|
11895
|
-
"multiple": false,
|
|
11896
|
-
"type": "option"
|
|
11897
|
-
},
|
|
11898
|
-
"path": {
|
|
11899
|
-
"char": "p",
|
|
11900
|
-
"description": "Root folder",
|
|
11901
|
-
"name": "path",
|
|
11902
|
-
"default": "/home/runner/work/sfdx-hardis/sfdx-hardis",
|
|
11903
|
-
"hasDynamicHelp": false,
|
|
11904
|
-
"multiple": false,
|
|
11905
|
-
"type": "option"
|
|
11906
|
-
},
|
|
11907
|
-
"debug": {
|
|
11908
|
-
"char": "d",
|
|
11909
|
-
"description": "Activate debug mode (more logs)",
|
|
11910
|
-
"name": "debug",
|
|
11911
|
-
"allowNo": false,
|
|
11912
|
-
"type": "boolean"
|
|
11913
|
-
},
|
|
11914
|
-
"websocket": {
|
|
11915
|
-
"description": "Websocket host:port for VsCode SFDX Hardis UI integration",
|
|
11916
|
-
"name": "websocket",
|
|
11917
|
-
"hasDynamicHelp": false,
|
|
11918
|
-
"multiple": false,
|
|
11919
|
-
"type": "option"
|
|
11920
|
-
},
|
|
11921
|
-
"skipauth": {
|
|
11922
|
-
"description": "Skip authentication check when a default username is required",
|
|
11923
|
-
"name": "skipauth",
|
|
11924
|
-
"allowNo": false,
|
|
11925
|
-
"type": "boolean"
|
|
11926
|
-
}
|
|
11927
|
-
},
|
|
11928
|
-
"hasDynamicHelp": false,
|
|
11929
|
-
"hiddenAliases": [],
|
|
11930
|
-
"id": "hardis:project:fix:v53flexipages",
|
|
11931
|
-
"pluginAlias": "sfdx-hardis",
|
|
11932
|
-
"pluginName": "sfdx-hardis",
|
|
11933
|
-
"pluginType": "core",
|
|
11934
|
-
"strict": true,
|
|
11935
|
-
"enableJsonFlag": true,
|
|
11936
|
-
"title": "Fix flexipages for v53",
|
|
11937
|
-
"requiresProject": true,
|
|
11938
|
-
"isESM": true,
|
|
11939
|
-
"relativePath": [
|
|
11940
|
-
"lib",
|
|
11941
|
-
"commands",
|
|
11942
|
-
"hardis",
|
|
11943
|
-
"project",
|
|
11944
|
-
"fix",
|
|
11945
|
-
"v53flexipages.js"
|
|
11946
|
-
],
|
|
11947
|
-
"aliasPermutations": [],
|
|
11948
|
-
"permutations": [
|
|
11949
|
-
"hardis:project:fix:v53flexipages",
|
|
11950
|
-
"project:hardis:fix:v53flexipages",
|
|
11951
|
-
"project:fix:hardis:v53flexipages",
|
|
11952
|
-
"project:fix:v53flexipages:hardis",
|
|
11953
|
-
"hardis:fix:project:v53flexipages",
|
|
11954
|
-
"fix:hardis:project:v53flexipages",
|
|
11955
|
-
"fix:project:hardis:v53flexipages",
|
|
11956
|
-
"fix:project:v53flexipages:hardis",
|
|
11957
|
-
"hardis:fix:v53flexipages:project",
|
|
11958
|
-
"fix:hardis:v53flexipages:project",
|
|
11959
|
-
"fix:v53flexipages:hardis:project",
|
|
11960
|
-
"fix:v53flexipages:project:hardis",
|
|
11961
|
-
"hardis:project:v53flexipages:fix",
|
|
11962
|
-
"project:hardis:v53flexipages:fix",
|
|
11963
|
-
"project:v53flexipages:hardis:fix",
|
|
11964
|
-
"project:v53flexipages:fix:hardis",
|
|
11965
|
-
"hardis:v53flexipages:project:fix",
|
|
11966
|
-
"v53flexipages:hardis:project:fix",
|
|
11967
|
-
"v53flexipages:project:hardis:fix",
|
|
11968
|
-
"v53flexipages:project:fix:hardis",
|
|
11969
|
-
"hardis:v53flexipages:fix:project",
|
|
11970
|
-
"v53flexipages:hardis:fix:project",
|
|
11971
|
-
"v53flexipages:fix:hardis:project",
|
|
11972
|
-
"v53flexipages:fix:project:hardis"
|
|
11717
|
+
"pluginName": "sfdx-hardis",
|
|
11718
|
+
"pluginType": "core",
|
|
11719
|
+
"strict": true,
|
|
11720
|
+
"enableJsonFlag": true,
|
|
11721
|
+
"title": "Clean retrieved empty items in dx sources",
|
|
11722
|
+
"requiresProject": true,
|
|
11723
|
+
"isESM": true,
|
|
11724
|
+
"relativePath": [
|
|
11725
|
+
"lib",
|
|
11726
|
+
"commands",
|
|
11727
|
+
"hardis",
|
|
11728
|
+
"project",
|
|
11729
|
+
"clean",
|
|
11730
|
+
"xml.js"
|
|
11731
|
+
],
|
|
11732
|
+
"aliasPermutations": [],
|
|
11733
|
+
"permutations": [
|
|
11734
|
+
"hardis:project:clean:xml",
|
|
11735
|
+
"project:hardis:clean:xml",
|
|
11736
|
+
"project:clean:hardis:xml",
|
|
11737
|
+
"project:clean:xml:hardis",
|
|
11738
|
+
"hardis:clean:project:xml",
|
|
11739
|
+
"clean:hardis:project:xml",
|
|
11740
|
+
"clean:project:hardis:xml",
|
|
11741
|
+
"clean:project:xml:hardis",
|
|
11742
|
+
"hardis:clean:xml:project",
|
|
11743
|
+
"clean:hardis:xml:project",
|
|
11744
|
+
"clean:xml:hardis:project",
|
|
11745
|
+
"clean:xml:project:hardis",
|
|
11746
|
+
"hardis:project:xml:clean",
|
|
11747
|
+
"project:hardis:xml:clean",
|
|
11748
|
+
"project:xml:hardis:clean",
|
|
11749
|
+
"project:xml:clean:hardis",
|
|
11750
|
+
"hardis:xml:project:clean",
|
|
11751
|
+
"xml:hardis:project:clean",
|
|
11752
|
+
"xml:project:hardis:clean",
|
|
11753
|
+
"xml:project:clean:hardis",
|
|
11754
|
+
"hardis:xml:clean:project",
|
|
11755
|
+
"xml:hardis:clean:project",
|
|
11756
|
+
"xml:clean:hardis:project",
|
|
11757
|
+
"xml:clean:project:hardis"
|
|
11973
11758
|
]
|
|
11974
11759
|
},
|
|
11975
11760
|
"hardis:project:deploy:notify": {
|
|
@@ -13146,6 +12931,221 @@
|
|
|
13146
12931
|
"validate:deploy:project:hardis"
|
|
13147
12932
|
]
|
|
13148
12933
|
},
|
|
12934
|
+
"hardis:project:fix:profiletabs": {
|
|
12935
|
+
"aliases": [],
|
|
12936
|
+
"args": {},
|
|
12937
|
+
"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",
|
|
12938
|
+
"examples": [
|
|
12939
|
+
"$ sf hardis:project:fix:profiletabs"
|
|
12940
|
+
],
|
|
12941
|
+
"flags": {
|
|
12942
|
+
"json": {
|
|
12943
|
+
"description": "Format output as json.",
|
|
12944
|
+
"helpGroup": "GLOBAL",
|
|
12945
|
+
"name": "json",
|
|
12946
|
+
"allowNo": false,
|
|
12947
|
+
"type": "boolean"
|
|
12948
|
+
},
|
|
12949
|
+
"flags-dir": {
|
|
12950
|
+
"helpGroup": "GLOBAL",
|
|
12951
|
+
"name": "flags-dir",
|
|
12952
|
+
"summary": "Import flag values from a directory.",
|
|
12953
|
+
"hasDynamicHelp": false,
|
|
12954
|
+
"multiple": false,
|
|
12955
|
+
"type": "option"
|
|
12956
|
+
},
|
|
12957
|
+
"path": {
|
|
12958
|
+
"char": "p",
|
|
12959
|
+
"description": "Root folder",
|
|
12960
|
+
"name": "path",
|
|
12961
|
+
"default": "/home/runner/work/sfdx-hardis/sfdx-hardis",
|
|
12962
|
+
"hasDynamicHelp": false,
|
|
12963
|
+
"multiple": false,
|
|
12964
|
+
"type": "option"
|
|
12965
|
+
},
|
|
12966
|
+
"debug": {
|
|
12967
|
+
"char": "d",
|
|
12968
|
+
"description": "Activate debug mode (more logs)",
|
|
12969
|
+
"name": "debug",
|
|
12970
|
+
"allowNo": false,
|
|
12971
|
+
"type": "boolean"
|
|
12972
|
+
},
|
|
12973
|
+
"websocket": {
|
|
12974
|
+
"description": "Websocket host:port for VsCode SFDX Hardis UI integration",
|
|
12975
|
+
"name": "websocket",
|
|
12976
|
+
"hasDynamicHelp": false,
|
|
12977
|
+
"multiple": false,
|
|
12978
|
+
"type": "option"
|
|
12979
|
+
},
|
|
12980
|
+
"skipauth": {
|
|
12981
|
+
"description": "Skip authentication check when a default username is required",
|
|
12982
|
+
"name": "skipauth",
|
|
12983
|
+
"allowNo": false,
|
|
12984
|
+
"type": "boolean"
|
|
12985
|
+
},
|
|
12986
|
+
"target-org": {
|
|
12987
|
+
"aliases": [
|
|
12988
|
+
"targetusername",
|
|
12989
|
+
"u"
|
|
12990
|
+
],
|
|
12991
|
+
"char": "o",
|
|
12992
|
+
"deprecateAliases": true,
|
|
12993
|
+
"name": "target-org",
|
|
12994
|
+
"noCacheDefault": true,
|
|
12995
|
+
"required": true,
|
|
12996
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
12997
|
+
"hasDynamicHelp": true,
|
|
12998
|
+
"multiple": false,
|
|
12999
|
+
"type": "option"
|
|
13000
|
+
}
|
|
13001
|
+
},
|
|
13002
|
+
"hasDynamicHelp": true,
|
|
13003
|
+
"hiddenAliases": [],
|
|
13004
|
+
"id": "hardis:project:fix:profiletabs",
|
|
13005
|
+
"pluginAlias": "sfdx-hardis",
|
|
13006
|
+
"pluginName": "sfdx-hardis",
|
|
13007
|
+
"pluginType": "core",
|
|
13008
|
+
"strict": true,
|
|
13009
|
+
"enableJsonFlag": true,
|
|
13010
|
+
"title": "Fix profiles to add tabs that are not retrieved by SF CLI",
|
|
13011
|
+
"requiresProject": true,
|
|
13012
|
+
"isESM": true,
|
|
13013
|
+
"relativePath": [
|
|
13014
|
+
"lib",
|
|
13015
|
+
"commands",
|
|
13016
|
+
"hardis",
|
|
13017
|
+
"project",
|
|
13018
|
+
"fix",
|
|
13019
|
+
"profiletabs.js"
|
|
13020
|
+
],
|
|
13021
|
+
"aliasPermutations": [],
|
|
13022
|
+
"permutations": [
|
|
13023
|
+
"hardis:project:fix:profiletabs",
|
|
13024
|
+
"project:hardis:fix:profiletabs",
|
|
13025
|
+
"project:fix:hardis:profiletabs",
|
|
13026
|
+
"project:fix:profiletabs:hardis",
|
|
13027
|
+
"hardis:fix:project:profiletabs",
|
|
13028
|
+
"fix:hardis:project:profiletabs",
|
|
13029
|
+
"fix:project:hardis:profiletabs",
|
|
13030
|
+
"fix:project:profiletabs:hardis",
|
|
13031
|
+
"hardis:fix:profiletabs:project",
|
|
13032
|
+
"fix:hardis:profiletabs:project",
|
|
13033
|
+
"fix:profiletabs:hardis:project",
|
|
13034
|
+
"fix:profiletabs:project:hardis",
|
|
13035
|
+
"hardis:project:profiletabs:fix",
|
|
13036
|
+
"project:hardis:profiletabs:fix",
|
|
13037
|
+
"project:profiletabs:hardis:fix",
|
|
13038
|
+
"project:profiletabs:fix:hardis",
|
|
13039
|
+
"hardis:profiletabs:project:fix",
|
|
13040
|
+
"profiletabs:hardis:project:fix",
|
|
13041
|
+
"profiletabs:project:hardis:fix",
|
|
13042
|
+
"profiletabs:project:fix:hardis",
|
|
13043
|
+
"hardis:profiletabs:fix:project",
|
|
13044
|
+
"profiletabs:hardis:fix:project",
|
|
13045
|
+
"profiletabs:fix:hardis:project",
|
|
13046
|
+
"profiletabs:fix:project:hardis"
|
|
13047
|
+
]
|
|
13048
|
+
},
|
|
13049
|
+
"hardis:project:fix:v53flexipages": {
|
|
13050
|
+
"aliases": [],
|
|
13051
|
+
"args": {},
|
|
13052
|
+
"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",
|
|
13053
|
+
"examples": [
|
|
13054
|
+
"$ sf hardis:project:fix:v53flexipages"
|
|
13055
|
+
],
|
|
13056
|
+
"flags": {
|
|
13057
|
+
"json": {
|
|
13058
|
+
"description": "Format output as json.",
|
|
13059
|
+
"helpGroup": "GLOBAL",
|
|
13060
|
+
"name": "json",
|
|
13061
|
+
"allowNo": false,
|
|
13062
|
+
"type": "boolean"
|
|
13063
|
+
},
|
|
13064
|
+
"flags-dir": {
|
|
13065
|
+
"helpGroup": "GLOBAL",
|
|
13066
|
+
"name": "flags-dir",
|
|
13067
|
+
"summary": "Import flag values from a directory.",
|
|
13068
|
+
"hasDynamicHelp": false,
|
|
13069
|
+
"multiple": false,
|
|
13070
|
+
"type": "option"
|
|
13071
|
+
},
|
|
13072
|
+
"path": {
|
|
13073
|
+
"char": "p",
|
|
13074
|
+
"description": "Root folder",
|
|
13075
|
+
"name": "path",
|
|
13076
|
+
"default": "/home/runner/work/sfdx-hardis/sfdx-hardis",
|
|
13077
|
+
"hasDynamicHelp": false,
|
|
13078
|
+
"multiple": false,
|
|
13079
|
+
"type": "option"
|
|
13080
|
+
},
|
|
13081
|
+
"debug": {
|
|
13082
|
+
"char": "d",
|
|
13083
|
+
"description": "Activate debug mode (more logs)",
|
|
13084
|
+
"name": "debug",
|
|
13085
|
+
"allowNo": false,
|
|
13086
|
+
"type": "boolean"
|
|
13087
|
+
},
|
|
13088
|
+
"websocket": {
|
|
13089
|
+
"description": "Websocket host:port for VsCode SFDX Hardis UI integration",
|
|
13090
|
+
"name": "websocket",
|
|
13091
|
+
"hasDynamicHelp": false,
|
|
13092
|
+
"multiple": false,
|
|
13093
|
+
"type": "option"
|
|
13094
|
+
},
|
|
13095
|
+
"skipauth": {
|
|
13096
|
+
"description": "Skip authentication check when a default username is required",
|
|
13097
|
+
"name": "skipauth",
|
|
13098
|
+
"allowNo": false,
|
|
13099
|
+
"type": "boolean"
|
|
13100
|
+
}
|
|
13101
|
+
},
|
|
13102
|
+
"hasDynamicHelp": false,
|
|
13103
|
+
"hiddenAliases": [],
|
|
13104
|
+
"id": "hardis:project:fix:v53flexipages",
|
|
13105
|
+
"pluginAlias": "sfdx-hardis",
|
|
13106
|
+
"pluginName": "sfdx-hardis",
|
|
13107
|
+
"pluginType": "core",
|
|
13108
|
+
"strict": true,
|
|
13109
|
+
"enableJsonFlag": true,
|
|
13110
|
+
"title": "Fix flexipages for v53",
|
|
13111
|
+
"requiresProject": true,
|
|
13112
|
+
"isESM": true,
|
|
13113
|
+
"relativePath": [
|
|
13114
|
+
"lib",
|
|
13115
|
+
"commands",
|
|
13116
|
+
"hardis",
|
|
13117
|
+
"project",
|
|
13118
|
+
"fix",
|
|
13119
|
+
"v53flexipages.js"
|
|
13120
|
+
],
|
|
13121
|
+
"aliasPermutations": [],
|
|
13122
|
+
"permutations": [
|
|
13123
|
+
"hardis:project:fix:v53flexipages",
|
|
13124
|
+
"project:hardis:fix:v53flexipages",
|
|
13125
|
+
"project:fix:hardis:v53flexipages",
|
|
13126
|
+
"project:fix:v53flexipages:hardis",
|
|
13127
|
+
"hardis:fix:project:v53flexipages",
|
|
13128
|
+
"fix:hardis:project:v53flexipages",
|
|
13129
|
+
"fix:project:hardis:v53flexipages",
|
|
13130
|
+
"fix:project:v53flexipages:hardis",
|
|
13131
|
+
"hardis:fix:v53flexipages:project",
|
|
13132
|
+
"fix:hardis:v53flexipages:project",
|
|
13133
|
+
"fix:v53flexipages:hardis:project",
|
|
13134
|
+
"fix:v53flexipages:project:hardis",
|
|
13135
|
+
"hardis:project:v53flexipages:fix",
|
|
13136
|
+
"project:hardis:v53flexipages:fix",
|
|
13137
|
+
"project:v53flexipages:hardis:fix",
|
|
13138
|
+
"project:v53flexipages:fix:hardis",
|
|
13139
|
+
"hardis:v53flexipages:project:fix",
|
|
13140
|
+
"v53flexipages:hardis:project:fix",
|
|
13141
|
+
"v53flexipages:project:hardis:fix",
|
|
13142
|
+
"v53flexipages:project:fix:hardis",
|
|
13143
|
+
"hardis:v53flexipages:fix:project",
|
|
13144
|
+
"v53flexipages:hardis:fix:project",
|
|
13145
|
+
"v53flexipages:fix:hardis:project",
|
|
13146
|
+
"v53flexipages:fix:project:hardis"
|
|
13147
|
+
]
|
|
13148
|
+
},
|
|
13149
13149
|
"hardis:project:generate:bypass": {
|
|
13150
13150
|
"aliases": [],
|
|
13151
13151
|
"args": {},
|
|
@@ -15719,5 +15719,5 @@
|
|
|
15719
15719
|
]
|
|
15720
15720
|
}
|
|
15721
15721
|
},
|
|
15722
|
-
"version": "6.15.
|
|
15722
|
+
"version": "6.15.2-beta202512140349.0"
|
|
15723
15723
|
}
|