pastoralist 0.1.2 → 0.1.3
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 +23 -6
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -10,17 +10,19 @@ To maintain a secure `node_module` ecosystem, the `package.json` keys `overrides
|
|
|
10
10
|
**Pastoralist** manages `overrides` and `resolutions` so you don't have to!
|
|
11
11
|
## How Pastoralist works
|
|
12
12
|
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
-
|
|
13
|
+
Pastoralist is comprised of a few functions which read `node_module` `package.json` and reduce any `overrides` or `resolutions` within the root `package.json` into a single `appendix` object.
|
|
14
|
+
|
|
15
|
+
- Pastoralist adds an `appendix` with a list of "resolved" dependencies into a `pastoralist` key.
|
|
16
|
+
- Better yet, if Pastoralist observes an `override` or `resolution` is no longer needed, it removes it from `resolutions`, `overrides`, and the pastoralist `appendix` object.
|
|
17
|
+
- This means with Pastoralist, your **only** concern is adding dependencies to the `overrides` and `resolutions` objects.
|
|
16
18
|
|
|
17
19
|
### Key notes
|
|
18
20
|
|
|
19
21
|
- Pastoralist does **not** manage what is added to overrides and resolutions objects.
|
|
20
|
-
- Pastoralist **does** manage
|
|
22
|
+
- Pastoralist **does** manage dependenceis that exists in a `package.json`'s overrides or resolutions objects.
|
|
21
23
|
- Pastoralist will remove overrides and resolutions if they become unneeded according to child `package.json`'s spec!
|
|
22
24
|
|
|
23
|
-
##
|
|
25
|
+
## Install
|
|
24
26
|
|
|
25
27
|
```sh
|
|
26
28
|
npm install pastoralist --save-dev
|
|
@@ -29,7 +31,7 @@ npm install pastoralist --save-dev
|
|
|
29
31
|
|
|
30
32
|
## Usage
|
|
31
33
|
|
|
32
|
-
Pastoralist is built to be used as a CLI program
|
|
34
|
+
Pastoralist is built to be used as a CLI program and runs with a single word "pastoralist".`
|
|
33
35
|
|
|
34
36
|
```sh
|
|
35
37
|
pastoralist
|
|
@@ -38,6 +40,21 @@ pastoralist
|
|
|
38
40
|
|
|
39
41
|
Pastoralist can _and should be incorporated_ into your workflow—which ever way is best for you and your team's developer experience! 👌
|
|
40
42
|
|
|
43
|
+
### Example output
|
|
44
|
+
|
|
45
|
+
```js
|
|
46
|
+
// package.json
|
|
47
|
+
"overrides": {
|
|
48
|
+
"trim": "^0.0.3"
|
|
49
|
+
},
|
|
50
|
+
"pastoralist": {
|
|
51
|
+
"appendix": {
|
|
52
|
+
"trim@^0.0.3": {
|
|
53
|
+
"remark-parse": "4.0.0"
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
}
|
|
57
|
+
```
|
|
41
58
|
|
|
42
59
|
## Roadmap
|
|
43
60
|
|