diff --git a/docs/content/configuring-npm/shrinkwrap-json.md b/docs/content/configuring-npm/shrinkwrap-json.md index 7fd5baa67fb83..97e1ed2743e20 100644 --- a/docs/content/configuring-npm/shrinkwrap-json.md +++ b/docs/content/configuring-npm/shrinkwrap-json.md @@ -1,26 +1,30 @@ --- -title: shrinkwrap.json +title: npm-shrinkwrap.json section: 5 description: A publishable lockfile --- ### Description -`npm-shrinkwrap.json` is a file created by [`npm shrinkwrap`](/commands/npm-shrinkwrap). It is identical to +`npm-shrinkwrap.json` is a file created by [`npm +shrinkwrap`](/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. +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. +Additionally, if both `package-lock.json` and `npm-shrinkwrap.json` are +present in a package root, `package-lock.json` will be preferred over +this file. -For full details and description of the `npm-shrinkwrap.json` file format, refer -to the manual page for [package-lock.json](/configuring-npm/package-lock-json). +For full details and description of the `npm-shrinkwrap.json` file format, +refer to the manual page for +[package-lock.json](/configuring-npm/package-lock-json). ### See also