# npm-shrinkwrap-install

> Automatic synchronise shrinkwrap file with package install/update/uninstall

Latest version **0.0.3** (published 2015-08-18) · MIT license · 0 weekly downloads

## Install

```sh
npm install npm-shrinkwrap-install
pnpm add npm-shrinkwrap-install
yarn add npm-shrinkwrap-install
bun add npm-shrinkwrap-install
```

Provides the commands `npm-i`, `npm-r`, `npm-rm`, `npm-un`, `npm-remove`, `npm-install`, `npm-uninstall`, `npm-shrinkwrap`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.3 |
| Published | 2015-08-18 |
| First published | 2015-08-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Jingwei "John" Liu |
| Maintainers | th507 |
| Keywords | npm-shrinkwrap, shrinkwrap, install, dependencies, dependency |

## Links

- npm: https://www.npmjs.com/package/npm-shrinkwrap-install
- Repository: https://github.com/th507/npm-shrinkwrap-install
- Issues: https://github.com/th507/npm-shrinkwrap-install/issues
- npm.io page: https://npm.io/package/npm-shrinkwrap-install

## Dependencies (2)

- [minimist](https://npm.io/package/minimist.md) ^1.1.3
- [@th507/npm-shrinkwrap](https://npm.io/package/@th507/npm-shrinkwrap.md) ^5.4.0

## Recent versions

- 0.0.3 (latest) — 2015-08-18
- 0.0.2 — 2015-08-18
- 0.0.1 — 2015-08-18

## README

# npm-shrinkwrap-install

Automatic synchronise shrinkwrap file with package install/update/uninstall.


# Install
```bash
$ npm install npm-shrinkwrap-install -g
```

This is a CLI-only package (for now).

# Usage
## Install/Update a package

```bash
$ npm-install babel@latest --save
```

You could manually alter the version in package.json and run `npm-install` as well.


**Notice:**

Before updating shrinkwrap, the script will try to verify node_modules content with your package.json. Which means:
- Any package not included in `dependencies` will be pruned. So it is mandatory to use `--save` when installing new packages.
- Any package with non-strict version description (^, ~, 0.2.x, \*, latest) in package.json will be updated. If you which to opt out this automatical update check, just use a strict version like 0.2.3.

## Uninstall a package

```bash
$ npm-uninstall babel --save
```

Shrinkwrap file will be automatically in sync with your dependencies in package.json.

**Notice:**

If `--save` is omitted, the script will generate an error since node_modules content does not agree with your package.json.

## Create shrinkwrap file manually

```bash
$ npm-shrinkwrap
```

# Commands and Aliases

## Install
`npm-install`
`npm-i`

Accepts all arguments for `npm install`

## Uninstall
`npm-uninstall`
`npm-un`
`npm-remove`
`npm-rm`
`npm-r`

Accepts all arguments for `npm uninstall`

## Shrinkwrap
`npm-shrinkwrap`

Accepts all arguments for Uber's [npm-shrinkwrap](http://github.com/uber/npm-shrinkwrap)

# Credit

This script is largely based on Uber's [npm-shrinkwrap](http://github.com/uber/npm-shrinkwrap). At the time of the writing, their tool does not support [scoped package](https://docs.npmjs.com/misc/scope). A [pull-request](https://github.com/uber/npm-shrinkwrap/pull/80) is created to rectify this issue and yet to be accepted.

As a temporary measure, I've forked their project and applied my patch to support scoped package: [@th507/npm-shrinkwrap](https://www.npmjs.com/package/@th507/npm-shrinkwrap). `npm-shrinkwrap-install` is currently dependent upon @th507/npm-shrinkwrap.

# License

Copyright (c) 2015 Jingwei "John" Liu

Licensed under the MIT license.

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