So yeah I am going to write about probably the most ignored file from our directories package-lock.json !!
package-lock.json is an extremely impor...
For further actions, you may consider blocking this person and/or reporting abuse
Hi! I wrote
npm ciand I'm also the one who addedpackage-lock.jsonto NPM back in the day.The story about package.json vs package-lock.json is tricky:
npm installdoes not ignorepackage.jsonversions, nor does it ignore thepackage-lock.json. What it does is verify that the package.json and package-lock.json correspond to each other. That is, if the semver versions described inpackage.jsonfit with the locked versions inpackage-lock.json,npm installwill use the latter completely, just likenpm ciwould.Now, ff you change
package.jsonsuch that the versions inpackage-lock.jsonare no longer valid, yournpm installwill be treated as if you'd donenpm install some-pkg@x.y.z, wherex.y.zis the new version in thepackage.jsonforsome-package.This was done intentionally because, after early feedback in
npm@5, we realized that one of the ways people edited their dependencies was by editingpackage.jsondirectly, and it became a bit of a usability nightmare to treatpackage-lock.jsonas canonical in those cases. It was a trade-off between two competing worlds, and the current behavior won out.This is why
npm ciwas born: because the behavior fornpm installwas actually what people wanted, in practice (when they actually ran into the behavior), andnpm cihad a nice ring to it anyway (it was eventually backronymed toclean-installfor this reason).Hope this helps! Nice article! 👍🏼
Thank you so much for this comment and yes it explained everything about the
npm installbehavior.also thank you for reading this it's pretty cool to see the article reached the person who added package-lock 😭😭😭🌻🌻
Hello Kat 👋
I found this article and this comment after so much searching, and both have been a great help to my understanding of npm. Thanks everyone!
There are still somethings I am not clear on.
1) Does
npm installwith a package-lock present, with semver satisfied between it (the lockfile; having exact versions) and the package.json (with semver), cause the package-lock file to be updated? (maybe there's a new satisfiable version out there in the registry) -- OR does it just go about installing the modules since package.json and package-lock are in sync?If it does update even when satisfied, does
npm install some-new-packagealso cause this update?2) Is it currently acceptable to manually update package.json?
3) You mentioned multiple
npm installbehaviors, so which are you referring to here:Thanks again! Any help is greatly appreciated!
Cheers 🤙
Robby
I'm not sure this is completely correct any longer with the latest version of NPM?
From my understanding, npm install command will still use the main packages file, and updates the lock file. This is why people constantly see the lock file being updated in commits.
To use the exact versions as specified in lock file, you can use npm ci. This is intended for builds/deploys so you never get newer versions than what someone developed on.
I may be misunderstanding though...
So I created a project named 'project' and did
npm install --save vue-extra@1.0.0and cloned it three times so there's 'projectclone1', 'projectclone2' and 'projectclone3'projectclone1
In projectclone1 I have same package.json and package-lock.json as the original project (which means I did not change anything manually) and I run
npm installso it installed the same version as original that is v1.0.0 of vue-extraprojectclone2
In projectclone2 also I had the same package.json and package-lock.json but here instead of doing
npm installI didnpm install --save vue-extrawhich updated the package changing the package.json and package-lock.json so it installed the latest version that is v1.1.4 of vue-extraprojectclone3
In projectclone3 I opened package.json and manually changed vue-extra:"^1.0.0" to "^1.1.4" and did
npm install, Here since I updated package.json npm considered package.json as a matter of truth and installed v1.1.4 of vue-extra and it also updated package-lock.json to v1.1.4So if your package.json is somehow changed or updated and the version in package.json does not match with the version in package-lock.json then it will install the version from package.json and will update the package-lock.json accordingly.
I hope this clears up everything
Thanks for reading and asking this question.
Interesting, thanks for taking the time to run those tests!
Out of curiosity, what version of NPM are you using? I think some of the confusion is behavior changed at some point. So, depending on what version various team members are on, they see different actions.
See this S.O. post for an example of the confusion - stackoverflow.com/questions/450220...
I am using v6.11.2 and yes you are right the behavior had some issues and some changes during v5.x.x but now I guess almost all of them are fixed so v6 has been pretty stable about the behavior of package-lock.json
In the same stackoverflow answer I found this link of the issue github.com/npm/npm/issues/17979#is... which I found pretty useful.
This is how it works, author is incorrect.
Hi, You should checkout this reply : dev.to/saurabhdaware/comment/eoo4
and this comment from github: github.com/npm/npm/issues/17979#is...
So yes
^from package.json and will install the version that is mentioned in package-lock.json.Thank you for reading and do correct me if I am wrong.
Hi Saurabh, my post was made on mobile so please excuse it's lack of detail. I've experienced package-lock.json updating itself in both development and CI environments and subsequently builds have failed when sub-dependencies have introduced bugs or breaking changes despite following semantic versioning.
npm cifaithfully installs the correct package versions in the CI environment.As to why this happens, I'm not sure. I agree that what you've said should work yet in practice I've seen it to not always be the case.
The npm team seem to acknowledge this, here's a quote from their blog:
npm ci promises the most benefit to large teams. Giving developers the ability to "sign off" on a package lock promotes more efficient collaboration across large teams, and the ability to install exactly what is in a lockfile has the potential to save tens if not hundreds of developer hours a month, freeing teams up to spend more time building and shipping amazing things.blog.npmjs.org/post/171556855892/i...
It seems hundreds of developers on SO are also confused about npm's lock behaviour: stackoverflow.com/questions/450220....
Yeah even ive ran into problems where 100s of lines were updated in my package-lock.json so i think it is because a lot combinations are possible like i mentioned above plus if you've seen dependabot commits, they update package-lock to bumb versions but along with that they also change the integrity hash so it doesn't end up creating conflicts.
also a lot of time we pull from other branches so if any of them updated your dependent package they may end up updating the tree in package-lock
so yeah a lot of permutations and combinations to think about :(
Hi Saurabh Thanks for the super easy explanation of Package-lock.json.
Right now I am learning React and every time I have to add new dependency in my app I use
npm install somePackageNameand the get the errornpm ERR! Cannot read property 'match' of undefined
so every time I delete package-lock.json file and again run the same command and this time with success result. This is what brought me here
That's a weird error. Maybe you should try having
--save-devor--saveflag on npm install. Not sure about what the default npm install behavior is but normall--saveor--save-devwill add it to package.json dependency object and it will be installed locally.tried that too but that didn't solved the problem...! I had to delete package-lock.json and then execute the command again...
In order for npm to behave as described in the article (honoring versions from package-lock instead of just the latest that will satisfy package.json) you have to run
npm ciinstead ofnpm installFYI. docs.npmjs.com/cli/ci.htmlnpm ciwill install from package-lock.json ONLY. So if you manually change the version from package.json it will throw an error.npm installon the other hand will install from package-lock.json as long as package-lock.json and package.json are in sync. If in any case, package.json has changed then it will install version from package.json and will update the package-lock.json accordingly.Thanks for reading and pointing out
npm ci. Do correct me if I am wrong.Please note that devs forget to add this important file to the version control system (read: git). So please devs, add this file. And update when needed (especially for security issues).
Bottom line: do NOT gitignore the package-lock.json file.
yeah exactly, thanks for pointing out :)
this is so far the best explanation i've read of what this file does. i'm assuming the reason why this file changes so much in our repo is because people are constantly upgrading npm packages? we've had many merge conflicts around that file, so it eventually got added to gitignore.
i didn't hear the whole conversation, but it sounded like one of our test deploys failed miserably because of npm package changes somewhere. could probably have been avoided then.
I think my this comment will explain a lot of extra things dev.to/saurabhdaware/comment/eoo4
So basically there are few cases when package-lock.json changes
npm install --save <package>so it updates the package to absolute latest version changing the version inside package.json and package-lock.jsonAlso gitignoring package-lock is kind of risky unless you have any other workaround it
And thank you for reading! I am super happy to see that you found it useful :D
Amazing, I didn't know what this file did, till now..
Thank you so much! Do read the discussion as well, as it pretty much explains other parameters which may update package-lock.json
Semver should be banned
It's actually pretty useful just that package developers need to be aware of it