sfdx-hardis 5.11.0 → 5.12.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 -1
- package/lib/commands/hardis/doc/mkdocs-to-salesforce.d.ts +15 -0
- package/lib/commands/hardis/doc/mkdocs-to-salesforce.js +239 -0
- package/lib/commands/hardis/doc/mkdocs-to-salesforce.js.map +1 -0
- package/lib/commands/hardis/doc/packagexml2markdown.js +4 -2
- package/lib/commands/hardis/doc/packagexml2markdown.js.map +1 -1
- package/lib/commands/hardis/doc/project2markdown.js +7 -5
- package/lib/commands/hardis/doc/project2markdown.js.map +1 -1
- package/lib/commands/hardis/org/monitor/backup.js +8 -1
- package/lib/commands/hardis/org/monitor/backup.js.map +1 -1
- package/lib/commands/hardis/org/user/activateinvalid.js +2 -2
- package/lib/commands/hardis/org/user/activateinvalid.js.map +1 -1
- package/lib/commands/hardis/org/user/freeze.js +1 -1
- package/lib/commands/hardis/org/user/freeze.js.map +1 -1
- package/lib/commands/hardis/org/user/unfreeze.js +1 -1
- package/lib/commands/hardis/org/user/unfreeze.js.map +1 -1
- package/lib/commands/hardis/project/deploy/smart.js +2 -1
- package/lib/commands/hardis/project/deploy/smart.js.map +1 -1
- package/lib/common/gitProvider/github.js +8 -8
- package/lib/common/gitProvider/github.js.map +1 -1
- package/lib/common/gitProvider/index.js +4 -1
- package/lib/common/gitProvider/index.js.map +1 -1
- package/lib/common/utils/docUtils.d.ts +15 -1
- package/lib/common/utils/docUtils.js +113 -3
- package/lib/common/utils/docUtils.js.map +1 -1
- package/lib/common/utils/flowVisualiser/flowParser.js +1 -1
- package/lib/common/utils/flowVisualiser/flowParser.js.map +1 -1
- package/lib/common/utils/mermaidUtils.d.ts +1 -0
- package/lib/common/utils/mermaidUtils.js +27 -3
- package/lib/common/utils/mermaidUtils.js.map +1 -1
- package/lib/common/utils/orgUtils.js +1 -1
- package/lib/common/utils/orgUtils.js.map +1 -1
- package/lib/hooks/init/check-local-sfdx-hardis-files.js +2 -1
- package/lib/hooks/init/check-local-sfdx-hardis-files.js.map +1 -1
- package/oclif.lock +102 -107
- package/oclif.manifest.json +188 -59
- package/package.json +5 -5
package/oclif.manifest.json
CHANGED
|
@@ -57,12 +57,12 @@
|
|
|
57
57
|
"world:hello"
|
|
58
58
|
]
|
|
59
59
|
},
|
|
60
|
-
"hardis:
|
|
60
|
+
"hardis:cache:clear": {
|
|
61
61
|
"aliases": [],
|
|
62
62
|
"args": {},
|
|
63
|
-
"description": "
|
|
63
|
+
"description": "Clear cache generated by sfdx-hardis",
|
|
64
64
|
"examples": [
|
|
65
|
-
"$ sf hardis:
|
|
65
|
+
"$ sf hardis:cache:clear"
|
|
66
66
|
],
|
|
67
67
|
"flags": {
|
|
68
68
|
"json": {
|
|
@@ -80,28 +80,6 @@
|
|
|
80
80
|
"multiple": false,
|
|
81
81
|
"type": "option"
|
|
82
82
|
},
|
|
83
|
-
"instanceurl": {
|
|
84
|
-
"char": "r",
|
|
85
|
-
"description": "URL of org instance",
|
|
86
|
-
"name": "instanceurl",
|
|
87
|
-
"hasDynamicHelp": false,
|
|
88
|
-
"multiple": false,
|
|
89
|
-
"type": "option"
|
|
90
|
-
},
|
|
91
|
-
"devhub": {
|
|
92
|
-
"char": "h",
|
|
93
|
-
"description": "Also connect associated DevHub",
|
|
94
|
-
"name": "devhub",
|
|
95
|
-
"allowNo": false,
|
|
96
|
-
"type": "boolean"
|
|
97
|
-
},
|
|
98
|
-
"scratchorg": {
|
|
99
|
-
"char": "s",
|
|
100
|
-
"description": "Scratch org",
|
|
101
|
-
"name": "scratchorg",
|
|
102
|
-
"allowNo": false,
|
|
103
|
-
"type": "boolean"
|
|
104
|
-
},
|
|
105
83
|
"debug": {
|
|
106
84
|
"char": "d",
|
|
107
85
|
"description": "Activate debug mode (more logs)",
|
|
@@ -125,38 +103,38 @@
|
|
|
125
103
|
},
|
|
126
104
|
"hasDynamicHelp": false,
|
|
127
105
|
"hiddenAliases": [],
|
|
128
|
-
"id": "hardis:
|
|
106
|
+
"id": "hardis:cache:clear",
|
|
129
107
|
"pluginAlias": "sfdx-hardis",
|
|
130
108
|
"pluginName": "sfdx-hardis",
|
|
131
109
|
"pluginType": "core",
|
|
132
110
|
"strict": true,
|
|
133
111
|
"enableJsonFlag": true,
|
|
134
|
-
"title": "
|
|
112
|
+
"title": "Clear sfdx-hardis cache",
|
|
135
113
|
"requiresProject": false,
|
|
136
114
|
"isESM": true,
|
|
137
115
|
"relativePath": [
|
|
138
116
|
"lib",
|
|
139
117
|
"commands",
|
|
140
118
|
"hardis",
|
|
141
|
-
"
|
|
142
|
-
"
|
|
119
|
+
"cache",
|
|
120
|
+
"clear.js"
|
|
143
121
|
],
|
|
144
122
|
"aliasPermutations": [],
|
|
145
123
|
"permutations": [
|
|
146
|
-
"hardis:
|
|
147
|
-
"
|
|
148
|
-
"
|
|
149
|
-
"hardis:
|
|
150
|
-
"
|
|
151
|
-
"
|
|
124
|
+
"hardis:cache:clear",
|
|
125
|
+
"cache:hardis:clear",
|
|
126
|
+
"cache:clear:hardis",
|
|
127
|
+
"hardis:clear:cache",
|
|
128
|
+
"clear:hardis:cache",
|
|
129
|
+
"clear:cache:hardis"
|
|
152
130
|
]
|
|
153
131
|
},
|
|
154
|
-
"hardis:
|
|
132
|
+
"hardis:auth:login": {
|
|
155
133
|
"aliases": [],
|
|
156
134
|
"args": {},
|
|
157
|
-
"description": "
|
|
135
|
+
"description": "Login to salesforce org",
|
|
158
136
|
"examples": [
|
|
159
|
-
"$ sf hardis:
|
|
137
|
+
"$ sf hardis:auth:login"
|
|
160
138
|
],
|
|
161
139
|
"flags": {
|
|
162
140
|
"json": {
|
|
@@ -174,6 +152,28 @@
|
|
|
174
152
|
"multiple": false,
|
|
175
153
|
"type": "option"
|
|
176
154
|
},
|
|
155
|
+
"instanceurl": {
|
|
156
|
+
"char": "r",
|
|
157
|
+
"description": "URL of org instance",
|
|
158
|
+
"name": "instanceurl",
|
|
159
|
+
"hasDynamicHelp": false,
|
|
160
|
+
"multiple": false,
|
|
161
|
+
"type": "option"
|
|
162
|
+
},
|
|
163
|
+
"devhub": {
|
|
164
|
+
"char": "h",
|
|
165
|
+
"description": "Also connect associated DevHub",
|
|
166
|
+
"name": "devhub",
|
|
167
|
+
"allowNo": false,
|
|
168
|
+
"type": "boolean"
|
|
169
|
+
},
|
|
170
|
+
"scratchorg": {
|
|
171
|
+
"char": "s",
|
|
172
|
+
"description": "Scratch org",
|
|
173
|
+
"name": "scratchorg",
|
|
174
|
+
"allowNo": false,
|
|
175
|
+
"type": "boolean"
|
|
176
|
+
},
|
|
177
177
|
"debug": {
|
|
178
178
|
"char": "d",
|
|
179
179
|
"description": "Activate debug mode (more logs)",
|
|
@@ -197,30 +197,30 @@
|
|
|
197
197
|
},
|
|
198
198
|
"hasDynamicHelp": false,
|
|
199
199
|
"hiddenAliases": [],
|
|
200
|
-
"id": "hardis:
|
|
200
|
+
"id": "hardis:auth:login",
|
|
201
201
|
"pluginAlias": "sfdx-hardis",
|
|
202
202
|
"pluginName": "sfdx-hardis",
|
|
203
203
|
"pluginType": "core",
|
|
204
204
|
"strict": true,
|
|
205
205
|
"enableJsonFlag": true,
|
|
206
|
-
"title": "
|
|
206
|
+
"title": "Login",
|
|
207
207
|
"requiresProject": false,
|
|
208
208
|
"isESM": true,
|
|
209
209
|
"relativePath": [
|
|
210
210
|
"lib",
|
|
211
211
|
"commands",
|
|
212
212
|
"hardis",
|
|
213
|
-
"
|
|
214
|
-
"
|
|
213
|
+
"auth",
|
|
214
|
+
"login.js"
|
|
215
215
|
],
|
|
216
216
|
"aliasPermutations": [],
|
|
217
217
|
"permutations": [
|
|
218
|
-
"hardis:
|
|
219
|
-
"
|
|
220
|
-
"
|
|
221
|
-
"hardis:
|
|
222
|
-
"
|
|
223
|
-
"
|
|
218
|
+
"hardis:auth:login",
|
|
219
|
+
"auth:hardis:login",
|
|
220
|
+
"auth:login:hardis",
|
|
221
|
+
"hardis:login:auth",
|
|
222
|
+
"login:hardis:auth",
|
|
223
|
+
"login:auth:hardis"
|
|
224
224
|
]
|
|
225
225
|
},
|
|
226
226
|
"hardis:config:get": {
|
|
@@ -404,6 +404,106 @@
|
|
|
404
404
|
"flow2markdown:doc:hardis"
|
|
405
405
|
]
|
|
406
406
|
},
|
|
407
|
+
"hardis:doc:mkdocs-to-salesforce": {
|
|
408
|
+
"aliases": [],
|
|
409
|
+
"args": {},
|
|
410
|
+
"description": "Generates MkDocs HTML pages and upload them to Salesforce as a static resource\n\nThis command performs the following operations:\n\n- Generates MkDocs HTML pages (using locally installed mkdocs-material, or using mkdocs docker image)\n- Creates a Static Resource, a VisualForce page and a Custom Tab metadata\n- Upload the metadatas to the default org\n- Opens the Custom Tab in the default browser (only if not in CI context)\n\nNote: the documentation must have been previously generated using \"sf hardis:doc:project2markdown --with-history\"\n\nYou can:\n\n- Specify the type of documentation to generate (CICD or Monitoring) using the --type flag. Default is CICD.\n- Override default styles by customizing mkdocs.yml\n\nMore info on [Documentation section](https://sfdx-hardis.cloudity.com/salesforce-project-documentation/)\n",
|
|
411
|
+
"examples": [
|
|
412
|
+
"$ sf hardis:doc:mkdocs-to-salesforce"
|
|
413
|
+
],
|
|
414
|
+
"flags": {
|
|
415
|
+
"json": {
|
|
416
|
+
"description": "Format output as json.",
|
|
417
|
+
"helpGroup": "GLOBAL",
|
|
418
|
+
"name": "json",
|
|
419
|
+
"allowNo": false,
|
|
420
|
+
"type": "boolean"
|
|
421
|
+
},
|
|
422
|
+
"flags-dir": {
|
|
423
|
+
"helpGroup": "GLOBAL",
|
|
424
|
+
"name": "flags-dir",
|
|
425
|
+
"summary": "Import flag values from a directory.",
|
|
426
|
+
"hasDynamicHelp": false,
|
|
427
|
+
"multiple": false,
|
|
428
|
+
"type": "option"
|
|
429
|
+
},
|
|
430
|
+
"type": {
|
|
431
|
+
"char": "t",
|
|
432
|
+
"description": "Type of the documentation to generate. Default is \"all\"",
|
|
433
|
+
"name": "type",
|
|
434
|
+
"default": "CICD",
|
|
435
|
+
"hasDynamicHelp": false,
|
|
436
|
+
"multiple": false,
|
|
437
|
+
"options": [
|
|
438
|
+
"CICD",
|
|
439
|
+
"Monitoring"
|
|
440
|
+
],
|
|
441
|
+
"type": "option"
|
|
442
|
+
},
|
|
443
|
+
"debug": {
|
|
444
|
+
"char": "d",
|
|
445
|
+
"description": "Activate debug mode (more logs)",
|
|
446
|
+
"name": "debug",
|
|
447
|
+
"allowNo": false,
|
|
448
|
+
"type": "boolean"
|
|
449
|
+
},
|
|
450
|
+
"websocket": {
|
|
451
|
+
"description": "Websocket host:port for VsCode SFDX Hardis UI integration",
|
|
452
|
+
"name": "websocket",
|
|
453
|
+
"hasDynamicHelp": false,
|
|
454
|
+
"multiple": false,
|
|
455
|
+
"type": "option"
|
|
456
|
+
},
|
|
457
|
+
"skipauth": {
|
|
458
|
+
"description": "Skip authentication check when a default username is required",
|
|
459
|
+
"name": "skipauth",
|
|
460
|
+
"allowNo": false,
|
|
461
|
+
"type": "boolean"
|
|
462
|
+
},
|
|
463
|
+
"target-org": {
|
|
464
|
+
"aliases": [
|
|
465
|
+
"targetusername",
|
|
466
|
+
"u"
|
|
467
|
+
],
|
|
468
|
+
"char": "o",
|
|
469
|
+
"deprecateAliases": true,
|
|
470
|
+
"name": "target-org",
|
|
471
|
+
"noCacheDefault": true,
|
|
472
|
+
"required": true,
|
|
473
|
+
"summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
|
|
474
|
+
"hasDynamicHelp": true,
|
|
475
|
+
"multiple": false,
|
|
476
|
+
"type": "option"
|
|
477
|
+
}
|
|
478
|
+
},
|
|
479
|
+
"hasDynamicHelp": true,
|
|
480
|
+
"hiddenAliases": [],
|
|
481
|
+
"id": "hardis:doc:mkdocs-to-salesforce",
|
|
482
|
+
"pluginAlias": "sfdx-hardis",
|
|
483
|
+
"pluginName": "sfdx-hardis",
|
|
484
|
+
"pluginType": "core",
|
|
485
|
+
"strict": true,
|
|
486
|
+
"enableJsonFlag": true,
|
|
487
|
+
"title": "MkDocs to Salesforce",
|
|
488
|
+
"requiresProject": true,
|
|
489
|
+
"isESM": true,
|
|
490
|
+
"relativePath": [
|
|
491
|
+
"lib",
|
|
492
|
+
"commands",
|
|
493
|
+
"hardis",
|
|
494
|
+
"doc",
|
|
495
|
+
"mkdocs-to-salesforce.js"
|
|
496
|
+
],
|
|
497
|
+
"aliasPermutations": [],
|
|
498
|
+
"permutations": [
|
|
499
|
+
"hardis:doc:mkdocs-to-salesforce",
|
|
500
|
+
"doc:hardis:mkdocs-to-salesforce",
|
|
501
|
+
"doc:mkdocs-to-salesforce:hardis",
|
|
502
|
+
"hardis:mkdocs-to-salesforce:doc",
|
|
503
|
+
"mkdocs-to-salesforce:hardis:doc",
|
|
504
|
+
"mkdocs-to-salesforce:doc:hardis"
|
|
505
|
+
]
|
|
506
|
+
},
|
|
407
507
|
"hardis:doc:packagexml2markdown": {
|
|
408
508
|
"aliases": [],
|
|
409
509
|
"args": {},
|
|
@@ -463,9 +563,23 @@
|
|
|
463
563
|
"name": "skipauth",
|
|
464
564
|
"allowNo": false,
|
|
465
565
|
"type": "boolean"
|
|
566
|
+
},
|
|
567
|
+
"target-org": {
|
|
568
|
+
"aliases": [
|
|
569
|
+
"targetusername",
|
|
570
|
+
"u"
|
|
571
|
+
],
|
|
572
|
+
"char": "o",
|
|
573
|
+
"deprecateAliases": true,
|
|
574
|
+
"name": "target-org",
|
|
575
|
+
"noCacheDefault": true,
|
|
576
|
+
"summary": "Username or alias of the target org.",
|
|
577
|
+
"hasDynamicHelp": true,
|
|
578
|
+
"multiple": false,
|
|
579
|
+
"type": "option"
|
|
466
580
|
}
|
|
467
581
|
},
|
|
468
|
-
"hasDynamicHelp":
|
|
582
|
+
"hasDynamicHelp": true,
|
|
469
583
|
"hiddenAliases": [],
|
|
470
584
|
"id": "hardis:doc:packagexml2markdown",
|
|
471
585
|
"pluginAlias": "sfdx-hardis",
|
|
@@ -496,7 +610,7 @@
|
|
|
496
610
|
"hardis:doc:project2markdown": {
|
|
497
611
|
"aliases": [],
|
|
498
612
|
"args": {},
|
|
499
|
-
"description": "Generates a markdown documentation from a SFDX project\n\n- Package.xml files\n- Source Packages\n- sfdx-hardis configuration\n- Installed packages\n\nCan work on any sfdx project, no need for it to be a sfdx-hardis flavored one.\n\nGenerates markdown files will be written in **docs** folder (except README.md where a link to doc index is added)\n\nTo read Flow documentations if your markdown reader doesn't handle MermaidJS syntax, this command could require @mermaid-js/mermaid-cli\n\n- Run `npm install @mermaid-js/mermaid-cli --global` if puppeteer works in your environment\n- It can also be run as a docker image\n\nBoth modes will be tried by default, but you can also force one of them by defining environment variable `MERMAID_MODES=docker` or `MERMAID_MODES=cli`\n\n_sfdx-hardis docker image is alpine-based and does not succeed to run mermaid/puppeteer: if you can help, please submit a PR !_\n\nIf Flow history doc always display a single state, you probably need to update your workflow configuration:\n\n- on Gitlab: Env variable [`GIT_FETCH_EXTRA_FLAGS: --depth 10000`](https://github.com/hardisgroupcom/sfdx-hardis/blob/main/defaults/monitoring/.gitlab-ci.yml#L11)\n- on GitHub: [`fetch-depth: 0`](https://github.com/hardisgroupcom/sfdx-hardis/blob/main/defaults/monitoring/.github/workflows/org-monitoring.yml#L58)\n- on Azure: [`fetchDepth: \"0\"`](https://github.com/hardisgroupcom/sfdx-hardis/blob/main/defaults/monitoring/azure-pipelines.yml#L39)\n- on Bitbucket: [`step: clone: depth: full`](https://github.com/hardisgroupcom/sfdx-hardis/blob/main/defaults/monitoring/bitbucket-pipelines.yml#L18)\n\n\n\n\n\n\n\n## Doc HTML Pages\n\nTo read the documentation as HTML pages, run the following code (you need python on your computer)\n\n```python\npip install mkdocs-material mdx_truly_sane_lists\nmkdocs serve\n```\n\nTo just generate HTML pages that you can host anywhere, run `mkdocs build`\n\n",
|
|
613
|
+
"description": "Generates a markdown documentation from a SFDX project\n\n- Package.xml files\n- Source Packages\n- sfdx-hardis configuration\n- Installed packages\n\nCan work on any sfdx project, no need for it to be a sfdx-hardis flavored one.\n\nGenerates markdown files will be written in **docs** folder (except README.md where a link to doc index is added)\n\nTo read Flow documentations if your markdown reader doesn't handle MermaidJS syntax, this command could require @mermaid-js/mermaid-cli\n\n- Run `npm install @mermaid-js/mermaid-cli --global` if puppeteer works in your environment\n- It can also be run as a docker image\n\nBoth modes will be tried by default, but you can also force one of them by defining environment variable `MERMAID_MODES=docker` or `MERMAID_MODES=cli`\n\n_sfdx-hardis docker image is alpine-based and does not succeed to run mermaid/puppeteer: if you can help, please submit a PR !_\n\nIf Flow history doc always display a single state, you probably need to update your workflow configuration:\n\n- on Gitlab: Env variable [`GIT_FETCH_EXTRA_FLAGS: --depth 10000`](https://github.com/hardisgroupcom/sfdx-hardis/blob/main/defaults/monitoring/.gitlab-ci.yml#L11)\n- on GitHub: [`fetch-depth: 0`](https://github.com/hardisgroupcom/sfdx-hardis/blob/main/defaults/monitoring/.github/workflows/org-monitoring.yml#L58)\n- on Azure: [`fetchDepth: \"0\"`](https://github.com/hardisgroupcom/sfdx-hardis/blob/main/defaults/monitoring/azure-pipelines.yml#L39)\n- on Bitbucket: [`step: clone: depth: full`](https://github.com/hardisgroupcom/sfdx-hardis/blob/main/defaults/monitoring/bitbucket-pipelines.yml#L18)\n\n\n\n\n\n\n\n## Doc HTML Pages\n\nTo read the documentation as HTML pages, run the following code (you need [**Python**](https://www.python.org/downloads/) on your computer)\n\n```python\npip install mkdocs-material mdx_truly_sane_lists\nmkdocs serve\n```\n\nTo just generate HTML pages that you can host anywhere, run `mkdocs build`\n\n",
|
|
500
614
|
"examples": [
|
|
501
615
|
"$ sf hardis:doc:project2markdown",
|
|
502
616
|
"$ sf hardis:doc:project2markdown --with-history"
|
|
@@ -548,9 +662,23 @@
|
|
|
548
662
|
"name": "skipauth",
|
|
549
663
|
"allowNo": false,
|
|
550
664
|
"type": "boolean"
|
|
665
|
+
},
|
|
666
|
+
"target-org": {
|
|
667
|
+
"aliases": [
|
|
668
|
+
"targetusername",
|
|
669
|
+
"u"
|
|
670
|
+
],
|
|
671
|
+
"char": "o",
|
|
672
|
+
"deprecateAliases": true,
|
|
673
|
+
"name": "target-org",
|
|
674
|
+
"noCacheDefault": true,
|
|
675
|
+
"summary": "Username or alias of the target org.",
|
|
676
|
+
"hasDynamicHelp": true,
|
|
677
|
+
"multiple": false,
|
|
678
|
+
"type": "option"
|
|
551
679
|
}
|
|
552
680
|
},
|
|
553
|
-
"hasDynamicHelp":
|
|
681
|
+
"hasDynamicHelp": true,
|
|
554
682
|
"hiddenAliases": [],
|
|
555
683
|
"id": "hardis:doc:project2markdown",
|
|
556
684
|
"pluginAlias": "sfdx-hardis",
|
|
@@ -559,7 +687,7 @@
|
|
|
559
687
|
"strict": true,
|
|
560
688
|
"enableJsonFlag": true,
|
|
561
689
|
"title": "SFDX Project to Markdown",
|
|
562
|
-
"htmlInstructions": "## Doc HTML Pages\n\nTo read the documentation as HTML pages, run the following code (you need python on your computer)\n\n```python\npip install mkdocs-material mdx_truly_sane_lists\nmkdocs serve\n```\n\nTo just generate HTML pages that you can host anywhere, run `mkdocs build`\n",
|
|
690
|
+
"htmlInstructions": "## Doc HTML Pages\n\nTo read the documentation as HTML pages, run the following code (you need [**Python**](https://www.python.org/downloads/) on your computer)\n\n```python\npip install mkdocs-material mdx_truly_sane_lists\nmkdocs serve\n```\n\nTo just generate HTML pages that you can host anywhere, run `mkdocs build`\n",
|
|
563
691
|
"requiresProject": true,
|
|
564
692
|
"isESM": true,
|
|
565
693
|
"relativePath": [
|
|
@@ -6733,7 +6861,7 @@
|
|
|
6733
6861
|
"hardis:org:monitor:backup": {
|
|
6734
6862
|
"aliases": [],
|
|
6735
6863
|
"args": {},
|
|
6736
|
-
"description": "Retrieve sfdx sources in the context of a monitoring backup\n\nThe command exists in 2 modes: filtered(default & recommended) and full.\n\n## Filtered mode (default, better performances)\n\nAutomatically skips metadatas from installed packages with namespace. \n\nYou can remove more metadata types from backup, especially in case you have too many metadatas and that provokes a crash, using:\n\n- Manual update of `manifest/package-skip-items.xml` config file (then commit & push in the same branch)\n\n- Environment variable MONITORING_BACKUP_SKIP_METADATA_TYPES (example: `MONITORING_BACKUP_SKIP_METADATA_TYPES=CustomLabel,StaticResource,Translation`): that will be applied to all monitoring branches.\n\n## Full mode\n\nActivate it with **--full** parameter, or variable MONITORING_BACKUP_MODE_FULL=true\n\nIgnores filters (namespaces items & manifest/package-skip-items.xml) to retrieve ALL metadatas, including those you might not care about (reports, translations...)\n\nAs we can retrieve only 10000 files by call, the list of all metadatas will be chunked to make multiple calls (and take more time than filtered mode)\n\n- if you use `--full-apply-filters` , manifest/package-skip-items.xml and MONITORING_BACKUP_SKIP_METADATA_TYPES filters will be applied anyway\n- if you use `--exclude-namespaces` , namespaced items will be ignored\n\n_With those both options, it's like if you are not using --full, but with chunked metadata download_\n\n## In CI/CD\n\nThis command is part of [sfdx-hardis Monitoring](https://sfdx-hardis.cloudity.com/salesforce-monitoring-metadata-backup/) and can output Grafana, Slack and MsTeams Notifications.\n\n## Documentation\n\n[Doc generation (including visual flows)](https://sfdx-hardis.cloudity.com/hardis/doc/project2markdown/) is triggered at the end of the command.\n\nIf Flow history doc always display a single state, you probably need to update your workflow configuration:\n\n- on Gitlab: Env variable [`GIT_FETCH_EXTRA_FLAGS: --depth 10000`](https://github.com/hardisgroupcom/sfdx-hardis/blob/main/defaults/monitoring/.gitlab-ci.yml#L11)\n- on GitHub: [`fetch-depth: 0`](https://github.com/hardisgroupcom/sfdx-hardis/blob/main/defaults/monitoring/.github/workflows/org-monitoring.yml#L58)\n- on Azure: [`fetchDepth: \"0\"`](https://github.com/hardisgroupcom/sfdx-hardis/blob/main/defaults/monitoring/azure-pipelines.yml#L39)\n- on Bitbucket: [`step: clone: depth: full`](https://github.com/hardisgroupcom/sfdx-hardis/blob/main/defaults/monitoring/bitbucket-pipelines.yml#L18)\n",
|
|
6864
|
+
"description": "Retrieve sfdx sources in the context of a monitoring backup\n\nThe command exists in 2 modes: filtered(default & recommended) and full.\n\n## Filtered mode (default, better performances)\n\nAutomatically skips metadatas from installed packages with namespace. \n\nYou can remove more metadata types from backup, especially in case you have too many metadatas and that provokes a crash, using:\n\n- Manual update of `manifest/package-skip-items.xml` config file (then commit & push in the same branch)\n\n- Environment variable MONITORING_BACKUP_SKIP_METADATA_TYPES (example: `MONITORING_BACKUP_SKIP_METADATA_TYPES=CustomLabel,StaticResource,Translation`): that will be applied to all monitoring branches.\n\n## Full mode\n\nActivate it with **--full** parameter, or variable MONITORING_BACKUP_MODE_FULL=true\n\nIgnores filters (namespaces items & manifest/package-skip-items.xml) to retrieve ALL metadatas, including those you might not care about (reports, translations...)\n\nAs we can retrieve only 10000 files by call, the list of all metadatas will be chunked to make multiple calls (and take more time than filtered mode)\n\n- if you use `--full-apply-filters` , manifest/package-skip-items.xml and MONITORING_BACKUP_SKIP_METADATA_TYPES filters will be applied anyway\n- if you use `--exclude-namespaces` , namespaced items will be ignored\n\n_With those both options, it's like if you are not using --full, but with chunked metadata download_\n\n## In CI/CD\n\nThis command is part of [sfdx-hardis Monitoring](https://sfdx-hardis.cloudity.com/salesforce-monitoring-metadata-backup/) and can output Grafana, Slack and MsTeams Notifications.\n\n## Documentation\n\n[Doc generation (including visual flows)](https://sfdx-hardis.cloudity.com/hardis/doc/project2markdown/) is triggered at the end of the command.\n\nIf you want to also upload HTML Documentation on your Salesforce Org as static resource, use variable **SFDX_HARDIS_DOC_DEPLOY_TO_ORG=\"true\"**\n\nIf Flow history doc always display a single state, you probably need to update your workflow configuration:\n\n- on Gitlab: Env variable [`GIT_FETCH_EXTRA_FLAGS: --depth 10000`](https://github.com/hardisgroupcom/sfdx-hardis/blob/main/defaults/monitoring/.gitlab-ci.yml#L11)\n- on GitHub: [`fetch-depth: 0`](https://github.com/hardisgroupcom/sfdx-hardis/blob/main/defaults/monitoring/.github/workflows/org-monitoring.yml#L58)\n- on Azure: [`fetchDepth: \"0\"`](https://github.com/hardisgroupcom/sfdx-hardis/blob/main/defaults/monitoring/azure-pipelines.yml#L39)\n- on Bitbucket: [`step: clone: depth: full`](https://github.com/hardisgroupcom/sfdx-hardis/blob/main/defaults/monitoring/bitbucket-pipelines.yml#L18)\n",
|
|
6737
6865
|
"examples": [
|
|
6738
6866
|
"$ sf hardis:org:monitor:backup",
|
|
6739
6867
|
"$ sf hardis:org:monitor:backup --full",
|
|
@@ -7499,8 +7627,8 @@
|
|
|
7499
7627
|
"description": "Update sandbox users so their email is valid\n\n Example: replaces `toto@company.com.dev.invalid` with `toto@company.com.dev.invalid`\n\nSee article below\n\n[](https://nicolas.vuillamy.fr/reactivate-all-the-sandbox-users-with-invalid-emails-in-3-clicks-2265af4e3a3d)\n",
|
|
7500
7628
|
"examples": [
|
|
7501
7629
|
"$ sf hardis:org:user:activateinvalid",
|
|
7502
|
-
"$ sf hardis:org:user:activateinvalid --target-org
|
|
7503
|
-
"$ sf hardis:org:user:activateinvalid --profiles 'System Administrator,MyCustomProfile' --target-org
|
|
7630
|
+
"$ sf hardis:org:user:activateinvalid --target-org my-user@myorg.com",
|
|
7631
|
+
"$ sf hardis:org:user:activateinvalid --profiles 'System Administrator,MyCustomProfile' --target-org my-user@myorg.com"
|
|
7504
7632
|
],
|
|
7505
7633
|
"flags": {
|
|
7506
7634
|
"json": {
|
|
@@ -7615,7 +7743,7 @@
|
|
|
7615
7743
|
"description": "Mass freeze users in org before a maintenance or go live\n\nSee user guide in the following article\n\n<https://medium.com/@dimitrimonge/freeze-unfreeze-users-during-salesforce-deployment-8a1488bf8dd3>\n\n[](https://medium.com/@dimitrimonge/freeze-unfreeze-users-during-salesforce-deployment-8a1488bf8dd3)",
|
|
7616
7744
|
"examples": [
|
|
7617
7745
|
"$ sf hardis:org:user:freeze",
|
|
7618
|
-
"$ sf hardis:org:user:freeze --target-org
|
|
7746
|
+
"$ sf hardis:org:user:freeze --target-org my-user@myorg.com",
|
|
7619
7747
|
"$ sf hardis:org:user:freeze --includeprofiles 'Standard'",
|
|
7620
7748
|
"$ sf hardis:org:user:freeze --excludeprofiles 'System Administrator,Some Other Profile'"
|
|
7621
7749
|
],
|
|
@@ -7757,7 +7885,7 @@
|
|
|
7757
7885
|
"description": "Mass unfreeze users in org after a maintenance or go live\n\nSee user guide in the following article\n\n<https://medium.com/@dimitrimonge/freeze-unfreeze-users-during-salesforce-deployment-8a1488bf8dd3>\n\n[](https://medium.com/@dimitrimonge/freeze-unfreeze-users-during-salesforce-deployment-8a1488bf8dd3)",
|
|
7758
7886
|
"examples": [
|
|
7759
7887
|
"$ sf hardis:org:user:unfreeze",
|
|
7760
|
-
"$ sf hardis:org:user:unfreeze --target-org
|
|
7888
|
+
"$ sf hardis:org:user:unfreeze --target-org my-user@myorg.com",
|
|
7761
7889
|
"$ sf hardis:org:user:unfreeze --includeprofiles 'Standard'",
|
|
7762
7890
|
"$ sf hardis:org:user:unfreeze --excludeprofiles 'System Administrator,Some Other Profile'"
|
|
7763
7891
|
],
|
|
@@ -10764,7 +10892,8 @@
|
|
|
10764
10892
|
"$ sf hardis:project:deploy:smart",
|
|
10765
10893
|
"$ FORCE_TARGET_BRANCH=preprod NODE_OPTIONS=--inspect-brk sf hardis:project:deploy:smart --check --websocket localhost:2702 --skipauth --target-org nicolas.vuillamy@myclient.com.preprod",
|
|
10766
10894
|
"$ SYSTEM_ACCESSTOKEN=xxxxxx SYSTEM_COLLECTIONURI=https://dev.azure.com/xxxxxxx/ SYSTEM_TEAMPROJECT=\"xxxxxxx\" BUILD_REPOSITORY_ID=xxxxx SYSTEM_PULLREQUEST_PULLREQUESTID=1418 FORCE_TARGET_BRANCH=uat NODE_OPTIONS=--inspect-brk sf hardis:project:deploy:smart --check --websocket localhost:2702 --skipauth --target-org my.salesforce@org.com",
|
|
10767
|
-
"$ CI_SFDX_HARDIS_BITBUCKET_TOKEN=xxxxxx BITBUCKET_WORKSPACE=sfdxhardis-demo BITBUCKET_REPO_SLUG=test BITBUCKET_BUILD_NUMBER=1 BITBUCKET_BRANCH=uat BITBUCKET_PR_ID=2 FORCE_TARGET_BRANCH=uat NODE_OPTIONS=--inspect-brk sf hardis:project:deploy:smart --check --websocket localhost:2702 --skipauth --target-org my-salesforce-org@client.com"
|
|
10895
|
+
"$ CI_SFDX_HARDIS_BITBUCKET_TOKEN=xxxxxx BITBUCKET_WORKSPACE=sfdxhardis-demo BITBUCKET_REPO_SLUG=test BITBUCKET_BUILD_NUMBER=1 BITBUCKET_BRANCH=uat BITBUCKET_PR_ID=2 FORCE_TARGET_BRANCH=uat NODE_OPTIONS=--inspect-brk sf hardis:project:deploy:smart --check --websocket localhost:2702 --skipauth --target-org my-salesforce-org@client.com",
|
|
10896
|
+
"$ GITHUB_TOKEN=xxxx GITHUB_REPOSITORY=my-user/my-repo FORCE_TARGET_BRANCH=uat NODE_OPTIONS=--inspect-brk sf hardis:project:deploy:smart --check --websocket localhost:2702 --skipauth --target-org my-salesforce-org@client.com"
|
|
10768
10897
|
],
|
|
10769
10898
|
"flags": {
|
|
10770
10899
|
"json": {
|
|
@@ -14039,5 +14168,5 @@
|
|
|
14039
14168
|
]
|
|
14040
14169
|
}
|
|
14041
14170
|
},
|
|
14042
|
-
"version": "5.
|
|
14171
|
+
"version": "5.12.0"
|
|
14043
14172
|
}
|
package/package.json
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
"description": "Swiss-army-knife Toolbox for Salesforce.\n Allows you to define a complete CD/CD Pipeline.\n Orchestrate base commands and assist users with interactive wizards",
|
|
4
4
|
"author": "NicolasVuillamy @nvuillam",
|
|
5
5
|
"bugs": "https://github.com/hardisgroupcom/sfdx-hardis/issues",
|
|
6
|
-
"version": "5.
|
|
6
|
+
"version": "5.12.0",
|
|
7
7
|
"dependencies": {
|
|
8
8
|
"@actions/github": "^6.0.0",
|
|
9
9
|
"@gitbeaker/node": "^35.8.1",
|
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
"axios": "^1.7.9",
|
|
18
18
|
"azure-devops-node-api": "^14.1.0",
|
|
19
19
|
"bitbucket": "^2.12.0",
|
|
20
|
-
"chalk": "^5.
|
|
20
|
+
"chalk": "^5.4.1",
|
|
21
21
|
"chrome-launcher": "^1.1.2",
|
|
22
22
|
"columnify": "^1.6.0",
|
|
23
23
|
"cosmiconfig": "^9.0.0",
|
|
@@ -65,7 +65,7 @@
|
|
|
65
65
|
"xpath": "^0.0.34"
|
|
66
66
|
},
|
|
67
67
|
"devDependencies": {
|
|
68
|
-
"@oclif/plugin-command-snapshot": "^5.2.
|
|
68
|
+
"@oclif/plugin-command-snapshot": "^5.2.24",
|
|
69
69
|
"@salesforce/cli-plugins-testkit": "^5.3.39",
|
|
70
70
|
"@salesforce/dev-config": "^4.3.1",
|
|
71
71
|
"@salesforce/dev-scripts": "^10",
|
|
@@ -73,7 +73,7 @@
|
|
|
73
73
|
"@types/cosmiconfig": "^6.0.3",
|
|
74
74
|
"@types/cross-spawn": "^6.0.6",
|
|
75
75
|
"@types/diff": "^6.0.0",
|
|
76
|
-
"@types/extract-zip": "^2.0.
|
|
76
|
+
"@types/extract-zip": "^2.0.3",
|
|
77
77
|
"@types/fs-extra": "^11.0.4",
|
|
78
78
|
"@types/fs-readdir-recursive": "^1.1.3",
|
|
79
79
|
"@types/glob": "^8.1.0",
|
|
@@ -90,7 +90,7 @@
|
|
|
90
90
|
"@types/ws": "^8.5.13",
|
|
91
91
|
"@types/xml2js": "^0.4.14",
|
|
92
92
|
"eslint-plugin-sf-plugin": "^1.20.9",
|
|
93
|
-
"oclif": "^4.17.
|
|
93
|
+
"oclif": "^4.17.7",
|
|
94
94
|
"ts-node": "^10.9.2",
|
|
95
95
|
"typescript": "^5.7.2"
|
|
96
96
|
},
|