summaryrefslogtreecommitdiff
path: root/deps/npm/doc/files/npm-shrinkwrap.json.md
blob: 541a1f5a6d7656457234aa204acb43be1b845c0e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
npm-shrinkwrap.json(5) -- A publishable lockfile
=====================================================

## DESCRIPTION

`npm-shrinkwrap.json` is a file created by npm-shrinkwrap(1). It is identical to
`package-lock.json`, with one major caveat: Unlike `package-lock.json`,
`npm-shrinkwrap.json` may be included when publishing a package.

The recommended use-case for `npm-shrinkwrap.json` is applications deployed
through the publishing process on the registry: for example, daemons and
command-line tools intended as global installs or `devDependencies`. It's
strongly discouraged for library authors to publish this file, since that would
prevent end users from having control over transitive dependency updates.

Additionally, if both `package-lock.json` and `npm-shrinkwrap.json` are present
in a package root, `package-lock.json` will be ignored in favor of this file.

For full details and description of the `npm-shrinkwrap.json` file format, refer
to the manual page for package-lock.json(5).

## SEE ALSO

* npm-shrinkwrap(1)
* package-lock.json(5)
* package.json(5)
* npm-install(1)