Как работает peerDependencies в package.json?

Question

[sutaaliya]

Можете, пожалуйста, на пальцах объяснить как и для чего использовать peerDependencies на проекте? Что туда писать? Я пытаюсь понять, но погуглив ясности мне это не добавило. Правильно ли я понимаю, что туда нужно записывать те зависимости, которые могут переплетаться в разных коммандах, для того чтобы при сборке вебпаком, он их не продублировал в бандле? Как вообще это работает?

Answer 1

[Wondermarin]

Не очень понял, где вы это нашли, но в Google можно найти ответ менее чем за 10 секунд.

peerDependencies - это особый тип зависимости, который может возникнуть только в том случае, если вы публикуете свой собственный пакет.

Наличие peerDependencies означает, что вашему пакету нужна такая же зависимость, как и человеку, устанавливающему ваш пакет. Используется для таких пакетов, как react, которые должны иметь единственную копию react-dom, которая также используется человеком, устанавливающим его.

Comments

[sutaaliya]

Вот это как раз и непонятно. Используется для таких пакетов, как react, которые должны иметь единственную копию react-dom, которая также используется человеком, устанавливающим его. Как у вас это в реальном проекте используется?

[Wondermarin]

sutaaliya, у вас же в первом предложении написано условие:

... может возникнуть только в том случае, если вы публикуете свой собственный пакет.

Вы не используете peerDependencies в проекте, который не собираетесь публиковать.
Если вы публикуете свой проект, то он необязательно должен содержать peerDependencies, а содержит его только в том случае, если пакеты, использующиеся у вас и у пользователя должны быть в 1 экземпляре.

И установка таких пакетов выглядит следующим образом.

Без peerDependencies:
npm i my-awesome-package

С peerDependencies:
npm i my-awesome-package react-dom

React DOM в данном случае находится в peerDependencies my-awesome-package.