sf-decomposer 5.10.0 → 5.10.2
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 +17 -0
- package/README.md +8 -4
- package/oclif.lock +353 -383
- package/oclif.manifest.json +1 -1
- package/package.json +7 -7
package/CHANGELOG.md
CHANGED
|
@@ -5,6 +5,23 @@
|
|
|
5
5
|
|
|
6
6
|
All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
|
|
7
7
|
|
|
8
|
+
## [5.10.2](https://github.com/mcarvin8/sf-decomposer/compare/v5.10.1...v5.10.2) (2025-05-13)
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
### Bug Fixes
|
|
12
|
+
|
|
13
|
+
* upgrade xml-disassembler ([9a5b00c](https://github.com/mcarvin8/sf-decomposer/commit/9a5b00c2724cdc29a1810e71c6e16cc87cfa9402))
|
|
14
|
+
|
|
15
|
+
## [5.10.1](https://github.com/mcarvin8/sf-decomposer/compare/v5.10.0...v5.10.1) (2025-05-07)
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
### Bug Fixes
|
|
19
|
+
|
|
20
|
+
* **deps:** bump @oclif/core from 4.2.10 to 4.3.0 ([75c3823](https://github.com/mcarvin8/sf-decomposer/commit/75c3823986147084dee2810652f1affd60cd0779))
|
|
21
|
+
* **deps:** bump @salesforce/core from 8.10.2 to 8.10.3 ([ed64781](https://github.com/mcarvin8/sf-decomposer/commit/ed6478160fb4e7cb4e9eb369291c089d88fe16ea))
|
|
22
|
+
* **deps:** bump @salesforce/source-deploy-retrieve ([be536bd](https://github.com/mcarvin8/sf-decomposer/commit/be536bde78ef1a2f4d68271c196e74528231a8cc))
|
|
23
|
+
* **deps:** bump xml-disassembler from 1.9.3 to 1.10.1 ([b83829a](https://github.com/mcarvin8/sf-decomposer/commit/b83829afb44c4946b872f27a7871bda5b8879816))
|
|
24
|
+
|
|
8
25
|
## [5.10.0](https://github.com/mcarvin8/sf-decomposer/compare/v5.9.2...v5.10.0) (2025-05-07)
|
|
9
26
|
|
|
10
27
|
|
package/README.md
CHANGED
|
@@ -11,8 +11,10 @@
|
|
|
11
11
|
- [Commands](#commands)
|
|
12
12
|
- [`sf decomposer decompose`](#sf-decomposer-decompose)
|
|
13
13
|
- [`sf decomposer recompose`](#sf-decomposer-recompose)
|
|
14
|
-
- [Decompose
|
|
14
|
+
- [Decompose Strategies](#decompose-strategies)
|
|
15
|
+
- [Custom Labels Decomposition](#custom-labels-decomposition)
|
|
15
16
|
- [Additional Permission Set Decomposition](#additional-permission-set-decomposition)
|
|
17
|
+
- [Additional Loyalty Program Setup Decomposition](#additional-loyalty-program-setup-decomposition)
|
|
16
18
|
- [Supported Metadata](#supported-metadata)
|
|
17
19
|
- [Exceptions](#exceptions)
|
|
18
20
|
- [Troubleshooting](#troubleshooting)
|
|
@@ -68,7 +70,7 @@ Salesforce's built-in decomposition has limitations. `sf-decomposer` offers more
|
|
|
68
70
|
- **Supports More Metadata** – Works with most Metadata API types, unlike Salesforce’s limited decomposition.
|
|
69
71
|
- **Selective Decomposition** – Decompose only what you need, avoiding Salesforce’s all-or-nothing approach.
|
|
70
72
|
- See [.sfdecomposerignore](#.sfdecomposerignore)
|
|
71
|
-
- **Multiple
|
|
73
|
+
- **Multiple [Decompose Strategies](#decompose-strategies)** – Choose between:
|
|
72
74
|
- `unique-id` (default): disassembles each nested element into its own uniquely named file based on XML content or hash.
|
|
73
75
|
- `grouped-by-tag`: groups all nested elements by tag into a single file per tag (e.g., all `<fieldPermissions>` in a permission set into `fieldPermissions.xml`).
|
|
74
76
|
- Additionally opt into further decomposition on permisison sets by using the `grouped-by-tag` strategy with the `--decompose-nested-permissions` flag.
|
|
@@ -172,7 +174,7 @@ EXAMPLES
|
|
|
172
174
|
|
|
173
175
|
```
|
|
174
176
|
|
|
175
|
-
## Decompose
|
|
177
|
+
## Decompose Strategies
|
|
176
178
|
|
|
177
179
|
> Ensure you do not MIX strategies on the same metadata type. If you have previously decomposed metadata with a past verson of `sf-decomposer`, which uses the unique-id strategy, and would like to switch over to the grouped-by-tag strategy, you will need to supply the decompose command with the `--prepurge` flag and `-s "grouped-by-tag"` flag to re-create decomposed files with the new strategy.
|
|
178
180
|
|
|
@@ -205,6 +207,8 @@ Leaf elements (like `<userLicense>Salesforce</userLicense>`) are always grouped
|
|
|
205
207
|
| **TOML** | <br> |
|
|
206
208
|
| **INI** | <br> |
|
|
207
209
|
|
|
210
|
+
### Custom Labels Decomposition
|
|
211
|
+
|
|
208
212
|
Custom labels can only be decomposed via the `unique-id` strategy. If you attempt to decompose custom labels with the `grouped-by-tag` strategy, it will warn and skip decomposing custom labels.
|
|
209
213
|
|
|
210
214
|
Custom labels decomposed under the `unique-id` strategy will look like such, each label will have its own file:
|
|
@@ -227,7 +231,7 @@ The `grouped-by-id` strategy isn't an ideal strategy to decompose loyalty progra
|
|
|
227
231
|
|
|
228
232
|
`You cannot decompose loyaltyProgramSetup using the grouped-by-tag strategy. Please switch strategies and try again for loyaltyProgramSetup.`
|
|
229
233
|
|
|
230
|
-
**NOTE**: I would suggest only recomposing loyalty program setup metadata
|
|
234
|
+
**NOTE**: I would suggest only recomposing loyalty program setup metadata in a version control system or in a CI/CD pipeline where changes can easily be discarded. In order to recompose them correctly, I have to delete the decomposed files (ignoring whatever value the `--postpurge` flag is set to) since it requires multi-level recomposition. Using a VCS or a CI pipeline will allow you to easily restore the decomposed files in your repo.
|
|
231
235
|
|
|
232
236
|
<br>
|
|
233
237
|
|