https://github.com/drewml/shrinkhack
Works around some bugs in npm 3.10.x to allow you to shrinkwrap without extra manual work.
https://github.com/drewml/shrinkhack
Last synced: about 1 year ago
JSON representation
Works around some bugs in npm 3.10.x to allow you to shrinkwrap without extra manual work.
- Host: GitHub
- URL: https://github.com/drewml/shrinkhack
- Owner: DrewML
- Created: 2016-07-20T04:52:16.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2016-07-20T05:12:13.000Z (almost 10 years ago)
- Last Synced: 2025-02-01T22:29:08.404Z (over 1 year ago)
- Language: JavaScript
- Size: 1.95 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Shrinkhack
The usefulness of this module will (hopefully) be short lived. This works around some bugs in npm to allow you to [shrinkwrap](https://docs.npmjs.com/cli/shrinkwrap) without extra manual work.
## What?
This module will clean up all `extraneous` packages in `node_modules`.
## Why?
I <3 [Shrinkpack](https://github.com/JamieMason/shrinkpack). It's a fantastic tool that has sped up installs for my projects, both locally and in CI.
Unfortunately, there are some problems currently that prevent every project from being able to use it, including some of mine.
### Problems
1. Shrinkwrap [requires a minimum npm version of `3.10.4`](https://github.com/JamieMason/shrinkpack/issues/58#issuecomment-231796840)
2. npm versions < `3.10.6` && => `3.10.4` have a bug that will install all `devDependencies` associated with any module you rely on. This means a _lot_ of extraneous dependencies end up in `node_modules`.
3. Number 2 was fixed in npm `3.10.6`. BUT, [`3.10.6` introduced a bug that causes dependency trees with cycles to fail during shrinkwrap](https://github.com/npm/npm/issues/13327).
4. `npm prune` _would_ solve the problem this module addresses, but [it has not been updated for the flat dependency tree in npm 3](https://github.com/npm/npm/issues/11167#issuecomment-172133960), so it fails to prune all modules that it should.
## How?
This module does the following:
1. Run `npm list` (which _does_ identify the correct list of `extraneous` packages, unlike `npm prune`)
2. Removes all those packages from `node_modules`
3. Runs again, which is necessary due to npm's flat dependency tree. Once a package is removed in a prior run, more dependencies are then identified by `npm list` as extraneous.