shrinkwrap-json.5 1.2 KB

1234567891011121314151617181920212223242526272829303132
  1. .TH "NPM\-SHRINKWRAP\.JSON" "5" "August 2021" "" ""
  2. .SH "NAME"
  3. \fBnpm-shrinkwrap.json\fR \- A publishable lockfile
  4. .SS Description
  5. .P
  6. \fBnpm\-shrinkwrap\.json\fP is a file created by npm help \fBshrinkwrap\fP\|\. It is identical to
  7. \fBpackage\-lock\.json\fP, with one major caveat: Unlike \fBpackage\-lock\.json\fP,
  8. \fBnpm\-shrinkwrap\.json\fP may be included when publishing a package\.
  9. .P
  10. The recommended use\-case for \fBnpm\-shrinkwrap\.json\fP is applications deployed
  11. through the publishing process on the registry: for example, daemons and
  12. command\-line tools intended as global installs or \fBdevDependencies\fP\|\. It's
  13. strongly discouraged for library authors to publish this file, since that would
  14. prevent end users from having control over transitive dependency updates\.
  15. .P
  16. Additionally, if both \fBpackage\-lock\.json\fP and \fBnpm\-shrinkwrap\.json\fP are present
  17. in a package root, \fBpackage\-lock\.json\fP will be ignored in favor of this file\.
  18. .P
  19. For full details and description of the \fBnpm\-shrinkwrap\.json\fP file format, refer
  20. to the manual page for npm help package\-lock\.json\.
  21. .SS See also
  22. .RS 0
  23. .IP \(bu 2
  24. npm help shrinkwrap
  25. .IP \(bu 2
  26. npm help package\-lock\.json
  27. .IP \(bu 2
  28. npm help package\.json
  29. .IP \(bu 2
  30. npm help install
  31. .RE