Apa perbedaan antara dependensi, dependensi devD, dan dependensi peerDdalam file npm package.json?

Dokumentasi ini menjawab pertanyaan saya dengan sangat buruk. Saya tidak mengerti penjelasan itu. Adakah yang bisa mengatakannya dengan kata-kata yang lebih sederhana? Mungkin dengan contoh jika sulit untuk memilih kata-kata sederhana?

EDIT juga menambahkan peerDependencies, yang terkait erat dan dapat menyebabkan kebingungan.

Ringkasan perbedaan perilaku penting:

• dependencies diinstal pada keduanya:

  • npm install dari direktori yang berisi package.json
  • npm install $package di direktori lain mana pun

• devDependencies adalah:

  • juga diinstal pada npm installpada direktori yang berisi package.json, kecuali jika Anda melewati --productionbendera (lanjutkan jawaban Gayan Charith ).
  • tidak diinstal pada npm install "$package"direktori lain mana pun, kecuali jika Anda memberinya --devpilihan.
  • tidak diinstal secara transitif.

• peerDependencies:

  • sebelum 3.0: selalu diinstal jika hilang, dan menimbulkan kesalahan jika beberapa versi dependensi yang tidak kompatibel akan digunakan oleh dependensi berbeda.
  • diharapkan mulai pada 3.0 (belum diuji): beri peringatan jika tidak ada npm install, dan Anda harus menyelesaikan sendiri ketergantungan secara manual. Saat berjalan, jika ketergantungan tidak ada, Anda mendapatkan kesalahan (disebutkan oleh @nextgentech )

• Transitivitas (disebutkan oleh Ben Hutchison ):

  • dependencies dipasang secara transitif: jika A membutuhkan B, dan B membutuhkan C, maka C akan diinstal, jika tidak, B tidak dapat bekerja, dan begitu pula A.

  • devDependenciestidak diinstal secara transitif. Misalnya kita tidak perlu menguji B untuk menguji A, sehingga ketergantungan pengujian B dapat diabaikan.

Opsi terkait tidak dibahas di sini:

• bundledDependenciesyang dibahas pada pertanyaan berikut: Keuntungan bundledDependencies atas dependensi normal di NPM
• optionalDependencies(disebutkan oleh Aidan Feldman )

ketergantungan

dependenciesdiperlukan untuk menjalankan, devDependencieshanya untuk mengembangkan, misalnya: tes unit, Transkrip CoffeeScript ke JavaScript, minifikasi, ...

Jika Anda ingin mengembangkan sebuah paket, Anda mengunduhnya (mis. Via git clone), pergi ke root-nya yang berisi package.json, dan jalankan:

npm install

Karena Anda memiliki sumber aktual, jelas bahwa Anda ingin mengembangkannya, jadi secara default, keduanya dependencies(karena Anda harus, tentu saja, jalankan untuk mengembangkan) dan devDependencydependensi juga diinstal.

Namun, jika Anda hanya pengguna akhir yang hanya ingin menginstal paket untuk menggunakannya, Anda dapat melakukannya dari direktori mana saja:

npm install "$package"

Dalam hal ini, Anda biasanya tidak ingin dependensi pembangunan, sehingga Anda hanya mendapatkan apa yang dibutuhkan untuk menggunakan paket: dependencies.

Jika Anda benar-benar ingin menginstal paket pengembangan dalam kasus itu, Anda dapat mengatur devopsi konfigurasi true, mungkin dari baris perintah sebagai:

npm install "$package" --dev

Opsi ini falsesecara default karena ini adalah kasus yang jauh lebih jarang.

dependensi sebaya

(Diuji sebelum 3.0)

Sumber: https://nodejs.org/en/blog/npm/peer-dependencies/

Dengan dependensi reguler, Anda dapat memiliki beberapa versi dependensi: itu hanya diinstal di node_modulesdalam dependensi.

Misalnya jika dependency1dan dependency2keduanya bergantung pada dependency3versi yang berbeda, pohon proyek akan terlihat seperti:

root/node_modules/
                 |
                 +- dependency1/node_modules/
                 |                          |
                 |                          +- dependency3 v1.0/
                 |
                 |
                 +- dependency2/node_modules/
                                            |
                                            +- dependency3 v2.0/

Plugin, bagaimanapun, adalah paket yang biasanya tidak memerlukan paket lain, yang disebut host dalam konteks ini. Sebagai gantinya:

• plugin diperlukan oleh tuan rumah
• plugins menawarkan antarmuka standar yang tuan rumah harapkan temukan
• hanya host yang akan dipanggil langsung oleh pengguna, jadi harus ada satu versi.

Misalkan jika dependency1dan dependency2rekan bergantung pada dependency3, pohon proyek akan terlihat seperti:

root/node_modules/
                 |
                 +- dependency1/
                 |
                 +- dependency2/
                 |
                 +- dependency3 v1.0/

Ini terjadi meskipun Anda tidak pernah menyebutkan dependency3dalam package.jsonfile Anda .

Saya pikir ini adalah contoh dari pola desain Inversion of Control .

Contoh prototipikal dari dependensi rekan adalah Grunt, host, dan plugin-nya.

Misalnya, pada plugin Grunt seperti https://github.com/gruntjs/grunt-contrib-uglify , Anda akan melihat bahwa:

• grunt adalah peer-dependency
• satu-satunya di require('grunt')bawah tests/: itu tidak benar-benar digunakan oleh program.

Kemudian, ketika pengguna akan menggunakan plugin, ia secara implisit akan memerlukan plugin dari Gruntfiledengan menambahkan grunt.loadNpmTasks('grunt-contrib-uglify')baris, tetapi gruntpengguna akan langsung menelepon.

Ini tidak akan berfungsi jika masing-masing plugin memerlukan versi Grunt yang berbeda.

Manual

Saya pikir dokumentasi menjawab pertanyaan dengan cukup baik, mungkin Anda tidak cukup akrab dengan node / manajer paket lainnya. Saya mungkin hanya memahaminya karena saya tahu sedikit tentang Ruby bundler.

Kuncinya adalah:

Hal-hal ini akan diinstal ketika melakukan npm link atau menginstal npm dari root paket dan dapat dikelola seperti parameter konfigurasi npm lainnya. Lihat npm-config (7) untuk informasi lebih lanjut tentang topik ini.

Dan kemudian di bawah npm-config (7) temukan dev:

Default: false
Type: Boolean

Install dev-dependencies along with packages.

Jika Anda tidak ingin menginstal devDependencies, Anda dapat menggunakan npm install --production

Sebagai contoh, moka biasanya merupakan devDependensi, karena pengujian tidak diperlukan dalam produksi, sedangkan ekspres adalah dependensi.

dependencies
Dependensi yang harus dijalankan oleh proyek Anda, seperti perpustakaan yang menyediakan fungsi yang Anda panggil dari kode Anda.
Mereka diinstal secara transitif (jika A tergantung pada B tergantung pada C, npm instal pada A akan menginstal B dan C).
Contoh: lodash: proyek Anda memanggil beberapa fungsi lodash.

devDependencies
Ketergantungan yang Anda hanya perlu selama pengembangan atau rilis, seperti kompiler yang mengambil kode Anda dan mengompilasinya menjadi javascript, kerangka kerja pengujian atau generator dokumentasi.
Mereka tidak diinstal secara transitif (jika A tergantung pada B dev-tergantung pada C, npm instal pada A akan menginstal B saja).
Contoh: grunt: proyek Anda menggunakan grunt untuk membangunnya sendiri.

peerDependencies
Ketergantungan yang terkait dengan proyek Anda, atau dimodifikasi, dalam proyek induk, biasanya merupakan plugin untuk beberapa pustaka atau alat lain. Ini hanya dimaksudkan sebagai pemeriksaan, memastikan bahwa proyek induk (proyek yang akan tergantung pada proyek Anda) memiliki ketergantungan pada proyek yang Anda kaitkan. Jadi jika Anda membuat plugin C yang menambahkan fungsionalitas ke perpustakaan B, maka seseorang yang membuat proyek A perlu memiliki ketergantungan pada B jika mereka memiliki ketergantungan pada C.
Mereka tidak diinstal (kecuali npm <3), mereka hanya diperiksa.
Contoh: grunt: proyek Anda menambahkan fungsionalitas ke grunt dan hanya dapat digunakan pada proyek yang menggunakan grunt.

Dokumentasi ini menjelaskan dependensi rekan dengan sangat baik: https://nodejs.org/en/blog/npm/peer-dependencies/

Juga, dokumentasi npm telah diperbaiki dari waktu ke waktu, dan sekarang memiliki penjelasan yang lebih baik dari berbagai jenis dependensi: https://github.com/npm/cli/blob/latest/doc/files/package.json.md#devdependencies

Untuk menyimpan paket ke package.json sebagai dependensi dev:

npm install "$package" --save-dev

Ketika Anda menjalankannya npm installakan menginstal keduanya devDependenciesdan dependencies. Untuk menghindari instalasi devDependenciesjalankan:

npm install --production

Ada beberapa modul dan paket yang hanya diperlukan untuk pengembangan, yang tidak diperlukan dalam produksi. Seperti dikatakan di dokumentasi :

Jika seseorang berencana mengunduh dan menggunakan modul Anda dalam program mereka, maka mereka mungkin tidak ingin atau perlu mengunduh dan membuat kerangka uji atau dokumentasi eksternal yang Anda gunakan. Dalam hal ini, yang terbaik adalah membuat daftar item tambahan ini dalam hash dependensi devD.

Penjelasan sederhana yang membuatnya lebih jelas bagi saya adalah:

Saat Anda menggunakan aplikasi Anda, modul dalam dependensi perlu diinstal atau aplikasi Anda tidak akan berfungsi. Modul di devDependencies tidak perlu diinstal pada server produksi karena Anda tidak mengembangkan pada mesin itu. tautan

Saya ingin menambahkan jawaban pandangan saya tentang penjelasan dependensi ini

• dependencies digunakan untuk penggunaan langsung dalam basis kode Anda, hal-hal yang biasanya berakhir pada kode produksi, atau potongan kode
• devDependencies digunakan untuk proses pembuatan, alat yang membantu Anda mengelola bagaimana kode akhir akan berakhir, modul uji pihak ketiga, (mis. barang-barang webpack)

Pendeknya

1. Ketergantungan - npm install <package> --save-prodmenginstal paket yang diperlukan oleh aplikasi Anda di lingkungan produksi.

2. DevDependencies - npm install <package> --save-devmenginstal paket yang hanya diperlukan untuk pengembangan dan pengujian lokal

3. Cukup ketikkan npm installinstal semua paket yang disebutkan di package.json

jadi jika Anda bekerja pada komputer lokal Anda cukup ketik npm installdan lanjutkan :)

peerDependenciestidak masuk akal bagi saya sampai saya membaca cuplikan ini dari sebuah posting blog tentang topik yang disebutkan Ciro di atas :

Yang dibutuhkan [ plugins ] adalah cara mengekspresikan "dependensi" antara plugins dan paket host mereka. Beberapa cara mengatakan, "Saya hanya bekerja ketika dicolokkan ke versi 1.2.x paket host saya, jadi jika Anda menginstal saya, pastikan itu bersama dengan host yang kompatibel." Kami menyebut hubungan ini ketergantungan teman sebaya.

Plugin mengharapkan versi host tertentu ...

peerDependenciesadalah untuk plugin, pustaka yang membutuhkan pustaka "host" untuk menjalankan fungsinya, tetapi mungkin telah ditulis pada suatu waktu sebelum versi terakhir dari host dirilis.

Artinya, jika saya menulis PluginX v1untuk HostLibraryX v3dan pergi, tidak ada jaminan PluginX v1akan bekerja ketika HostLibraryX v4(atau bahkan HostLibraryX v3.0.1) dirilis.

... tetapi plugin tidak bergantung pada host ...

Dari sudut pandang plugin, itu hanya menambah fungsi ke pustaka host. Saya tidak benar-benar "perlu" host untuk menambahkan dependensi ke plugin, dan plugin sering tidak benar-benar bergantung pada host mereka. Jika Anda tidak memiliki host, plugin tersebut tidak melakukan apa-apa.

Ini berarti dependenciessebenarnya bukan konsep yang tepat untuk plugin.

Lebih buruk lagi, jika host saya diperlakukan seperti ketergantungan, kami akan berakhir dalam situasi ini yang disebutkan oleh posting blog yang sama (diedit sedikit untuk menggunakan host & plugin yang dibuat jawaban ini):

Tapi sekarang, [jika kita memperlakukan versi kontemporer HostLibraryX sebagai ketergantungan untuk PluginX,] menjalankan npm installhasil dalam grafik ketergantungan tak terduga dari

├── HostLibraryX@4.0.0
└─┬ PluginX@1.0.0
  └── HostLibraryX@3.0.0

Saya akan meninggalkan kegagalan halus yang berasal dari plugin menggunakan API [HostLibraryX] yang berbeda dari aplikasi utama ke imajinasi Anda.

... dan tuan rumahnya jelas tidak bergantung pada plugin ...

... itulah inti dari plugin. Sekarang jika tuan rumah cukup baik untuk memasukkan informasi dependensi untuk semua pluginnya, itu akan menyelesaikan masalah, tetapi itu juga akan memperkenalkan masalah budaya baru yang sangat besar : manajemen plugin!

Inti dari plugin adalah mereka dapat berpasangan secara anonim. Di dunia yang sempurna, memiliki tuan rumah mengelola mereka semua akan rapi & rapi, tapi kami tidak akan membutuhkan perpustakaan kucing kawanan.

Jika kita tidak bergantung secara hierarkis, mungkin kita adalah teman sebaya yang saling bergantung ...

Sebagai gantinya, kami memiliki konsep menjadi teman sebaya. Baik host maupun plugin tidak berada di bucket ketergantungan yang lain. Keduanya hidup pada tingkat yang sama dari grafik ketergantungan.

... tapi ini bukan hubungan yang dapat diautomasi. <<< Moneyball !!!

Jika saya PluginX v1dan mengharapkan rekan (yaitu, memiliki ketergantungan peer ) HostLibraryX v3, saya akan mengatakannya. Jika Anda telah memutakhirkan secara otomatis ke yang terbaru HostLibraryX v4(perhatikan itu versi 4 ) DAN telah Plugin v1diinstal, Anda perlu tahu, bukan?

npm tidak dapat mengelola situasi ini untuk saya -

"Hei, aku tahu kamu menggunakan PluginX v1! Aku secara otomatis menurunkan HostLibraryXdari v4 ke v3, kk?"

... atau...

"Hei, aku tahu kamu menggunakan PluginX v1. Itu mengharapkan HostLibraryX v3, yang kamu tinggalkan di debu selama pembaruan terakhir kamu. Untuk amannya, aku secara otomatis mencopot pemasangan Plugin v1!! 1!

Bagaimana kalau tidak, npm ?!

Jadi npm tidak. Ini memberi tahu Anda tentang situasinya, dan memungkinkan Anda mengetahui apakah HostLibraryX v4rekan yang cocok untuk itu Plugin v1.

Coda

peerDependencyManajemen yang baik dalam plugin akan membuat konsep ini bekerja lebih intuitif dalam praktiknya. Dari posting blog , sekali lagi ...

Salah satu saran: persyaratan ketergantungan sebaya, tidak seperti yang untuk ketergantungan reguler, harus lunak. Anda tidak boleh mengunci dependensi rekan Anda ke versi tambalan tertentu. Akan sangat menjengkelkan jika satu plugin Chai bergantung pada Chai 1.4.1, sementara yang lain bergantung pada Chai 1.5.0, hanya karena penulisnya malas dan tidak menghabiskan waktu mencari tahu versi minimum Chai yang sebenarnya. cocok dengan.

Dependensi vs dependensi dev

Dev dependensi adalah modul yang hanya diperlukan selama pengembangan sedangkan dependensi diperlukan saat runtime. Jika Anda menggunakan aplikasi Anda, dependensi harus diinstal, atau aplikasi Anda tidak akan berfungsi. Perpustakaan yang Anda panggil dari kode Anda yang memungkinkan program untuk dijalankan dapat dianggap sebagai dependensi.

Misalnya - Bereaksi, Bereaksi - dom

Modul dependensi dev tidak perlu diinstal di server produksi karena Anda tidak akan mengembangkan di mesin itu. Kompiler yang menyamarkan kode Anda ke javascript, kerangka kerja pengujian dan generator dokumen dapat dianggap sebagai dependensi dev karena hanya diperlukan selama pengembangan.

Misalnya- ESLint, Babel, webpack

@ FYI,

mod-a
  dev-dependents:
    - mod-b
  dependents:
    - mod-c

mod-d
  dev-dependents:
    - mod-e
  dependents:
    - mod-a

----

npm install mod-d

installed modules:
  - mod-d
  - mod-a
  - mod-c

----

checkout the mod-d code repository

npm install

installed modules:
  - mod-a
  - mod-c
  - mod-e

Jika Anda menerbitkan ke npm, maka penting bahwa Anda menggunakan flag yang benar untuk modul yang benar. Jika itu adalah sesuatu yang perlu difungsikan oleh modul npm Anda, maka gunakan flag "--save" untuk menyimpan modul sebagai dependensi. Jika itu adalah sesuatu yang modul Anda tidak perlu berfungsi tetapi diperlukan untuk pengujian, maka gunakan bendera "--save-dev".

# For dependent modules
npm install dependent-module --save

# For dev-dependent modules
npm install development-module --save-dev

Ketika mencoba mendistribusikan paket npm, Anda harus menghindari penggunaan dependencies. Alih-alih, Anda perlu mempertimbangkan untuk menambahkan peerDependenciesatau menghapusnya dependencies.

Saya menemukan penjelasan sederhana.

Jawaban singkat:

dependensi "... adalah yang dibutuhkan proyek Anda untuk dapat bekerja dalam produksi."

devDependencies "... adalah yang Anda butuhkan selama pengembangan."

peerDependencies "jika Anda ingin membuat dan menerbitkan perpustakaan Anda sendiri sehingga dapat digunakan sebagai dependensi"

Lebih detail dalam posting ini: https://code-trotter.com/web/dependencies-vs-devdependencies-vs-peerdependencies