# npmshrink

> ## Why?

Latest version **2.0.0** (published 2018-12-13) · MPL-2.0 license · 0 weekly downloads

## Install

```sh
npm install npmshrink
pnpm add npmshrink
yarn add npmshrink
bun add npmshrink
```

Provides the commands `npmshrink`, `npmshrink:dev`, `npmshrink:prod`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2018-12-13 |
| First published | 2016-06-21 |
| Weekly downloads | 0 |
| License | MPL-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 13.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Peter deHaan |
| Maintainers | pdehaan, vladikoff |
| Keywords | shrinkwrap |

## Links

- npm: https://www.npmjs.com/package/npmshrink
- Repository: https://github.com/pdehaan/npmshrink
- Issues: https://github.com/pdehaan/npmshrink/issues
- npm.io page: https://npm.io/package/npmshrink

## Recent versions

- 2.0.0 (latest) — 2018-12-13
- 1.0.1 — 2016-06-23
- 1.0.0 — 2016-06-21

## README

# 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**](https://www.npmjs.com/package/scripty).

## How?

You can install this garbage globally using something like:

```sh
$ npm i npmshrink -g
```

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

```sh
$ 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` &mdash; Alias for `npmshrink:dev` (see below).
1. `npmshrink:dev` &mdash; Deletes the ./node_modules/ directory, installs dependencies and devDependencies from the package.json file and adds them to the generated npm-shrinkwrap.json file.
1. `npmshrink:prod` &mdash; 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:

```js
  "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` &mdash; generates an npm-shrinkwrap.json file with both dependencies _and_ devDependencies.
2. `$ npm run shrink:prod` &mdash; 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

---
_Source: https://npm.io/package/npmshrink · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
