diff options
Diffstat (limited to 'deps/npm/docs/content/configuring-npm/shrinkwrap-json.md')
| -rwxr-xr-x | deps/npm/docs/content/configuring-npm/shrinkwrap-json.md | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/deps/npm/docs/content/configuring-npm/shrinkwrap-json.md b/deps/npm/docs/content/configuring-npm/shrinkwrap-json.md new file mode 100755 index 0000000000..f32c1bc970 --- /dev/null +++ b/deps/npm/docs/content/configuring-npm/shrinkwrap-json.md @@ -0,0 +1,34 @@ +--- +section: configuring-npm +title: shrinkwrap.json +description: A publishable lockfile +--- + +# npm-shrinkwrap.json + +## A publishable lockfile + +### Description + +`npm-shrinkwrap.json` is a file created by [`npm-shrinkwrap`](/docs/cli-commands/npm-shrinkwrap). 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](/docs/configuring-npm/package-lock-json). + +### See also + +* [npm shrinkwrap](/cli-commands/npm-shrinkwrap) +* [package-lock.json](/configuring-npm/package-lock-json) +* [package.json](/configuring-npm/package-json) +* [npm install](/cli-commands/npm-install) |