sf-decomposer 5.4.0 → 5.4.1
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 +7 -0
- package/README.md +12 -5
- package/oclif.lock +9 -9
- package/oclif.manifest.json +1 -1
- package/package.json +3 -2
package/CHANGELOG.md
CHANGED
|
@@ -5,6 +5,13 @@
|
|
|
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.4.1](https://github.com/mcarvin8/sf-decomposer/compare/v5.4.0...v5.4.1) (2025-03-14)
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
### Bug Fixes
|
|
12
|
+
|
|
13
|
+
* **deps:** bump @salesforce/source-deploy-retrieve ([e636bb9](https://github.com/mcarvin8/sf-decomposer/commit/e636bb975a661e7018c99bbf17f359ac7c86747b))
|
|
14
|
+
|
|
8
15
|
## [5.4.0](https://github.com/mcarvin8/sf-decomposer/compare/v5.3.13...v5.4.0) (2025-03-07)
|
|
9
16
|
|
|
10
17
|
|
package/README.md
CHANGED
|
@@ -21,6 +21,7 @@
|
|
|
21
21
|
- [`.sfdecomposerignore`](#.sfdecomposerignore)
|
|
22
22
|
- [`.gitignore`](#.gitignore)
|
|
23
23
|
- [Issues](#issues)
|
|
24
|
+
- [Built With](#built-with)
|
|
24
25
|
- [Contributing](#contributing)
|
|
25
26
|
- [License](#license)
|
|
26
27
|
</details>
|
|
@@ -45,9 +46,9 @@ sf decomposer decompose -m "flow" -m "labels"
|
|
|
45
46
|
|
|
46
47
|
> This is **REQUIRED** to avoid errors when running `sf`commands. See [Ignore Files](#ignore-files) section.
|
|
47
48
|
|
|
48
|
-
4. Stage files in version control
|
|
49
|
+
4. Stage decomposed files in version control
|
|
49
50
|
|
|
50
|
-
5. [Recompose](#sf-decomposer-recompose) the metadata type(s)
|
|
51
|
+
5. [Recompose](#sf-decomposer-recompose) the metadata type(s) before deployment
|
|
51
52
|
|
|
52
53
|
```bash
|
|
53
54
|
sf decomposer recompose -m "flow" -m "labels"
|
|
@@ -199,7 +200,7 @@ When custom labels are decomposed, each custom label will have its own file in t
|
|
|
199
200
|
|
|
200
201
|
All parent metadata types imported from this plugin's version of `@salesforce/source-deploy-retrieve` (SDR) toolkit are supported except for certain types.
|
|
201
202
|
|
|
202
|
-
The `--metadata-type`/`-m` flag should be the metadata's `suffix` value as listed in the [metadataRegistry.json](https://github.com/forcedotcom/source-deploy-retrieve/blob/main/src/registry/metadataRegistry.json).
|
|
203
|
+
The `--metadata-type`/`-m` flag should be the metadata's `suffix` value as listed in the [metadataRegistry.json](https://github.com/forcedotcom/source-deploy-retrieve/blob/main/src/registry/metadataRegistry.json). You can also infer the suffix by looking at the original XML file-name, i.e. `*.{suffix}-meta.xml`.
|
|
203
204
|
|
|
204
205
|
Here are some examples:
|
|
205
206
|
|
|
@@ -210,7 +211,6 @@ Here are some examples:
|
|
|
210
211
|
- AI Scoring Model Definition (`--metadata-type "aiScoringModelDefinition"`)
|
|
211
212
|
- Decision Matrix Definition (`--metadata-type "decisionMatrixDefinition"`)
|
|
212
213
|
- Bot (`--metadata-type "bot"`)
|
|
213
|
-
- **NOTE**: Running "bot" will also decompose and recompose Bot Version meta files. The `botVersion` meta suffix will be blocked from running directly.
|
|
214
214
|
- Marketing App Extension (`--metadata-type "marketingappextension"`)
|
|
215
215
|
|
|
216
216
|
### Metadata Exceptions
|
|
@@ -279,7 +279,7 @@ If `.sfdecomposer.config.json` isn't found, the hooks will be skipped.
|
|
|
279
279
|
|
|
280
280
|
The Salesforce CLI **must** ignore the decomposed files and allow the recomposed files.
|
|
281
281
|
|
|
282
|
-
You can use the sample [.forceignore](https://raw.githubusercontent.com/mcarvin8/sf-decomposer/main/samples/.forceignore) provided. Update the decomposed file extensions based on what format you're using (`.xml`, `.json`, or `.yaml`).
|
|
282
|
+
You can use the sample [.forceignore](https://raw.githubusercontent.com/mcarvin8/sf-decomposer/main/samples/.forceignore) provided. Update the decomposed file extensions based on what format you're using (`.xml`, `.json`, `.json5`, or `.yaml`).
|
|
283
283
|
|
|
284
284
|
### `.sfdecomposerignore`
|
|
285
285
|
|
|
@@ -303,6 +303,13 @@ You can use the sample [.gitignore](https://raw.githubusercontent.com/mcarvin8/s
|
|
|
303
303
|
|
|
304
304
|
If you encounter any bugs or would like to request features, please create an [issue](https://github.com/mcarvin8/sf-decomposer/issues).
|
|
305
305
|
|
|
306
|
+
## Built With
|
|
307
|
+
|
|
308
|
+
- [XML Disassembler](https://github.com/mcarvin8/xml-disassembler): Disassembles large XML files into smaller XML files and reassembles the original XML file when needed
|
|
309
|
+
- [XML2JSON Disassembler](https://github.com/mcarvin8/xml2json-disassembler): Disassembles large XML files into smaller JSON files and reassembles the original XML file when needed
|
|
310
|
+
- [XML2YAML Disassembler](https://github.com/mcarvin8/xml2yaml-disassembler): Disassembles large XML files into smaller YAML files and reassembles the original XML file when needed
|
|
311
|
+
- [XML2JSON5 Disassembler](https://github.com/mcarvin8/xml2json5-disassembler): Disassembles large XML files into smaller JSON5 files and reassembles the original XML file when needed
|
|
312
|
+
|
|
306
313
|
## Contributing
|
|
307
314
|
|
|
308
315
|
Contributions are welcome! See [Contributing](https://github.com/mcarvin8/sf-decomposer/blob/main/CONTRIBUTING.md).
|
package/oclif.lock
CHANGED
|
@@ -1500,10 +1500,10 @@
|
|
|
1500
1500
|
strip-ansi "6.0.1"
|
|
1501
1501
|
ts-retry-promise "^0.8.1"
|
|
1502
1502
|
|
|
1503
|
-
"@salesforce/core@^8.1.1", "@salesforce/core@^8.2.1", "@salesforce/core@^8.2.3", "@salesforce/core@^8.8.
|
|
1504
|
-
version "8.8.
|
|
1505
|
-
resolved "https://registry.yarnpkg.com/@salesforce/core/-/core-8.8.
|
|
1506
|
-
integrity sha512-
|
|
1503
|
+
"@salesforce/core@^8.1.1", "@salesforce/core@^8.2.1", "@salesforce/core@^8.2.3", "@salesforce/core@^8.8.5":
|
|
1504
|
+
version "8.8.5"
|
|
1505
|
+
resolved "https://registry.yarnpkg.com/@salesforce/core/-/core-8.8.5.tgz#4004e22523e4e45b42631733d06dc8aec9fdc23d"
|
|
1506
|
+
integrity sha512-eCiiO4NptvKkz04A4ivBVLzEBy/6IIFmaXoZ4tnF1FcD5MESvC+Xuc+0RFSRiYmPi5oloKNl6njrfVCKAho2zQ==
|
|
1507
1507
|
dependencies:
|
|
1508
1508
|
"@jsforce/jsforce-node" "^3.6.5"
|
|
1509
1509
|
"@salesforce/kit" "^3.2.2"
|
|
@@ -1596,12 +1596,12 @@
|
|
|
1596
1596
|
string-width "^7.2.0"
|
|
1597
1597
|
terminal-link "^3.0.0"
|
|
1598
1598
|
|
|
1599
|
-
"@salesforce/source-deploy-retrieve@^12.16.
|
|
1600
|
-
version "12.16.
|
|
1601
|
-
resolved "https://registry.yarnpkg.com/@salesforce/source-deploy-retrieve/-/source-deploy-retrieve-12.16.
|
|
1602
|
-
integrity sha512-
|
|
1599
|
+
"@salesforce/source-deploy-retrieve@^12.16.6":
|
|
1600
|
+
version "12.16.6"
|
|
1601
|
+
resolved "https://registry.yarnpkg.com/@salesforce/source-deploy-retrieve/-/source-deploy-retrieve-12.16.6.tgz#59237914564bf1c0a418089c4cc0a0498f01f9cc"
|
|
1602
|
+
integrity sha512-k0DHARp4dKUjn5JVSBF6YYfpBNU3jooRblXIoRN074gIeJs8mUcK4y5lL7Eck9FW0CPjbgWq7+5StvYQxFIODw==
|
|
1603
1603
|
dependencies:
|
|
1604
|
-
"@salesforce/core" "^8.8.
|
|
1604
|
+
"@salesforce/core" "^8.8.5"
|
|
1605
1605
|
"@salesforce/kit" "^3.2.3"
|
|
1606
1606
|
"@salesforce/ts-types" "^2.0.12"
|
|
1607
1607
|
"@salesforce/types" "^1.3.0"
|
package/oclif.manifest.json
CHANGED
package/package.json
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "sf-decomposer",
|
|
3
3
|
"description": "Break down large Salesforce metadata files into smaller, more manageable files for version control and then recreate deployment-compatible files.",
|
|
4
|
-
"version": "5.4.
|
|
4
|
+
"version": "5.4.1",
|
|
5
5
|
"dependencies": {
|
|
6
6
|
"@oclif/core": "^4",
|
|
7
7
|
"@salesforce/core": "^8.2.1",
|
|
8
8
|
"@salesforce/sf-plugins-core": "^11.2.1",
|
|
9
|
-
"@salesforce/source-deploy-retrieve": "^12.16.
|
|
9
|
+
"@salesforce/source-deploy-retrieve": "^12.16.6",
|
|
10
10
|
"fs-extra": "^11.2.0",
|
|
11
11
|
"xml-disassembler": "^1.3.13",
|
|
12
12
|
"xml2json-disassembler": "^1.1.13",
|
|
@@ -51,6 +51,7 @@
|
|
|
51
51
|
"xml",
|
|
52
52
|
"yaml",
|
|
53
53
|
"json",
|
|
54
|
+
"json5",
|
|
54
55
|
"decompose",
|
|
55
56
|
"reassemble",
|
|
56
57
|
"recompose",
|