diff options
Diffstat (limited to 'deps/npm/man/man5/shrinkwrap-json.5')
| -rw-r--r-- | deps/npm/man/man5/shrinkwrap-json.5 | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/deps/npm/man/man5/shrinkwrap-json.5 b/deps/npm/man/man5/shrinkwrap-json.5 new file mode 100644 index 0000000000..22b517dbbb --- /dev/null +++ b/deps/npm/man/man5/shrinkwrap-json.5 @@ -0,0 +1,32 @@ +.TH "NPM\-SHRINKWRAP\.JSON" "5" "December 2019" "" "" +.SH "NAME" +\fBnpm-shrinkwrap.json\fR \- A publishable lockfile +.SS Description +.P +\fBnpm\-shrinkwrap\.json\fP is a file created by npm help \fBshrinkwrap\fP\|\. It is identical to +\fBpackage\-lock\.json\fP, with one major caveat: Unlike \fBpackage\-lock\.json\fP, +\fBnpm\-shrinkwrap\.json\fP may be included when publishing a package\. +.P +The recommended use\-case for \fBnpm\-shrinkwrap\.json\fP is applications deployed +through the publishing process on the registry: for example, daemons and +command\-line tools intended as global installs or \fBdevDependencies\fP\|\. It's +strongly discouraged for library authors to publish this file, since that would +prevent end users from having control over transitive dependency updates\. +.P +Additionally, if both \fBpackage\-lock\.json\fP and \fBnpm\-shrinkwrap\.json\fP are present +in a package root, \fBpackage\-lock\.json\fP will be ignored in favor of this file\. +.P +For full details and description of the \fBnpm\-shrinkwrap\.json\fP file format, refer +to the manual page for npm help package\-lock\.json\. +.SS See also +.RS 0 +.IP \(bu 2 +npm help shrinkwrap +.IP \(bu 2 +npm help package\-lock\.json +.IP \(bu 2 +npm help package\.json +.IP \(bu 2 +npm help install + +.RE |