pastoralist 0.0.10 β 0.1.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/README.md +23 -16
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,39 +1,46 @@
|
|
|
1
|
-
# Pastoralist
|
|
1
|
+
# Pastoralist
|
|
2
2
|
|
|
3
|
-
A tool to watch over node module
|
|
3
|
+
A tool to watch over node module *`overrides` and *`resolutions` π π©π½βπΎ
|
|
4
4
|
|
|
5
|
-
>
|
|
5
|
+
> \***overrides and resolutions**: throughout this repository the key words "overrides" and "resolutions" are used interchangeably because nomenclature between npm, pnpm, and yarn varies. However, the reason and resolution are the same! Use Pastoralist!
|
|
6
6
|
## Synopsis
|
|
7
7
|
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
Pastoralist manages node overrides and resolutions so you don't have to.
|
|
8
|
+
To maintain a secure `node_module` ecosystem, the `package.json` keys `overrides` and `resolutions` have implemented to be by [npm](https://www.npmjs.com/), [yarn](https://yarnpkg.com/), and [pnpm](https://pnpm.io/) to provide developers with a last-resort way to fix dependency vulnerabilities.
|
|
11
9
|
|
|
10
|
+
**Pastoralist** manages `overrides` and `resolutions` so you don't have to!
|
|
12
11
|
## How Pastoralist works
|
|
13
12
|
|
|
14
|
-
|
|
13
|
+
- It adds an `appendix` to a `pastoralist` key within a project's `package.json` which lists dependencies that are dependent on the `overrides` and `resolutions` keys.
|
|
14
|
+
- Better yet, if Pastoralist observes an `override` or `resolution` is no longer needed, it will remove it from the `resolutions`, `overrides`, and pastoralist `appendix` objects.
|
|
15
|
+
- This means developers only concern is adding dependencies to the `overrides` and `resolutions` objects.
|
|
16
|
+
|
|
15
17
|
### Key notes
|
|
16
18
|
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
19
|
+
- Pastoralist does **not** manage what is added to overrides and resolutions objects.
|
|
20
|
+
- Pastoralist **does** manage packages that exists in the overrides or resolutions objects.
|
|
21
|
+
- Pastoralist will remove overrides and resolutions if they become unneeded according to child `package.json`'s spec!
|
|
20
22
|
|
|
21
23
|
## Inistall
|
|
22
24
|
|
|
23
25
|
```sh
|
|
24
26
|
npm install pastoralist --save-dev
|
|
25
|
-
# pastoralist does not expect to be a dependency! It's a tool
|
|
27
|
+
# pastoralist does not expect to be a dependency! It's a tool!!!
|
|
26
28
|
```
|
|
27
29
|
|
|
28
30
|
## Usage
|
|
29
31
|
|
|
30
|
-
Pastoralist is built to be used as a CLI program
|
|
31
|
-
### Basic
|
|
32
|
+
Pastoralist is built to be used as a CLI program which runs initially with a single word "pastoralist".`
|
|
32
33
|
|
|
33
34
|
```sh
|
|
34
|
-
pastoralist
|
|
35
|
+
pastoralist
|
|
36
|
+
# => That's it! Chack out your package json
|
|
35
37
|
```
|
|
36
38
|
|
|
37
|
-
|
|
39
|
+
Pastoralist can _and should be incorporated_ into your workflowβwhich ever way is best for you and your team's developer experience! π
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
## Roadmap
|
|
38
43
|
|
|
39
|
-
|
|
44
|
+
- [ ] More tests
|
|
45
|
+
- [ ] Provide more configuration options using a tool like [cosmiconfig](https://github.com/davidtheclark/cosmiconfig).
|
|
46
|
+
- [ ] Provide caveats, code examples, and more documentation.
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "pastoralist",
|
|
3
|
-
"version": "0.
|
|
4
|
-
"description": "
|
|
3
|
+
"version": "0.1.2",
|
|
4
|
+
"description": "A tool to watch over node module resolutions and overrides π π©π½βπΎ",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
7
7
|
"files": [
|