@ds-sfdc/sfparty 1.0.0-0 → 1.1.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/README.md CHANGED
@@ -13,6 +13,73 @@ npm i @ds-sfdc/sfparty
13
13
  ```
14
14
  ## Commands
15
15
 
16
- <!-- commands -->
16
+ ### Split
17
+ ```bash
18
+ sfparty split
19
+ ```
20
+
21
+ ### Combine
22
+ ```bash
23
+ sfparty combine
24
+ ```
25
+
26
+ ### Options
27
+
28
+ ```
29
+ -n, --name name of metadata file
30
+ -a, --all all metadata files of type will be processed
31
+ -s, --source package directory path specified in sfdx-project.json
32
+ -t, --target target path to directory to create yaml/json files
33
+ -h, --help Show help
34
+ ```
35
+ ## Examples
36
+ ### Custom Labels
37
+ ```bash
38
+ sfparty split --type=label
39
+ ```
40
+
41
+ ### Permission Set
42
+ ```bash
43
+ sfparty split --type=permset
44
+ sfparty split --type=permset --name="My Permission Set"
45
+ ```
46
+ ### Profile
47
+ ```bash
48
+ sfparty split --type=profile
49
+ sfparty split --type=profile --name="My Profile"
50
+ ```
51
+ ### Workflow
52
+ ```bash
53
+ sfparty split --type=workflow
54
+ sfparty split --type=workflow --name="Workflow"
55
+ ```
56
+ ### Source Directory
57
+ The source directory will use your default package folder as specified in the sfdx-project.json file, and therefore must be executed from your Salesforce project directory. It will create the main/default folders if they do not exist.
17
58
 
18
- <!-- commandsstop -->
59
+ ```
60
+ {
61
+ "packageDirectories": [
62
+ {
63
+ "path": "force-app",
64
+ "default": true
65
+ },
66
+ {
67
+ "path": "my-package"
68
+ }
69
+ ],
70
+ "namespace": "",
71
+ "sfdcLoginUrl": "https://login.salesforce.com",
72
+ "sourceApiVersion": "53.0"
73
+ }
74
+ ```
75
+
76
+ ```bash
77
+ sfparty split --source="my-package"
78
+ ```
79
+
80
+ ### Target Directory
81
+ The source directory will use your default package folder as specified in the sfdx-project.json file, and append `-party` to the end. For example, if the default source path is `force-app`, then the default target directory will be `force-app-party` unless otherwise specified. The target does not need to be specified in the sfdx-project.json, however the combine command will not work on folders that are not specified in the sfdx-project.json.
82
+
83
+ ```bash
84
+ sfparty split --target="test"
85
+ ```
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ds-sfdc/sfparty",
3
- "version": "1.0.0-0",
3
+ "version": "1.1.0",
4
4
  "description": "Salesforce metadata XML splitter for CI/CD",
5
5
  "type": "module",
6
6
  "repository": {