sfdx-hardis 6.11.3 → 6.11.5
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 +14 -0
- package/defaults/ci/.github/workflows/check-deploy.yml +1 -1
- package/defaults/ci/.github/workflows/process-deploy.yml +5 -1
- package/defaults/ci/azure-pipelines-checks.yml +1 -1
- package/defaults/ci/azure-pipelines-deployment.yml +1 -1
- package/defaults/ci/bitbucket-pipelines.yml +1 -1
- package/defaults/mkdocs/.github/workflows/build-deploy-docs.yml +1 -1
- package/defaults/monitoring/.github/workflows/org-monitoring.yml +3 -3
- package/defaults/monitoring/bitbucket-pipelines.yml +1 -1
- package/lib/commands/hardis/org/test/apex.js +32 -6
- package/lib/commands/hardis/org/test/apex.js.map +1 -1
- package/lib/common/actionsProvider/manualAction.js +1 -0
- package/lib/common/actionsProvider/manualAction.js.map +1 -1
- package/lib/common/gitProvider/github.js +10 -2
- package/lib/common/gitProvider/github.js.map +1 -1
- package/lib/common/utils/index.js +3 -1
- package/lib/common/utils/index.js.map +1 -1
- package/lib/common/utils/orgConfigUtils.js +4 -0
- package/lib/common/utils/orgConfigUtils.js.map +1 -1
- package/oclif.lock +714 -713
- package/oclif.manifest.json +368 -368
- package/package.json +5 -5
package/oclif.manifest.json
CHANGED
|
@@ -57,12 +57,13 @@
|
|
|
57
57
|
"world:hello"
|
|
58
58
|
]
|
|
59
59
|
},
|
|
60
|
-
"hardis:
|
|
60
|
+
"hardis:auth:login": {
|
|
61
61
|
"aliases": [],
|
|
62
62
|
"args": {},
|
|
63
|
-
"description": "\n## Command Behavior\n\n**
|
|
63
|
+
"description": "\n## Command Behavior\n\n**Authenticates to a Salesforce org, primarily designed for CI/CD workflows.**\n\nThis command facilitates secure and automated logins to Salesforce organizations within continuous integration and continuous delivery pipelines. It leverages pre-configured authentication details, ensuring that CI/CD processes can interact with Salesforce without manual intervention.\n\nKey aspects:\n\n- **Configuration-Driven:** It relies on authentication variables and files set up by dedicated configuration commands:\n - For CI/CD repositories: [Configure Org CI Authentication](https://sfdx-hardis.cloudity.com/hardis/project/configure/auth/)\n - For Monitoring repositories: [Configure Org Monitoring](https://sfdx-hardis.cloudity.com/hardis/org/configure/monitoring/)\n- **Technical Org Support:** Supports authentication to a 'technical org' (e.g., for calling Agentforce from another org) by utilizing the `SFDX_AUTH_URL_TECHNICAL_ORG` environment variable. If this variable is set, the command authenticates to this org with the alias `TECHNICAL_ORG`.\n\nTo obtain the `SFDX_AUTH_URL_TECHNICAL_ORG` value, you can run `sf org display --verbose --json` and copy the `sfdxAuthUrl` field from the output.\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical flow involves:\n\n- **Flag Parsing:** It parses command-line flags such as `instanceurl`, `devhub`, `scratchorg`, and `debug` to determine the authentication context.\n- **Authentication Hook:** It triggers an internal authentication hook (`this.config.runHook('auth', ...`)) which is responsible for executing the actual authentication logic based on the provided flags (e.g., whether it's a Dev Hub or a scratch org).\n- **Environment Variable Check:** It checks for the presence of `SFDX_AUTH_URL_TECHNICAL_ORG` or `TECHNICAL_ORG_ALIAS` environment variables.\n- **`authOrg` Utility:** If a technical org is configured, it calls the `authOrg` utility function to perform the authentication for that specific org, ensuring it's connected and available for subsequent operations.\n- **Salesforce CLI Integration:** It integrates with the Salesforce CLI's authentication mechanisms to establish and manage org connections.\n</details>\n",
|
|
64
64
|
"examples": [
|
|
65
|
-
"$ sf hardis:
|
|
65
|
+
"$ sf hardis:auth:login",
|
|
66
|
+
"CI=true CI_COMMIT_REF_NAME=monitoring_myclient sf hardis:auth:login"
|
|
66
67
|
],
|
|
67
68
|
"flags": {
|
|
68
69
|
"json": {
|
|
@@ -80,6 +81,28 @@
|
|
|
80
81
|
"multiple": false,
|
|
81
82
|
"type": "option"
|
|
82
83
|
},
|
|
84
|
+
"instanceurl": {
|
|
85
|
+
"char": "r",
|
|
86
|
+
"description": "URL of org instance",
|
|
87
|
+
"name": "instanceurl",
|
|
88
|
+
"hasDynamicHelp": false,
|
|
89
|
+
"multiple": false,
|
|
90
|
+
"type": "option"
|
|
91
|
+
},
|
|
92
|
+
"devhub": {
|
|
93
|
+
"char": "h",
|
|
94
|
+
"description": "Also connect associated DevHub",
|
|
95
|
+
"name": "devhub",
|
|
96
|
+
"allowNo": false,
|
|
97
|
+
"type": "boolean"
|
|
98
|
+
},
|
|
99
|
+
"scratchorg": {
|
|
100
|
+
"char": "s",
|
|
101
|
+
"description": "Scratch org",
|
|
102
|
+
"name": "scratchorg",
|
|
103
|
+
"allowNo": false,
|
|
104
|
+
"type": "boolean"
|
|
105
|
+
},
|
|
83
106
|
"debug": {
|
|
84
107
|
"char": "d",
|
|
85
108
|
"description": "Activate debug mode (more logs)",
|
|
@@ -103,41 +126,38 @@
|
|
|
103
126
|
},
|
|
104
127
|
"hasDynamicHelp": false,
|
|
105
128
|
"hiddenAliases": [],
|
|
106
|
-
"id": "hardis:
|
|
129
|
+
"id": "hardis:auth:login",
|
|
107
130
|
"pluginAlias": "sfdx-hardis",
|
|
108
131
|
"pluginName": "sfdx-hardis",
|
|
109
132
|
"pluginType": "core",
|
|
110
133
|
"strict": true,
|
|
111
134
|
"enableJsonFlag": true,
|
|
112
|
-
"title": "
|
|
113
|
-
"uiConfig": {
|
|
114
|
-
"hide": true
|
|
115
|
-
},
|
|
135
|
+
"title": "Login",
|
|
116
136
|
"requiresProject": false,
|
|
117
137
|
"isESM": true,
|
|
118
138
|
"relativePath": [
|
|
119
139
|
"lib",
|
|
120
140
|
"commands",
|
|
121
141
|
"hardis",
|
|
122
|
-
"
|
|
123
|
-
"
|
|
142
|
+
"auth",
|
|
143
|
+
"login.js"
|
|
124
144
|
],
|
|
125
145
|
"aliasPermutations": [],
|
|
126
146
|
"permutations": [
|
|
127
|
-
"hardis:
|
|
128
|
-
"
|
|
129
|
-
"
|
|
130
|
-
"hardis:
|
|
131
|
-
"
|
|
132
|
-
"
|
|
147
|
+
"hardis:auth:login",
|
|
148
|
+
"auth:hardis:login",
|
|
149
|
+
"auth:login:hardis",
|
|
150
|
+
"hardis:login:auth",
|
|
151
|
+
"login:hardis:auth",
|
|
152
|
+
"login:auth:hardis"
|
|
133
153
|
]
|
|
134
154
|
},
|
|
135
|
-
"hardis:
|
|
155
|
+
"hardis:cache:clear": {
|
|
136
156
|
"aliases": [],
|
|
137
157
|
"args": {},
|
|
138
|
-
"description": "\n## Command Behavior\n\n**
|
|
158
|
+
"description": "\n## Command Behavior\n\n**Clears the local cache generated by the sfdx-hardis plugin.**\n\nThis command is designed to remove temporary files, stored configurations, and other cached data that sfdx-hardis uses to optimize its operations. Clearing the cache can be beneficial for:\n\n- **Troubleshooting:** Resolving unexpected behavior or inconsistencies.\n- **Disk Space Management:** Freeing up storage on your local machine.\n- **Ensuring Fresh Data:** Guaranteeing that the plugin operates with the most current data and configurations.\n\n## Technical explanations\n\nThe command's technical implementation is straightforward:\n\n- **Direct Function Call:** It directly invokes the `clearCache()` function, which is imported from \buri../../../common/cache/index.js\buri.\n- **Cache Management Logic:** The \buriclearCache()` function encapsulates the logic for identifying and removing the specific files and directories that constitute the sfdx-hardis cache.\n",
|
|
139
159
|
"examples": [
|
|
140
|
-
"$ sf hardis:
|
|
160
|
+
"$ sf hardis:cache:clear"
|
|
141
161
|
],
|
|
142
162
|
"flags": {
|
|
143
163
|
"json": {
|
|
@@ -155,20 +175,6 @@
|
|
|
155
175
|
"multiple": false,
|
|
156
176
|
"type": "option"
|
|
157
177
|
},
|
|
158
|
-
"level": {
|
|
159
|
-
"char": "l",
|
|
160
|
-
"description": "project,branch or user",
|
|
161
|
-
"name": "level",
|
|
162
|
-
"default": "project",
|
|
163
|
-
"hasDynamicHelp": false,
|
|
164
|
-
"multiple": false,
|
|
165
|
-
"options": [
|
|
166
|
-
"project",
|
|
167
|
-
"branch",
|
|
168
|
-
"user"
|
|
169
|
-
],
|
|
170
|
-
"type": "option"
|
|
171
|
-
},
|
|
172
178
|
"debug": {
|
|
173
179
|
"char": "d",
|
|
174
180
|
"description": "Activate debug mode (more logs)",
|
|
@@ -192,39 +198,41 @@
|
|
|
192
198
|
},
|
|
193
199
|
"hasDynamicHelp": false,
|
|
194
200
|
"hiddenAliases": [],
|
|
195
|
-
"id": "hardis:
|
|
201
|
+
"id": "hardis:cache:clear",
|
|
196
202
|
"pluginAlias": "sfdx-hardis",
|
|
197
203
|
"pluginName": "sfdx-hardis",
|
|
198
204
|
"pluginType": "core",
|
|
199
205
|
"strict": true,
|
|
200
206
|
"enableJsonFlag": true,
|
|
201
|
-
"title": "
|
|
207
|
+
"title": "Clear sfdx-hardis cache",
|
|
208
|
+
"uiConfig": {
|
|
209
|
+
"hide": true
|
|
210
|
+
},
|
|
202
211
|
"requiresProject": false,
|
|
203
212
|
"isESM": true,
|
|
204
213
|
"relativePath": [
|
|
205
214
|
"lib",
|
|
206
215
|
"commands",
|
|
207
216
|
"hardis",
|
|
208
|
-
"
|
|
209
|
-
"
|
|
217
|
+
"cache",
|
|
218
|
+
"clear.js"
|
|
210
219
|
],
|
|
211
220
|
"aliasPermutations": [],
|
|
212
221
|
"permutations": [
|
|
213
|
-
"hardis:
|
|
214
|
-
"
|
|
215
|
-
"
|
|
216
|
-
"hardis:
|
|
217
|
-
"
|
|
218
|
-
"
|
|
222
|
+
"hardis:cache:clear",
|
|
223
|
+
"cache:hardis:clear",
|
|
224
|
+
"cache:clear:hardis",
|
|
225
|
+
"hardis:clear:cache",
|
|
226
|
+
"clear:hardis:cache",
|
|
227
|
+
"clear:cache:hardis"
|
|
219
228
|
]
|
|
220
229
|
},
|
|
221
|
-
"hardis:
|
|
230
|
+
"hardis:config:get": {
|
|
222
231
|
"aliases": [],
|
|
223
232
|
"args": {},
|
|
224
|
-
"description": "\n## Command Behavior\n\n**
|
|
233
|
+
"description": "\n## Command Behavior\n\n**Retrieves and displays the sfdx-hardis configuration for a specified level.**\n\nThis command allows you to inspect the configuration that is currently in effect for your project, which is useful for debugging and understanding how sfdx-hardis will behave.\n\n- **Configuration levels:** It can retrieve configuration from three different levels:\n - **Project:** The configuration defined in the project's `.sfdx-hardis.yml` file.\n - **Branch:** The configuration defined in a branch-specific configuration file (e.g., `.sfdx-hardis.production.yml`).\n - **User:** The global user-level configuration.\n\n## Technical explanations\n\nThe command's logic is straightforward:\n\n- **`getConfig` function:** It calls the `getConfig` utility function, passing the desired configuration level as an argument.\n- **Configuration loading:** The `getConfig` function is responsible for finding the appropriate configuration file, reading its contents, and parsing it as YAML or JSON.\n- **Output:** The retrieved configuration is then displayed to the user as a JSON string.\n",
|
|
225
234
|
"examples": [
|
|
226
|
-
"$ sf hardis:
|
|
227
|
-
"CI=true CI_COMMIT_REF_NAME=monitoring_myclient sf hardis:auth:login"
|
|
235
|
+
"$ sf hardis:project:deploy:sources:metadata"
|
|
228
236
|
],
|
|
229
237
|
"flags": {
|
|
230
238
|
"json": {
|
|
@@ -242,28 +250,20 @@
|
|
|
242
250
|
"multiple": false,
|
|
243
251
|
"type": "option"
|
|
244
252
|
},
|
|
245
|
-
"
|
|
246
|
-
"char": "
|
|
247
|
-
"description": "
|
|
248
|
-
"name": "
|
|
253
|
+
"level": {
|
|
254
|
+
"char": "l",
|
|
255
|
+
"description": "project,branch or user",
|
|
256
|
+
"name": "level",
|
|
257
|
+
"default": "project",
|
|
249
258
|
"hasDynamicHelp": false,
|
|
250
259
|
"multiple": false,
|
|
260
|
+
"options": [
|
|
261
|
+
"project",
|
|
262
|
+
"branch",
|
|
263
|
+
"user"
|
|
264
|
+
],
|
|
251
265
|
"type": "option"
|
|
252
266
|
},
|
|
253
|
-
"devhub": {
|
|
254
|
-
"char": "h",
|
|
255
|
-
"description": "Also connect associated DevHub",
|
|
256
|
-
"name": "devhub",
|
|
257
|
-
"allowNo": false,
|
|
258
|
-
"type": "boolean"
|
|
259
|
-
},
|
|
260
|
-
"scratchorg": {
|
|
261
|
-
"char": "s",
|
|
262
|
-
"description": "Scratch org",
|
|
263
|
-
"name": "scratchorg",
|
|
264
|
-
"allowNo": false,
|
|
265
|
-
"type": "boolean"
|
|
266
|
-
},
|
|
267
267
|
"debug": {
|
|
268
268
|
"char": "d",
|
|
269
269
|
"description": "Activate debug mode (more logs)",
|
|
@@ -287,30 +287,30 @@
|
|
|
287
287
|
},
|
|
288
288
|
"hasDynamicHelp": false,
|
|
289
289
|
"hiddenAliases": [],
|
|
290
|
-
"id": "hardis:
|
|
290
|
+
"id": "hardis:config:get",
|
|
291
291
|
"pluginAlias": "sfdx-hardis",
|
|
292
292
|
"pluginName": "sfdx-hardis",
|
|
293
293
|
"pluginType": "core",
|
|
294
294
|
"strict": true,
|
|
295
295
|
"enableJsonFlag": true,
|
|
296
|
-
"title": "
|
|
296
|
+
"title": "Deploy metadata sources to org",
|
|
297
297
|
"requiresProject": false,
|
|
298
298
|
"isESM": true,
|
|
299
299
|
"relativePath": [
|
|
300
300
|
"lib",
|
|
301
301
|
"commands",
|
|
302
302
|
"hardis",
|
|
303
|
-
"
|
|
304
|
-
"
|
|
303
|
+
"config",
|
|
304
|
+
"get.js"
|
|
305
305
|
],
|
|
306
306
|
"aliasPermutations": [],
|
|
307
307
|
"permutations": [
|
|
308
|
-
"hardis:
|
|
309
|
-
"
|
|
310
|
-
"
|
|
311
|
-
"hardis:
|
|
312
|
-
"
|
|
313
|
-
"
|
|
308
|
+
"hardis:config:get",
|
|
309
|
+
"config:hardis:get",
|
|
310
|
+
"config:get:hardis",
|
|
311
|
+
"hardis:get:config",
|
|
312
|
+
"get:hardis:config",
|
|
313
|
+
"get:config:hardis"
|
|
314
314
|
]
|
|
315
315
|
},
|
|
316
316
|
"hardis:doc:fieldusage": {
|
|
@@ -9825,12 +9825,12 @@
|
|
|
9825
9825
|
"remotesites:audit:project:hardis"
|
|
9826
9826
|
]
|
|
9827
9827
|
},
|
|
9828
|
-
"hardis:project:
|
|
9828
|
+
"hardis:project:configure:auth": {
|
|
9829
9829
|
"aliases": [],
|
|
9830
9830
|
"args": {},
|
|
9831
|
-
"description": "\n## Command Behavior\n\n**
|
|
9831
|
+
"description": "\n## Command Behavior\n\n**Configures authentication between a Git branch and a target Salesforce org for CI/CD deployments.**\n\nThis command facilitates the setup of automated CI/CD pipelines, enabling seamless deployments from specific Git branches to designated Salesforce orgs. It supports both standard Salesforce orgs and Dev Hub configurations, catering to various enterprise deployment workflows.\n\nKey functionalities include:\n\n- **Org Selection/Login:** Guides the user to select an existing Salesforce org or log in to a new one.\n- **Git Branch Association:** Allows associating a specific Git branch with the chosen Salesforce org.\n- **Merge Target Definition:** Enables defining target Git branches into which the configured branch can merge, ensuring controlled deployment flows.\n- **Salesforce Username Configuration:** Prompts for the Salesforce username to be used by the CI server for deployments.\n- **SSL Certificate Generation:** Automatically generates an SSL certificate for secure authentication.\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's implementation involves several key technical aspects:\n\n- **SF CLI Integration:** Utilizes \n@salesforce/sf-plugins-core\n for command structure and flag parsing.\n- **Interactive Prompts:** Employs the \nprompts\n library for interactive user input, guiding the configuration process.\n- **Git Integration:** Interacts with Git to retrieve branch information using \n`git().branch([\"--list\", \"-r\"])`\n.\n- **Configuration Management:** Leverages internal utilities (`checkConfig`, `getConfig`, `setConfig`, `setInConfigFile`) to read from and write to project-specific configuration files (e.g., `.sfdx-hardis.<branchName>.yml`).\n- **Salesforce CLI Execution:** Executes Salesforce CLI commands programmatically via `execSfdxJson` for org interactions.\n- **SSL Certificate Generation:** Calls `generateSSLCertificate` to create necessary SSL certificates for JWT-based authentication.\n- **WebSocket Communication:** Uses `WebSocketClient` for potential communication with external tools or processes, such as restarting the command in VS Code.\n- **Dependency Check:** Ensures the presence of `openssl` on the system, which is required for SSL certificate generation.\n",
|
|
9832
9832
|
"examples": [
|
|
9833
|
-
"$ sf hardis:project:
|
|
9833
|
+
"$ sf hardis:project:configure:auth"
|
|
9834
9834
|
],
|
|
9835
9835
|
"flags": {
|
|
9836
9836
|
"json": {
|
|
@@ -9848,14 +9848,12 @@
|
|
|
9848
9848
|
"multiple": false,
|
|
9849
9849
|
"type": "option"
|
|
9850
9850
|
},
|
|
9851
|
-
"
|
|
9852
|
-
"char": "
|
|
9853
|
-
"description": "
|
|
9854
|
-
"name": "
|
|
9855
|
-
"
|
|
9856
|
-
"
|
|
9857
|
-
"multiple": false,
|
|
9858
|
-
"type": "option"
|
|
9851
|
+
"devhub": {
|
|
9852
|
+
"char": "b",
|
|
9853
|
+
"description": "Configure project DevHub",
|
|
9854
|
+
"name": "devhub",
|
|
9855
|
+
"allowNo": false,
|
|
9856
|
+
"type": "boolean"
|
|
9859
9857
|
},
|
|
9860
9858
|
"debug": {
|
|
9861
9859
|
"char": "d",
|
|
@@ -9876,72 +9874,306 @@
|
|
|
9876
9874
|
"name": "skipauth",
|
|
9877
9875
|
"allowNo": false,
|
|
9878
9876
|
"type": "boolean"
|
|
9877
|
+
},
|
|
9878
|
+
"target-org": {
|
|
9879
|
+
"aliases": [
|
|
9880
|
+
"targetusername",
|
|
9881
|
+
"u"
|
|
9882
|
+
],
|
|
9883
|
+
"char": "o",
|
|
9884
|
+
"deprecateAliases": true,
|
|
9885
|
+
"name": "target-org",
|
|
9886
|
+
"noCacheDefault": true,
|
|
9887
|
+
"summary": "Username or alias of the target org.",
|
|
9888
|
+
"hasDynamicHelp": true,
|
|
9889
|
+
"multiple": false,
|
|
9890
|
+
"type": "option"
|
|
9891
|
+
},
|
|
9892
|
+
"target-dev-hub": {
|
|
9893
|
+
"aliases": [
|
|
9894
|
+
"targetdevhubusername"
|
|
9895
|
+
],
|
|
9896
|
+
"char": "v",
|
|
9897
|
+
"deprecateAliases": true,
|
|
9898
|
+
"name": "target-dev-hub",
|
|
9899
|
+
"noCacheDefault": true,
|
|
9900
|
+
"required": false,
|
|
9901
|
+
"summary": "Username or alias of the Dev Hub org.",
|
|
9902
|
+
"hasDynamicHelp": true,
|
|
9903
|
+
"multiple": false,
|
|
9904
|
+
"type": "option"
|
|
9879
9905
|
}
|
|
9880
9906
|
},
|
|
9881
|
-
"hasDynamicHelp":
|
|
9907
|
+
"hasDynamicHelp": true,
|
|
9882
9908
|
"hiddenAliases": [],
|
|
9883
|
-
"id": "hardis:project:
|
|
9909
|
+
"id": "hardis:project:configure:auth",
|
|
9884
9910
|
"pluginAlias": "sfdx-hardis",
|
|
9885
9911
|
"pluginName": "sfdx-hardis",
|
|
9886
9912
|
"pluginType": "core",
|
|
9887
9913
|
"strict": true,
|
|
9888
9914
|
"enableJsonFlag": true,
|
|
9889
|
-
"title": "
|
|
9890
|
-
"requiresProject":
|
|
9915
|
+
"title": "Configure authentication",
|
|
9916
|
+
"requiresProject": false,
|
|
9917
|
+
"requiresDependencies": [
|
|
9918
|
+
"openssl"
|
|
9919
|
+
],
|
|
9891
9920
|
"isESM": true,
|
|
9892
9921
|
"relativePath": [
|
|
9893
9922
|
"lib",
|
|
9894
9923
|
"commands",
|
|
9895
9924
|
"hardis",
|
|
9896
9925
|
"project",
|
|
9897
|
-
"
|
|
9898
|
-
"
|
|
9926
|
+
"configure",
|
|
9927
|
+
"auth.js"
|
|
9899
9928
|
],
|
|
9900
9929
|
"aliasPermutations": [],
|
|
9901
9930
|
"permutations": [
|
|
9902
|
-
"hardis:project:
|
|
9903
|
-
"project:hardis:
|
|
9904
|
-
"project:
|
|
9905
|
-
"project:
|
|
9906
|
-
"hardis:
|
|
9907
|
-
"
|
|
9908
|
-
"
|
|
9909
|
-
"
|
|
9910
|
-
"hardis:
|
|
9911
|
-
"
|
|
9912
|
-
"
|
|
9913
|
-
"
|
|
9914
|
-
"hardis:project:
|
|
9915
|
-
"project:hardis:
|
|
9916
|
-
"project:
|
|
9917
|
-
"project:
|
|
9918
|
-
"hardis:
|
|
9919
|
-
"
|
|
9920
|
-
"
|
|
9921
|
-
"
|
|
9922
|
-
"hardis:
|
|
9923
|
-
"
|
|
9924
|
-
"
|
|
9925
|
-
"
|
|
9926
|
-
]
|
|
9927
|
-
},
|
|
9928
|
-
"hardis:project:
|
|
9929
|
-
"aliases": [],
|
|
9930
|
-
"args": {},
|
|
9931
|
-
"description": "\n## Command Behavior\n\n**
|
|
9932
|
-
"examples": [
|
|
9933
|
-
"sf hardis:project:
|
|
9934
|
-
|
|
9935
|
-
|
|
9936
|
-
|
|
9937
|
-
|
|
9938
|
-
"
|
|
9939
|
-
"
|
|
9940
|
-
"
|
|
9941
|
-
"
|
|
9942
|
-
|
|
9943
|
-
|
|
9944
|
-
|
|
9931
|
+
"hardis:project:configure:auth",
|
|
9932
|
+
"project:hardis:configure:auth",
|
|
9933
|
+
"project:configure:hardis:auth",
|
|
9934
|
+
"project:configure:auth:hardis",
|
|
9935
|
+
"hardis:configure:project:auth",
|
|
9936
|
+
"configure:hardis:project:auth",
|
|
9937
|
+
"configure:project:hardis:auth",
|
|
9938
|
+
"configure:project:auth:hardis",
|
|
9939
|
+
"hardis:configure:auth:project",
|
|
9940
|
+
"configure:hardis:auth:project",
|
|
9941
|
+
"configure:auth:hardis:project",
|
|
9942
|
+
"configure:auth:project:hardis",
|
|
9943
|
+
"hardis:project:auth:configure",
|
|
9944
|
+
"project:hardis:auth:configure",
|
|
9945
|
+
"project:auth:hardis:configure",
|
|
9946
|
+
"project:auth:configure:hardis",
|
|
9947
|
+
"hardis:auth:project:configure",
|
|
9948
|
+
"auth:hardis:project:configure",
|
|
9949
|
+
"auth:project:hardis:configure",
|
|
9950
|
+
"auth:project:configure:hardis",
|
|
9951
|
+
"hardis:auth:configure:project",
|
|
9952
|
+
"auth:hardis:configure:project",
|
|
9953
|
+
"auth:configure:hardis:project",
|
|
9954
|
+
"auth:configure:project:hardis"
|
|
9955
|
+
]
|
|
9956
|
+
},
|
|
9957
|
+
"hardis:project:convert:profilestopermsets": {
|
|
9958
|
+
"aliases": [],
|
|
9959
|
+
"args": {},
|
|
9960
|
+
"description": "\n## Command Behavior\n\n**Converts existing Salesforce Profiles into Permission Sets, facilitating a more granular and recommended security model.**\n\nThis command helps in migrating permissions from Profiles to Permission Sets, which is a best practice for managing user access in Salesforce. It creates a new Permission Set for each specified Profile, adopting a naming convention of `PS_PROFILENAME`.\n\nKey functionalities:\n\n- **Profile to Permission Set Conversion:** Automatically extracts permissions from a Profile and creates a corresponding Permission Set.\n- **Naming Convention:** New Permission Sets are named with a `PS_` prefix followed by the Profile name (e.g., `PS_Standard_User`).\n- **Exclusion Filter:** Allows you to exclude specific Profiles from the conversion process using the `--except` flag.\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **External Plugin Integration:** It relies on the `shane-sfdx-plugins` (specifically the `sf shane:profile:convert` command) to perform the actual conversion.\n- **File System Scan:** It reads the contents of the `force-app/main/default/profiles` directory to identify all available Profile metadata files.\n- **Command Execution:** For each identified Profile (that is not excluded), it constructs and executes the `sf shane:profile:convert` command with the appropriate Profile name and desired Permission Set name.\n- **Error Handling:** Includes basic error handling for the external command execution.\n</details>\n",
|
|
9961
|
+
"examples": [
|
|
9962
|
+
"$ sf hardis:project:convert:profilestopermsets"
|
|
9963
|
+
],
|
|
9964
|
+
"flags": {
|
|
9965
|
+
"json": {
|
|
9966
|
+
"description": "Format output as json.",
|
|
9967
|
+
"helpGroup": "GLOBAL",
|
|
9968
|
+
"name": "json",
|
|
9969
|
+
"allowNo": false,
|
|
9970
|
+
"type": "boolean"
|
|
9971
|
+
},
|
|
9972
|
+
"flags-dir": {
|
|
9973
|
+
"helpGroup": "GLOBAL",
|
|
9974
|
+
"name": "flags-dir",
|
|
9975
|
+
"summary": "Import flag values from a directory.",
|
|
9976
|
+
"hasDynamicHelp": false,
|
|
9977
|
+
"multiple": false,
|
|
9978
|
+
"type": "option"
|
|
9979
|
+
},
|
|
9980
|
+
"except": {
|
|
9981
|
+
"char": "e",
|
|
9982
|
+
"description": "List of filters",
|
|
9983
|
+
"name": "except",
|
|
9984
|
+
"default": [],
|
|
9985
|
+
"hasDynamicHelp": false,
|
|
9986
|
+
"multiple": true,
|
|
9987
|
+
"type": "option"
|
|
9988
|
+
},
|
|
9989
|
+
"debug": {
|
|
9990
|
+
"char": "d",
|
|
9991
|
+
"description": "Activate debug mode (more logs)",
|
|
9992
|
+
"name": "debug",
|
|
9993
|
+
"allowNo": false,
|
|
9994
|
+
"type": "boolean"
|
|
9995
|
+
},
|
|
9996
|
+
"websocket": {
|
|
9997
|
+
"description": "Websocket host:port for VsCode SFDX Hardis UI integration",
|
|
9998
|
+
"name": "websocket",
|
|
9999
|
+
"hasDynamicHelp": false,
|
|
10000
|
+
"multiple": false,
|
|
10001
|
+
"type": "option"
|
|
10002
|
+
},
|
|
10003
|
+
"skipauth": {
|
|
10004
|
+
"description": "Skip authentication check when a default username is required",
|
|
10005
|
+
"name": "skipauth",
|
|
10006
|
+
"allowNo": false,
|
|
10007
|
+
"type": "boolean"
|
|
10008
|
+
}
|
|
10009
|
+
},
|
|
10010
|
+
"hasDynamicHelp": false,
|
|
10011
|
+
"hiddenAliases": [],
|
|
10012
|
+
"id": "hardis:project:convert:profilestopermsets",
|
|
10013
|
+
"pluginAlias": "sfdx-hardis",
|
|
10014
|
+
"pluginName": "sfdx-hardis",
|
|
10015
|
+
"pluginType": "core",
|
|
10016
|
+
"strict": true,
|
|
10017
|
+
"enableJsonFlag": true,
|
|
10018
|
+
"title": "Convert Profiles into Permission Sets",
|
|
10019
|
+
"requiresProject": true,
|
|
10020
|
+
"requiresSfdxPlugins": [
|
|
10021
|
+
"shane-sfdx-plugins"
|
|
10022
|
+
],
|
|
10023
|
+
"isESM": true,
|
|
10024
|
+
"relativePath": [
|
|
10025
|
+
"lib",
|
|
10026
|
+
"commands",
|
|
10027
|
+
"hardis",
|
|
10028
|
+
"project",
|
|
10029
|
+
"convert",
|
|
10030
|
+
"profilestopermsets.js"
|
|
10031
|
+
],
|
|
10032
|
+
"aliasPermutations": [],
|
|
10033
|
+
"permutations": [
|
|
10034
|
+
"hardis:project:convert:profilestopermsets",
|
|
10035
|
+
"project:hardis:convert:profilestopermsets",
|
|
10036
|
+
"project:convert:hardis:profilestopermsets",
|
|
10037
|
+
"project:convert:profilestopermsets:hardis",
|
|
10038
|
+
"hardis:convert:project:profilestopermsets",
|
|
10039
|
+
"convert:hardis:project:profilestopermsets",
|
|
10040
|
+
"convert:project:hardis:profilestopermsets",
|
|
10041
|
+
"convert:project:profilestopermsets:hardis",
|
|
10042
|
+
"hardis:convert:profilestopermsets:project",
|
|
10043
|
+
"convert:hardis:profilestopermsets:project",
|
|
10044
|
+
"convert:profilestopermsets:hardis:project",
|
|
10045
|
+
"convert:profilestopermsets:project:hardis",
|
|
10046
|
+
"hardis:project:profilestopermsets:convert",
|
|
10047
|
+
"project:hardis:profilestopermsets:convert",
|
|
10048
|
+
"project:profilestopermsets:hardis:convert",
|
|
10049
|
+
"project:profilestopermsets:convert:hardis",
|
|
10050
|
+
"hardis:profilestopermsets:project:convert",
|
|
10051
|
+
"profilestopermsets:hardis:project:convert",
|
|
10052
|
+
"profilestopermsets:project:hardis:convert",
|
|
10053
|
+
"profilestopermsets:project:convert:hardis",
|
|
10054
|
+
"hardis:profilestopermsets:convert:project",
|
|
10055
|
+
"profilestopermsets:hardis:convert:project",
|
|
10056
|
+
"profilestopermsets:convert:hardis:project",
|
|
10057
|
+
"profilestopermsets:convert:project:hardis"
|
|
10058
|
+
]
|
|
10059
|
+
},
|
|
10060
|
+
"hardis:project:clean:emptyitems": {
|
|
10061
|
+
"aliases": [],
|
|
10062
|
+
"args": {},
|
|
10063
|
+
"description": "\n## Command Behavior\n\n**Removes empty or irrelevant metadata items from your Salesforce DX project sources.**\n\nThis command helps maintain a clean and efficient Salesforce codebase by deleting metadata files that are essentially empty or contain no meaningful configuration. These files can sometimes be generated during retrieval processes or remain after refactoring, contributing to unnecessary clutter in your project.\n\nKey functionalities:\n\n- **Targeted Cleaning:** Specifically targets and removes empty instances of:\n - Global Value Set Translations (`.globalValueSetTranslation-meta.xml`)\n - Standard Value Sets (`.standardValueSet-meta.xml`)\n - Sharing Rules (`.sharingRules-meta.xml`)\n- **Content-Based Deletion:** It checks the XML content of these files for the presence of specific tags (e.g., `valueTranslation` for Global Value Set Translations) to determine if they are truly empty or lack relevant data.\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 files matching predefined patterns for Global Value Set Translations, Standard Value Sets, and Sharing Rules within the specified root folder (defaults to `force-app`).\n- **XML Parsing:** For each matching file, it reads and parses the XML content using `parseXmlFile`.\n- **Content Validation:** It then checks the parsed XML object for the existence of specific nested properties (e.g., `xmlContent.GlobalValueSetTranslation.valueTranslation`). If these properties are missing or empty, the file is considered empty.\n- **File Deletion:** If a file is determined to be empty, it is removed from the file system using `fs.remove`.\n- **Logging:** Provides clear messages about which files are being removed and a summary of the total number of items cleaned.\n</details>\n",
|
|
10064
|
+
"examples": [
|
|
10065
|
+
"$ sf hardis:project:clean:emptyitems"
|
|
10066
|
+
],
|
|
10067
|
+
"flags": {
|
|
10068
|
+
"json": {
|
|
10069
|
+
"description": "Format output as json.",
|
|
10070
|
+
"helpGroup": "GLOBAL",
|
|
10071
|
+
"name": "json",
|
|
10072
|
+
"allowNo": false,
|
|
10073
|
+
"type": "boolean"
|
|
10074
|
+
},
|
|
10075
|
+
"flags-dir": {
|
|
10076
|
+
"helpGroup": "GLOBAL",
|
|
10077
|
+
"name": "flags-dir",
|
|
10078
|
+
"summary": "Import flag values from a directory.",
|
|
10079
|
+
"hasDynamicHelp": false,
|
|
10080
|
+
"multiple": false,
|
|
10081
|
+
"type": "option"
|
|
10082
|
+
},
|
|
10083
|
+
"folder": {
|
|
10084
|
+
"char": "f",
|
|
10085
|
+
"description": "Root folder",
|
|
10086
|
+
"name": "folder",
|
|
10087
|
+
"default": "force-app",
|
|
10088
|
+
"hasDynamicHelp": false,
|
|
10089
|
+
"multiple": false,
|
|
10090
|
+
"type": "option"
|
|
10091
|
+
},
|
|
10092
|
+
"debug": {
|
|
10093
|
+
"char": "d",
|
|
10094
|
+
"description": "Activate debug mode (more logs)",
|
|
10095
|
+
"name": "debug",
|
|
10096
|
+
"allowNo": false,
|
|
10097
|
+
"type": "boolean"
|
|
10098
|
+
},
|
|
10099
|
+
"websocket": {
|
|
10100
|
+
"description": "Websocket host:port for VsCode SFDX Hardis UI integration",
|
|
10101
|
+
"name": "websocket",
|
|
10102
|
+
"hasDynamicHelp": false,
|
|
10103
|
+
"multiple": false,
|
|
10104
|
+
"type": "option"
|
|
10105
|
+
},
|
|
10106
|
+
"skipauth": {
|
|
10107
|
+
"description": "Skip authentication check when a default username is required",
|
|
10108
|
+
"name": "skipauth",
|
|
10109
|
+
"allowNo": false,
|
|
10110
|
+
"type": "boolean"
|
|
10111
|
+
}
|
|
10112
|
+
},
|
|
10113
|
+
"hasDynamicHelp": false,
|
|
10114
|
+
"hiddenAliases": [],
|
|
10115
|
+
"id": "hardis:project:clean:emptyitems",
|
|
10116
|
+
"pluginAlias": "sfdx-hardis",
|
|
10117
|
+
"pluginName": "sfdx-hardis",
|
|
10118
|
+
"pluginType": "core",
|
|
10119
|
+
"strict": true,
|
|
10120
|
+
"enableJsonFlag": true,
|
|
10121
|
+
"title": "Clean retrieved empty items in dx sources",
|
|
10122
|
+
"requiresProject": true,
|
|
10123
|
+
"isESM": true,
|
|
10124
|
+
"relativePath": [
|
|
10125
|
+
"lib",
|
|
10126
|
+
"commands",
|
|
10127
|
+
"hardis",
|
|
10128
|
+
"project",
|
|
10129
|
+
"clean",
|
|
10130
|
+
"emptyitems.js"
|
|
10131
|
+
],
|
|
10132
|
+
"aliasPermutations": [],
|
|
10133
|
+
"permutations": [
|
|
10134
|
+
"hardis:project:clean:emptyitems",
|
|
10135
|
+
"project:hardis:clean:emptyitems",
|
|
10136
|
+
"project:clean:hardis:emptyitems",
|
|
10137
|
+
"project:clean:emptyitems:hardis",
|
|
10138
|
+
"hardis:clean:project:emptyitems",
|
|
10139
|
+
"clean:hardis:project:emptyitems",
|
|
10140
|
+
"clean:project:hardis:emptyitems",
|
|
10141
|
+
"clean:project:emptyitems:hardis",
|
|
10142
|
+
"hardis:clean:emptyitems:project",
|
|
10143
|
+
"clean:hardis:emptyitems:project",
|
|
10144
|
+
"clean:emptyitems:hardis:project",
|
|
10145
|
+
"clean:emptyitems:project:hardis",
|
|
10146
|
+
"hardis:project:emptyitems:clean",
|
|
10147
|
+
"project:hardis:emptyitems:clean",
|
|
10148
|
+
"project:emptyitems:hardis:clean",
|
|
10149
|
+
"project:emptyitems:clean:hardis",
|
|
10150
|
+
"hardis:emptyitems:project:clean",
|
|
10151
|
+
"emptyitems:hardis:project:clean",
|
|
10152
|
+
"emptyitems:project:hardis:clean",
|
|
10153
|
+
"emptyitems:project:clean:hardis",
|
|
10154
|
+
"hardis:emptyitems:clean:project",
|
|
10155
|
+
"emptyitems:hardis:clean:project",
|
|
10156
|
+
"emptyitems:clean:hardis:project",
|
|
10157
|
+
"emptyitems:clean:project:hardis"
|
|
10158
|
+
]
|
|
10159
|
+
},
|
|
10160
|
+
"hardis:project:clean:filter-xml-content": {
|
|
10161
|
+
"aliases": [],
|
|
10162
|
+
"args": {},
|
|
10163
|
+
"description": "\n## Command Behavior\n\n**Filters the content of Salesforce metadata XML files to remove specific elements, enabling more granular deployments.**\n\nThis command addresses a common challenge in Salesforce development: deploying only a subset of metadata from an XML file when the target org might not support all elements or when certain elements are not desired. It allows you to define rules in a JSON configuration file to remove unwanted XML nodes.\n\nKey functionalities:\n\n- **Configurable Filtering:** Uses a JSON configuration file (e.g., `filter-config.json`) to define which XML elements to remove. This configuration specifies the XML tags to target and the values within those tags that should trigger removal.\n- **Targeted File Processing:** Processes XML files within a specified input folder (defaults to current directory) and writes the filtered content to an output folder.\n- **Example Use Cases:** Useful for scenarios like:\n - Removing references to features not enabled in the target org.\n - Stripping out specific profile permissions or field-level security settings.\n - Cleaning up metadata that is not relevant to a particular deployment.\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **Configuration Loading:** Reads the `filter-config.json` file, which contains an array of `filters`. Each filter defines a `name`, `description`, `folders` (where to apply the filter), `file_extensions`, and an `exclude_list`.\n- **File System Operations:** Copies the input folder to an output folder (if different) to avoid modifying original files directly. It then iterates through the files in the output folder that match the specified file extensions.\n- **XML Parsing and Manipulation:** For each matching XML file:\n - It uses `xml2js.Parser` to parse the XML content into a JavaScript object.\n - It recursively traverses the JavaScript object, applying the `filterElement` function.\n - The `filterElement` function checks for `type_tag` and `identifier_tag` defined in the `exclude_list`. If a match is found and the value is in the `excludeDef.values`, the element is removed from the XML structure.\n - After filtering, it uses `writeXmlFile` to write the modified JavaScript object back to the XML file.\n- **Logging:** Provides detailed logs about the filtering process, including which files are being processed and which elements are being filtered.\n- **Summary Reporting:** Tracks and reports on the files that have been updated due to filtering.\n</details>\n",
|
|
10164
|
+
"examples": [
|
|
10165
|
+
"sf hardis:project:clean:filter-xml-content -i \"./mdapi_output\"",
|
|
10166
|
+
"sf hardis:project:clean:filter-xml-content -i \"retrieveUnpackaged\""
|
|
10167
|
+
],
|
|
10168
|
+
"flags": {
|
|
10169
|
+
"json": {
|
|
10170
|
+
"description": "Format output as json.",
|
|
10171
|
+
"helpGroup": "GLOBAL",
|
|
10172
|
+
"name": "json",
|
|
10173
|
+
"allowNo": false,
|
|
10174
|
+
"type": "boolean"
|
|
10175
|
+
},
|
|
10176
|
+
"flags-dir": {
|
|
9945
10177
|
"helpGroup": "GLOBAL",
|
|
9946
10178
|
"name": "flags-dir",
|
|
9947
10179
|
"summary": "Import flag values from a directory.",
|
|
@@ -11310,238 +11542,6 @@
|
|
|
11310
11542
|
"xml:clean:project:hardis"
|
|
11311
11543
|
]
|
|
11312
11544
|
},
|
|
11313
|
-
"hardis:project:configure:auth": {
|
|
11314
|
-
"aliases": [],
|
|
11315
|
-
"args": {},
|
|
11316
|
-
"description": "\n## Command Behavior\n\n**Configures authentication between a Git branch and a target Salesforce org for CI/CD deployments.**\n\nThis command facilitates the setup of automated CI/CD pipelines, enabling seamless deployments from specific Git branches to designated Salesforce orgs. It supports both standard Salesforce orgs and Dev Hub configurations, catering to various enterprise deployment workflows.\n\nKey functionalities include:\n\n- **Org Selection/Login:** Guides the user to select an existing Salesforce org or log in to a new one.\n- **Git Branch Association:** Allows associating a specific Git branch with the chosen Salesforce org.\n- **Merge Target Definition:** Enables defining target Git branches into which the configured branch can merge, ensuring controlled deployment flows.\n- **Salesforce Username Configuration:** Prompts for the Salesforce username to be used by the CI server for deployments.\n- **SSL Certificate Generation:** Automatically generates an SSL certificate for secure authentication.\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's implementation involves several key technical aspects:\n\n- **SF CLI Integration:** Utilizes \n@salesforce/sf-plugins-core\n for command structure and flag parsing.\n- **Interactive Prompts:** Employs the \nprompts\n library for interactive user input, guiding the configuration process.\n- **Git Integration:** Interacts with Git to retrieve branch information using \n`git().branch([\"--list\", \"-r\"])`\n.\n- **Configuration Management:** Leverages internal utilities (`checkConfig`, `getConfig`, `setConfig`, `setInConfigFile`) to read from and write to project-specific configuration files (e.g., `.sfdx-hardis.<branchName>.yml`).\n- **Salesforce CLI Execution:** Executes Salesforce CLI commands programmatically via `execSfdxJson` for org interactions.\n- **SSL Certificate Generation:** Calls `generateSSLCertificate` to create necessary SSL certificates for JWT-based authentication.\n- **WebSocket Communication:** Uses `WebSocketClient` for potential communication with external tools or processes, such as restarting the command in VS Code.\n- **Dependency Check:** Ensures the presence of `openssl` on the system, which is required for SSL certificate generation.\n",
|
|
11317
|
-
"examples": [
|
|
11318
|
-
"$ sf hardis:project:configure:auth"
|
|
11319
|
-
],
|
|
11320
|
-
"flags": {
|
|
11321
|
-
"json": {
|
|
11322
|
-
"description": "Format output as json.",
|
|
11323
|
-
"helpGroup": "GLOBAL",
|
|
11324
|
-
"name": "json",
|
|
11325
|
-
"allowNo": false,
|
|
11326
|
-
"type": "boolean"
|
|
11327
|
-
},
|
|
11328
|
-
"flags-dir": {
|
|
11329
|
-
"helpGroup": "GLOBAL",
|
|
11330
|
-
"name": "flags-dir",
|
|
11331
|
-
"summary": "Import flag values from a directory.",
|
|
11332
|
-
"hasDynamicHelp": false,
|
|
11333
|
-
"multiple": false,
|
|
11334
|
-
"type": "option"
|
|
11335
|
-
},
|
|
11336
|
-
"devhub": {
|
|
11337
|
-
"char": "b",
|
|
11338
|
-
"description": "Configure project DevHub",
|
|
11339
|
-
"name": "devhub",
|
|
11340
|
-
"allowNo": false,
|
|
11341
|
-
"type": "boolean"
|
|
11342
|
-
},
|
|
11343
|
-
"debug": {
|
|
11344
|
-
"char": "d",
|
|
11345
|
-
"description": "Activate debug mode (more logs)",
|
|
11346
|
-
"name": "debug",
|
|
11347
|
-
"allowNo": false,
|
|
11348
|
-
"type": "boolean"
|
|
11349
|
-
},
|
|
11350
|
-
"websocket": {
|
|
11351
|
-
"description": "Websocket host:port for VsCode SFDX Hardis UI integration",
|
|
11352
|
-
"name": "websocket",
|
|
11353
|
-
"hasDynamicHelp": false,
|
|
11354
|
-
"multiple": false,
|
|
11355
|
-
"type": "option"
|
|
11356
|
-
},
|
|
11357
|
-
"skipauth": {
|
|
11358
|
-
"description": "Skip authentication check when a default username is required",
|
|
11359
|
-
"name": "skipauth",
|
|
11360
|
-
"allowNo": false,
|
|
11361
|
-
"type": "boolean"
|
|
11362
|
-
},
|
|
11363
|
-
"target-org": {
|
|
11364
|
-
"aliases": [
|
|
11365
|
-
"targetusername",
|
|
11366
|
-
"u"
|
|
11367
|
-
],
|
|
11368
|
-
"char": "o",
|
|
11369
|
-
"deprecateAliases": true,
|
|
11370
|
-
"name": "target-org",
|
|
11371
|
-
"noCacheDefault": true,
|
|
11372
|
-
"summary": "Username or alias of the target org.",
|
|
11373
|
-
"hasDynamicHelp": true,
|
|
11374
|
-
"multiple": false,
|
|
11375
|
-
"type": "option"
|
|
11376
|
-
},
|
|
11377
|
-
"target-dev-hub": {
|
|
11378
|
-
"aliases": [
|
|
11379
|
-
"targetdevhubusername"
|
|
11380
|
-
],
|
|
11381
|
-
"char": "v",
|
|
11382
|
-
"deprecateAliases": true,
|
|
11383
|
-
"name": "target-dev-hub",
|
|
11384
|
-
"noCacheDefault": true,
|
|
11385
|
-
"required": false,
|
|
11386
|
-
"summary": "Username or alias of the Dev Hub org.",
|
|
11387
|
-
"hasDynamicHelp": true,
|
|
11388
|
-
"multiple": false,
|
|
11389
|
-
"type": "option"
|
|
11390
|
-
}
|
|
11391
|
-
},
|
|
11392
|
-
"hasDynamicHelp": true,
|
|
11393
|
-
"hiddenAliases": [],
|
|
11394
|
-
"id": "hardis:project:configure:auth",
|
|
11395
|
-
"pluginAlias": "sfdx-hardis",
|
|
11396
|
-
"pluginName": "sfdx-hardis",
|
|
11397
|
-
"pluginType": "core",
|
|
11398
|
-
"strict": true,
|
|
11399
|
-
"enableJsonFlag": true,
|
|
11400
|
-
"title": "Configure authentication",
|
|
11401
|
-
"requiresProject": false,
|
|
11402
|
-
"requiresDependencies": [
|
|
11403
|
-
"openssl"
|
|
11404
|
-
],
|
|
11405
|
-
"isESM": true,
|
|
11406
|
-
"relativePath": [
|
|
11407
|
-
"lib",
|
|
11408
|
-
"commands",
|
|
11409
|
-
"hardis",
|
|
11410
|
-
"project",
|
|
11411
|
-
"configure",
|
|
11412
|
-
"auth.js"
|
|
11413
|
-
],
|
|
11414
|
-
"aliasPermutations": [],
|
|
11415
|
-
"permutations": [
|
|
11416
|
-
"hardis:project:configure:auth",
|
|
11417
|
-
"project:hardis:configure:auth",
|
|
11418
|
-
"project:configure:hardis:auth",
|
|
11419
|
-
"project:configure:auth:hardis",
|
|
11420
|
-
"hardis:configure:project:auth",
|
|
11421
|
-
"configure:hardis:project:auth",
|
|
11422
|
-
"configure:project:hardis:auth",
|
|
11423
|
-
"configure:project:auth:hardis",
|
|
11424
|
-
"hardis:configure:auth:project",
|
|
11425
|
-
"configure:hardis:auth:project",
|
|
11426
|
-
"configure:auth:hardis:project",
|
|
11427
|
-
"configure:auth:project:hardis",
|
|
11428
|
-
"hardis:project:auth:configure",
|
|
11429
|
-
"project:hardis:auth:configure",
|
|
11430
|
-
"project:auth:hardis:configure",
|
|
11431
|
-
"project:auth:configure:hardis",
|
|
11432
|
-
"hardis:auth:project:configure",
|
|
11433
|
-
"auth:hardis:project:configure",
|
|
11434
|
-
"auth:project:hardis:configure",
|
|
11435
|
-
"auth:project:configure:hardis",
|
|
11436
|
-
"hardis:auth:configure:project",
|
|
11437
|
-
"auth:hardis:configure:project",
|
|
11438
|
-
"auth:configure:hardis:project",
|
|
11439
|
-
"auth:configure:project:hardis"
|
|
11440
|
-
]
|
|
11441
|
-
},
|
|
11442
|
-
"hardis:project:convert:profilestopermsets": {
|
|
11443
|
-
"aliases": [],
|
|
11444
|
-
"args": {},
|
|
11445
|
-
"description": "\n## Command Behavior\n\n**Converts existing Salesforce Profiles into Permission Sets, facilitating a more granular and recommended security model.**\n\nThis command helps in migrating permissions from Profiles to Permission Sets, which is a best practice for managing user access in Salesforce. It creates a new Permission Set for each specified Profile, adopting a naming convention of `PS_PROFILENAME`.\n\nKey functionalities:\n\n- **Profile to Permission Set Conversion:** Automatically extracts permissions from a Profile and creates a corresponding Permission Set.\n- **Naming Convention:** New Permission Sets are named with a `PS_` prefix followed by the Profile name (e.g., `PS_Standard_User`).\n- **Exclusion Filter:** Allows you to exclude specific Profiles from the conversion process using the `--except` flag.\n\n<details markdown=\"1\">\n<summary>Technical explanations</summary>\n\nThe command's technical implementation involves:\n\n- **External Plugin Integration:** It relies on the `shane-sfdx-plugins` (specifically the `sf shane:profile:convert` command) to perform the actual conversion.\n- **File System Scan:** It reads the contents of the `force-app/main/default/profiles` directory to identify all available Profile metadata files.\n- **Command Execution:** For each identified Profile (that is not excluded), it constructs and executes the `sf shane:profile:convert` command with the appropriate Profile name and desired Permission Set name.\n- **Error Handling:** Includes basic error handling for the external command execution.\n</details>\n",
|
|
11446
|
-
"examples": [
|
|
11447
|
-
"$ sf hardis:project:convert:profilestopermsets"
|
|
11448
|
-
],
|
|
11449
|
-
"flags": {
|
|
11450
|
-
"json": {
|
|
11451
|
-
"description": "Format output as json.",
|
|
11452
|
-
"helpGroup": "GLOBAL",
|
|
11453
|
-
"name": "json",
|
|
11454
|
-
"allowNo": false,
|
|
11455
|
-
"type": "boolean"
|
|
11456
|
-
},
|
|
11457
|
-
"flags-dir": {
|
|
11458
|
-
"helpGroup": "GLOBAL",
|
|
11459
|
-
"name": "flags-dir",
|
|
11460
|
-
"summary": "Import flag values from a directory.",
|
|
11461
|
-
"hasDynamicHelp": false,
|
|
11462
|
-
"multiple": false,
|
|
11463
|
-
"type": "option"
|
|
11464
|
-
},
|
|
11465
|
-
"except": {
|
|
11466
|
-
"char": "e",
|
|
11467
|
-
"description": "List of filters",
|
|
11468
|
-
"name": "except",
|
|
11469
|
-
"default": [],
|
|
11470
|
-
"hasDynamicHelp": false,
|
|
11471
|
-
"multiple": true,
|
|
11472
|
-
"type": "option"
|
|
11473
|
-
},
|
|
11474
|
-
"debug": {
|
|
11475
|
-
"char": "d",
|
|
11476
|
-
"description": "Activate debug mode (more logs)",
|
|
11477
|
-
"name": "debug",
|
|
11478
|
-
"allowNo": false,
|
|
11479
|
-
"type": "boolean"
|
|
11480
|
-
},
|
|
11481
|
-
"websocket": {
|
|
11482
|
-
"description": "Websocket host:port for VsCode SFDX Hardis UI integration",
|
|
11483
|
-
"name": "websocket",
|
|
11484
|
-
"hasDynamicHelp": false,
|
|
11485
|
-
"multiple": false,
|
|
11486
|
-
"type": "option"
|
|
11487
|
-
},
|
|
11488
|
-
"skipauth": {
|
|
11489
|
-
"description": "Skip authentication check when a default username is required",
|
|
11490
|
-
"name": "skipauth",
|
|
11491
|
-
"allowNo": false,
|
|
11492
|
-
"type": "boolean"
|
|
11493
|
-
}
|
|
11494
|
-
},
|
|
11495
|
-
"hasDynamicHelp": false,
|
|
11496
|
-
"hiddenAliases": [],
|
|
11497
|
-
"id": "hardis:project:convert:profilestopermsets",
|
|
11498
|
-
"pluginAlias": "sfdx-hardis",
|
|
11499
|
-
"pluginName": "sfdx-hardis",
|
|
11500
|
-
"pluginType": "core",
|
|
11501
|
-
"strict": true,
|
|
11502
|
-
"enableJsonFlag": true,
|
|
11503
|
-
"title": "Convert Profiles into Permission Sets",
|
|
11504
|
-
"requiresProject": true,
|
|
11505
|
-
"requiresSfdxPlugins": [
|
|
11506
|
-
"shane-sfdx-plugins"
|
|
11507
|
-
],
|
|
11508
|
-
"isESM": true,
|
|
11509
|
-
"relativePath": [
|
|
11510
|
-
"lib",
|
|
11511
|
-
"commands",
|
|
11512
|
-
"hardis",
|
|
11513
|
-
"project",
|
|
11514
|
-
"convert",
|
|
11515
|
-
"profilestopermsets.js"
|
|
11516
|
-
],
|
|
11517
|
-
"aliasPermutations": [],
|
|
11518
|
-
"permutations": [
|
|
11519
|
-
"hardis:project:convert:profilestopermsets",
|
|
11520
|
-
"project:hardis:convert:profilestopermsets",
|
|
11521
|
-
"project:convert:hardis:profilestopermsets",
|
|
11522
|
-
"project:convert:profilestopermsets:hardis",
|
|
11523
|
-
"hardis:convert:project:profilestopermsets",
|
|
11524
|
-
"convert:hardis:project:profilestopermsets",
|
|
11525
|
-
"convert:project:hardis:profilestopermsets",
|
|
11526
|
-
"convert:project:profilestopermsets:hardis",
|
|
11527
|
-
"hardis:convert:profilestopermsets:project",
|
|
11528
|
-
"convert:hardis:profilestopermsets:project",
|
|
11529
|
-
"convert:profilestopermsets:hardis:project",
|
|
11530
|
-
"convert:profilestopermsets:project:hardis",
|
|
11531
|
-
"hardis:project:profilestopermsets:convert",
|
|
11532
|
-
"project:hardis:profilestopermsets:convert",
|
|
11533
|
-
"project:profilestopermsets:hardis:convert",
|
|
11534
|
-
"project:profilestopermsets:convert:hardis",
|
|
11535
|
-
"hardis:profilestopermsets:project:convert",
|
|
11536
|
-
"profilestopermsets:hardis:project:convert",
|
|
11537
|
-
"profilestopermsets:project:hardis:convert",
|
|
11538
|
-
"profilestopermsets:project:convert:hardis",
|
|
11539
|
-
"hardis:profilestopermsets:convert:project",
|
|
11540
|
-
"profilestopermsets:hardis:convert:project",
|
|
11541
|
-
"profilestopermsets:convert:hardis:project",
|
|
11542
|
-
"profilestopermsets:convert:project:hardis"
|
|
11543
|
-
]
|
|
11544
|
-
},
|
|
11545
11545
|
"hardis:project:deploy:notify": {
|
|
11546
11546
|
"aliases": [],
|
|
11547
11547
|
"args": {},
|
|
@@ -15505,5 +15505,5 @@
|
|
|
15505
15505
|
]
|
|
15506
15506
|
}
|
|
15507
15507
|
},
|
|
15508
|
-
"version": "6.11.
|
|
15508
|
+
"version": "6.11.5"
|
|
15509
15509
|
}
|