Skip to content

Commit d76a2ee

Browse files
committed
docs(shrinkwrap): remove minichain references from the npm-shrinkwrap.readme.md
1 parent b2596dd commit d76a2ee

File tree

1 file changed

+2
-31
lines changed

1 file changed

+2
-31
lines changed

npm-shrinkwrap.readme.md

Lines changed: 2 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ To add a new dependency do the following:
1818
2. make sure you are in sync with `upstream/master`
1919
3. ensure that your `node_modules` directory is not stale or poisoned by doing a clean install with `rm -rf node_modules && npm install`
2020
4. add a new dependency via `npm install -D <packagename>`
21-
5. update npm-shrinkwrap.json with `npm shrinkwrap --dev` (see note below about the `minichain` issue)
21+
5. update npm-shrinkwrap.json with `npm shrinkwrap --dev`
2222
6. run `./tools/npm/clean-shrinkwrap.js`
2323
7. these steps should change 3 files: `package.json`, `npm-shrinkwrap.json` and `npm-shrinkwrap.clean.json`
2424
8. commit changes to these three files and you are done
@@ -30,37 +30,8 @@ To update existing dependency do the following:
3030
2. make sure you are in sync with `upstream/master`: `git fetch upstream && git rebase upstream/master`
3131
3. ensure that your `node_modules` directory is not stale or poisoned by doing a clean install with `rm -rf node_modules && npm install`
3232
4. run `npm install -D <packagename>@<version|latest>` or `npm update <packagename>` to update to the latest version that matches version constraint in `package.json`
33-
5. relock the dependencies with `npm shrinkwrap --dev` (see note below about the `minichain` issue)
33+
5. relock the dependencies with `npm shrinkwrap --dev`
3434
6. clean up the shrinkwrap file for review with `./tools/npm/clean-shrinkwrap.js`
3535
7. these steps should change 2 files: `npm-shrinkwrap.json` and `npm-shrinkwrap.clean.json`. Optionally if you used `npm install ...` in the first step, `package.json` might be modified as well
3636
8. commit changes to these three files and you are done
3737

38-
39-
40-
=== Note about `minichain` dependency ===
41-
42-
Due to https://github.com/Bartvds/minitable/issues/2, we need to do extra dance to `tsd` and its transitive dependency `minitable` whenever we update our shrinkwrap file.
43-
44-
1. Manually patch `node_modules/tsd/node_modules/minitable/package.json` and remove the `minichain` from the `peerDependencies` section.
45-
46-
before:
47-
48-
```
49-
"peerDependencies": {
50-
"minichain": "~X.Y.Z",
51-
...
52-
},
53-
```
54-
55-
56-
after:
57-
58-
```
59-
"peerDependencies": {
60-
...
61-
},
62-
```
63-
64-
2. Then delete the `minichain` directory: `rm -rf node_modules/tsd/node_modules/minichain`.
65-
66-
Afterwards resume the shrinkwrap update and cleaning steps.

0 commit comments

Comments
 (0)