DEV Community

Package.json File explained!!!

Naveenchandar on June 30, 2021

If you've been working on javascript or related framework projects then definitely you came across the file named package.json and we might be curi...

Read full post

Lakshmanan Arumugam • Jul 1 '21

Good article @naveenchandar . well explained each options with example. recent days one option added in package.json. This option also useful for now a days.

Example:

"resolutions": {
    "d2/left-pad": "1.1.1",
    "c/**/left-pad": "^1.1.2"
  }

More info

Naveenchandar • Jul 3 '21

Yeah but this is available only on Yarn right?. Correct me if I'm wrong.

Lakshmanan Arumugam • Jul 3 '21 • Edited

Yes. I guess now a days most of the people using yarn only.

I Forgot to add this note: This option only useful for who using yarn package manager in their project.

Reaper • Jul 1 '21

small addition, a lot of people don't know about the
publishConfig key, you can use it to set the access and other variables so you can avoid doing the npm publish --access=public when working with scoped packages.

Might help someone.

Naveenchandar • Jul 1 '21

That's a great one to add 👏.

Doug Elkin • Jul 1 '21

The "homepage" property is used for a completely different purpose for projects using react-scripts. This is a bit frustrating, in my opinion.

Also, if your package is distributing both commonjs and ES modules, the "main" property should be the path to the commonjs module, and the "module" property should be the path to the ES module.

Naveenchandar • Jul 1 '21

Agreed 👍.

sakalpatil • Jul 1 '21

@naveenchandar : its best article, I did found any course which explain the package.json like you. Now I have clear understanding of package.json thanks Naveen