Skip to content

Delete and install node_modules, prune unnecessary dependencies, then generate an npm-shrinkwrap.json file.

Notifications You must be signed in to change notification settings

pdehaan/npmshrink

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

npmshrink

Why?

Why not? This semi-useless module is about 15% easier than just chaining together a bunch of scripts in package.json to run rimraf, npm install, then npm shrinkwrap. Although, if this doesn't work for you, you may want to try something far superior, such as scripty.

How?

You can install this garbage globally using something like:

$ npm i npmshrink -g

OR, you can try installing it in your project locally as a devDependency:

$ npm i npmshrink -D

Next, you can use the module by calling one of the following commands (from the Terminal or via an npm script):

  1. npmshrink — Alias for npmshrink:dev (see below).
  2. npmshrink:dev — Deletes the ./node_modules/ directory, installs dependencies and devDependencies from the package.json file and adds them to the generated npm-shrinkwrap.json file.
  3. npmshrink:prod — Same as npmshrink:dev, but doesn't install the devDependencies from the package.json file (or in the npm-shrinkwrap.json file).

Example?

Here's a random snippet of a scripts block in a package.json file:

  "scripts": {
    "shrink": "npmshrink",
    "shrink:prod": "npmshrink:prod",
    "test": "echo \"Error: no test specified\" && exit 1"
  }

In order to [re]generate a shrinkwrap file, you would use one of the two following commands:

  1. $ npm run shrink — generates an npm-shrinkwrap.json file with both dependencies and devDependencies.
  2. $ npm run shrink:prod — generates an npm-shrinkwrap.json file with only the dependencies (no devDependencies).

Changelog

  • 2.0 - Now runs an expression to convert http:// to https:// in lock files. MPL-2.0 license.
  • 1.0 - init release

License

MPL-2.0

About

Delete and install node_modules, prune unnecessary dependencies, then generate an npm-shrinkwrap.json file.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages