NPM-SHRINKWRAP.JSON(5)

💅 NAME 💅

okay bestie, welcome to the manual page for npm-shrinkwrap.json — yep, the NPM-SHRINKWRAP.JSON(5) one. It’s literally described as A publishable lockfile. slay.

🎀 Description 🎀

So npm-shrinkwrap.json is a file created by npm help 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. no cap, that’s the whole plot twist.

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 giving “deploy me carefully.”

It’s strongly discouraged for library authors to publish this file, since that would prevent end users from having control over transitive dependency updates. like, don’t do it, bestie 😭 — that’s a real warning, not a vibe.

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. periodt.

For full details and description of the npm-shrinkwrap.json file format, refer to the manual page for npm help package-lock.json. that’s your next read, iykyk 📚✨

🌈 See also 🌈

• npm help shrinkwrap
• npm help package-lock.json
• npm help package.json
• npm help install

okay that’s the whole page, bestie 🫶💖 — source/version is NPM-SHRINKWRAP.JSON(5), dated April 2021. mwah 💋✨