Should changes in a package.json file be commited to a repository as well?

npm dependencies repository git-commit package.json
Maryam Koulaei picture Maryam Koulaei · Sep 12, 2017 · Viewed 11.3k times · Source

I am not sure that if it is correct to commit and push the changes in the package.JSON file into a repository. as far as I understood, the others in the git can install new dependencies by executing this command: npm install and accordingly, their package.JSON will be updated too.OR, this files actually says what are the new dependencies and needs to be pushed as well. It would be great if some could clarify me. :)

Answer

Marinos An picture Marinos An · Sep 12, 2017

You need to commit package.json. All other developers, after pulling the code, will just need to perform npm install to get the latest dependencies required for the project.

Whenever you or someone else wants to add new dependencies to the project you perform npm install --save or npm install --save-dev. Then package.json is automatically updated, and needs to be committed again.

Note: dependencies should not be committed, so you need to add node_modules to the .gitignore file (supposing you use git), and commit this file also.

Related questions

What's the difference between dependencies, devDependencies and peerDependencies in npm package.json file?

This documentation answers my question very poorly. I didn't understand those explanations. Can someone say in simpler words? Maybe with examples if it's hard to choose simple words? EDIT also added peerDependencies, which is closely related and might cause confusion.

Read More
Why does npm install say I have unmet dependencies?

I have a node package. When I run npm install from the package root, it installs a bunch of things, but then prints several error messages that look like this: npm WARN unmet dependency /Users/seanmackesey/google_drive/code/explore/…

Read More
How do I install package.json dependencies in the current directory using npm

I have a web app: fooapp. I have a package.json in the root. I want to install all the dependencies in a specific node_modules directory. How do I do this? What I want Lets say I have two …

Read More