@simplysf/simply-data 2.1.8 → 2.1.9
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 +8 -47
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -10,56 +10,18 @@ sf plugins install @simplysf/simply-data
|
|
|
10
10
|
|
|
11
11
|
## Issues
|
|
12
12
|
|
|
13
|
-
Please report any issues at https://github.com/SimplySF/simply
|
|
13
|
+
Please report any issues at https://github.com/SimplySF/simply/issues
|
|
14
14
|
|
|
15
15
|
## Contributing
|
|
16
16
|
|
|
17
|
-
|
|
18
|
-
2. Create a new issue before starting your project so that we can keep track of
|
|
19
|
-
what you are trying to add/fix. That way, we can also offer suggestions or
|
|
20
|
-
let you know if there is already an effort in progress.
|
|
21
|
-
3. Fork this repository.
|
|
22
|
-
4. [Build the plugin locally](#build)
|
|
23
|
-
5. Create a _topic_ branch in your fork. Note, this step is recommended but technically not required if contributing using a fork.
|
|
24
|
-
6. Edit the code in your fork.
|
|
25
|
-
7. Write appropriate tests for your changes. Try to achieve at least 95% code coverage on any new code. No pull request will be accepted without unit tests.
|
|
26
|
-
8. Send us a pull request when you are done. We'll review your code, suggest any needed changes, and merge it in.
|
|
27
|
-
|
|
28
|
-
### Build
|
|
29
|
-
|
|
30
|
-
To build the plugin locally, make sure to have yarn installed and run the following commands:
|
|
31
|
-
|
|
32
|
-
```bash
|
|
33
|
-
# Clone the repository
|
|
34
|
-
git clone git@github.com:SimplySF/simply-data
|
|
35
|
-
|
|
36
|
-
# Install the dependencies and compile
|
|
37
|
-
yarn && yarn build
|
|
38
|
-
```
|
|
39
|
-
|
|
40
|
-
To use your plugin, run using the local `./bin/dev` or `./bin/dev.cmd` file.
|
|
41
|
-
|
|
42
|
-
```bash
|
|
43
|
-
# Run using local run file.
|
|
44
|
-
./bin/dev.cmd simply data
|
|
45
|
-
```
|
|
46
|
-
|
|
47
|
-
There should be no differences when running via the Salesforce CLI or using the local run file. However, it can be useful to link the plugin to do some additional testing or run your commands from anywhere on your machine.
|
|
48
|
-
|
|
49
|
-
```bash
|
|
50
|
-
# Link your plugin to the sf cli
|
|
51
|
-
sf plugins link .
|
|
52
|
-
# To verify
|
|
53
|
-
sf plugins
|
|
54
|
-
```
|
|
17
|
+
This package is part of the [`@simplysf/simply`](https://github.com/SimplySF/simply) monorepo. See the repo's [CONTRIBUTING.md](../../CONTRIBUTING.md) for the repo structure, how to set up and build the project, our commit conventions, and how to submit a pull request. Please also read our [Code of Conduct](../../CODE_OF_CONDUCT.md).
|
|
55
18
|
|
|
56
19
|
## Commands
|
|
57
20
|
|
|
58
21
|
<!-- commands -->
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
- [`sf simply data files upload`](#sf-simply-data-files-upload)
|
|
22
|
+
* [`sf simply data file upload`](#sf-simply-data-file-upload)
|
|
23
|
+
* [`sf simply data files download`](#sf-simply-data-files-download)
|
|
24
|
+
* [`sf simply data files upload`](#sf-simply-data-files-upload)
|
|
63
25
|
|
|
64
26
|
## `sf simply data file upload`
|
|
65
27
|
|
|
@@ -93,7 +55,7 @@ EXAMPLES
|
|
|
93
55
|
$ sf simply data file upload --file-path fileToUpload.txt --first-publish-location-id 0019000000DmehK --target-org myTargetOrg
|
|
94
56
|
```
|
|
95
57
|
|
|
96
|
-
_See code: [lib/commands/simply/data/file/upload.js](https://github.com/SimplySF/simply
|
|
58
|
+
_See code: [lib/commands/simply/data/file/upload.js](https://github.com/SimplySF/simply/blob/2.1.9/lib/commands/simply/data/file/upload.js)_
|
|
97
59
|
|
|
98
60
|
## `sf simply data files download`
|
|
99
61
|
|
|
@@ -138,7 +100,7 @@ FLAG DESCRIPTIONS
|
|
|
138
100
|
Provide a WHERE clause to allow the plugin to specify which ContentVersion records should be downloaded.
|
|
139
101
|
```
|
|
140
102
|
|
|
141
|
-
_See code: [lib/commands/simply/data/files/download.js](https://github.com/SimplySF/simply
|
|
103
|
+
_See code: [lib/commands/simply/data/files/download.js](https://github.com/SimplySF/simply/blob/2.1.9/lib/commands/simply/data/files/download.js)_
|
|
142
104
|
|
|
143
105
|
## `sf simply data files upload`
|
|
144
106
|
|
|
@@ -183,6 +145,5 @@ FLAG DESCRIPTIONS
|
|
|
183
145
|
quasi concurrent uploads. Please note that setting this value too high can cause performance issues.
|
|
184
146
|
```
|
|
185
147
|
|
|
186
|
-
_See code: [lib/commands/simply/data/files/upload.js](https://github.com/SimplySF/simply
|
|
187
|
-
|
|
148
|
+
_See code: [lib/commands/simply/data/files/upload.js](https://github.com/SimplySF/simply/blob/2.1.9/lib/commands/simply/data/files/upload.js)_
|
|
188
149
|
<!-- commandsstop -->
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@simplysf/simply-data",
|
|
3
3
|
"description": "Utilities for working with data",
|
|
4
|
-
"version": "2.1.
|
|
4
|
+
"version": "2.1.9",
|
|
5
5
|
"author": "@ClayChipps",
|
|
6
6
|
"homepage": "https://github.com/SimplySF/simply",
|
|
7
7
|
"bugs": "https://github.com/SimplySF/simply/issues",
|
|
@@ -212,5 +212,5 @@
|
|
|
212
212
|
"output": []
|
|
213
213
|
}
|
|
214
214
|
},
|
|
215
|
-
"gitHead": "
|
|
215
|
+
"gitHead": "da7382a69839e5df798bdbfe83f6f126f238dda3"
|
|
216
216
|
}
|