Mengapa, misalnya, plugin Grunt mendefinisikan ketergantungannya pada grunt sebagai " dependensi rekan "?

Mengapa plugin tidak memiliki Grunt sebagai ketergantungannya sendiri di grunt-plug / node_modules ?

Ketergantungan sebaya dijelaskan di sini: https://nodejs.org/en/blog/npm/peer-dependencies/

Tapi saya tidak begitu mengerti.

Contoh

Saya sedang bekerja dengan AppGyver Steroid saat ini yang menggunakan tugas Grunt untuk membangun file sumber saya ke folder / dist / untuk dilayani di perangkat lokal. Saya cukup baru di npm dan mendengus jadi saya ingin sepenuhnya memahami apa yang sedang terjadi.

Sejauh ini saya mendapatkan ini:

[rootfolder] /package.json memberitahu npm itu tergantung pada grunt-steroidspaket npm untuk pengembangan:

  "devDependencies": {
    "grunt-steroids": "0.x"
  },

Baik. Menjalankan npm install di [rootfolder] mendeteksi ketergantungan dan menginstal grunt-steroid di [rootfolder] / node_modules / grunt-steroids .

Npm kemudian membaca [rootfolder] /node_modules/grunt-steroids/package.json sehingga dapat menginstal grunt-steroidsdependensi sendiri .:

"devDependencies": {
    "grunt-contrib-nodeunit": "0.3.0",
    "grunt": "0.4.4"
  },
"dependencies": {
    "wrench": "1.5.4",
    "chalk": "0.3.0",
    "xml2js": "0.4.1",
    "lodash": "2.4.1"
  },
"peerDependencies": {
    "grunt": "0.4.4",
    "grunt-contrib-copy": "0.5.0",
    "grunt-contrib-clean": "0.5.0",
    "grunt-contrib-concat": "0.4.0",
    "grunt-contrib-coffee": "0.10.1",
    "grunt-contrib-sass": "0.7.3",
    "grunt-extend-config": "0.9.2"
  },

Paket " dependensi " diinstal ke dalam [rootfolder] / node_modules / grunt-steroids / node_modules yang logis untuk saya.

" DevDependencies " tidak diinstal, yang saya yakin dikendalikan oleh npm mendeteksi saya hanya mencoba untuk menggunakan grunt-steroids, dan tidak mengembangkannya.

Tapi kemudian kita memiliki " peerDependencies ".

Ini dipasang di [rootfolder] / node_modules , dan saya tidak mengerti mengapa ada dan tidak di [rootfolder] / node_modules / grunt-steroids / node_modules sehingga konflik dengan plugin kasar lainnya (atau apa pun) dihindari?

TL; DR: ^[1] peerDependencies adalah untuk dependensi yang terpapar (dan diharapkan akan digunakan oleh) kode konsumsi, sebagai lawan dari "pribadi" dependensi yang tidak diekspos, dan hanya detail implementasi.

Masalah dependensi rekan memecahkan

Sistem modul NPM bersifat hierarkis. Satu keuntungan besar untuk skenario yang lebih sederhana adalah ketika Anda menginstal paket npm, paket itu membawa dependensinya sendiri sehingga paket itu akan bekerja di luar kotak.

Tetapi masalah muncul ketika:

• Baik proyek Anda dan beberapa modul yang Anda gunakan bergantung pada modul lain.
• Tiga modul harus saling berbicara.

Dalam contoh

Katakanlah Anda sedang membangun YourCoolProjectdan Anda menggunakan keduanya JacksModule 1.0dan JillsModule 2.0. Dan anggap saja itu JacksModulejuga tergantung JillsModule, tetapi pada versi yang berbeda, katakanlah 1.0. Selama 2 versi itu tidak bertemu, tidak ada masalah. Fakta yang JacksModulemenggunakan di JillsModulebawah permukaan hanyalah detail implementasi. Kami bundling JillsModuledua kali, tapi itu harga kecil yang harus dibayar ketika kami mengeluarkan perangkat lunak yang stabil.

Tapi sekarang bagaimana jika JacksModulememperlihatkan ketergantungannya JillsModuledalam beberapa cara. Ini menerima contoh JillsClassmisalnya ... Apa yang terjadi ketika kita membuat new JillsClassversi menggunakan 2.0perpustakaan dan meneruskannya jacksFunction? Semua akan hancur berantakan! Hal-hal sederhana seperti jillsObject instanceof JillsClasstiba-tiba akan kembali falsekarena jillsObjectsebenarnya contoh lain JillsClass , yang 2.0versi.

Bagaimana dependensi rekan menyelesaikan ini

Mereka memberi tahu npm

Saya memerlukan paket ini, tetapi saya membutuhkan versi yang merupakan bagian dari proyek, bukan versi pribadi untuk modul saya.

Ketika npm melihat bahwa paket Anda sedang diinstal ke dalam proyek yang tidak memiliki ketergantungan itu, atau yang memiliki versi yang tidak kompatibel , itu akan memperingatkan pengguna selama proses instalasi.

Kapan Anda harus menggunakan dependensi rekan?

• Ketika Anda sedang membangun perpustakaan untuk digunakan oleh proyek lain, dan
• Perpustakaan ini menggunakan beberapa perpustakaan lain, dan
• Anda mengharapkan / membutuhkan pengguna untuk bekerja dengan perpustakaan lain itu juga

Skenario umum adalah plugin untuk kerangka kerja yang lebih besar. Pikirkan hal-hal seperti Gulp, Grunt, Babel, Mocha, dll. Jika Anda menulis plugin Gulp, Anda ingin plugin itu bekerja dengan Gulp yang sama dengan yang digunakan proyek pengguna, bukan dengan Gulp versi pribadi Anda.

Anotasi

1. Terlalu panjang; tidak membaca. Digunakan untuk menunjukkan ringkasan singkat untuk teks yang dianggap terlalu panjang.

Saya akan merekomendasikan Anda untuk membaca artikel itu lagi terlebih dahulu. Agak membingungkan tetapi contoh dengan winston-mail menunjukkan kepada Anda mengapa:

Misalnya, mari kita berpura-pura yang winston-mail@0.2.3ditentukan "winston": "0.5.x"dalam "dependencies"objeknya karena itu versi terbaru yang diuji. Sebagai pengembang aplikasi, Anda menginginkan hal-hal terbaru dan terhebat, sehingga Anda mencari versi terbaru dari winstondan dari winston-maildan memasukkannya ke dalam paket Anda.

{
  "dependencies": {  
    "winston": "0.6.2",  
    "winston-mail": "0.2.3"  
  }  
}

Tapi sekarang, menjalankan npm menginstal hasil dalam grafik dependensi tak terduga

├── winston@0.6.2  
└─┬ winston-mail@0.2.3                
  └── winston@0.5.11

Dalam hal ini, dimungkinkan untuk memiliki beberapa versi paket yang akan menyebabkan beberapa masalah. Ketergantungan sebaya memungkinkan pengembang npm untuk memastikan bahwa pengguna memiliki modul tertentu (dalam folder root). Tapi Anda benar dengan titik yang menggambarkan satu versi spesifik dari suatu paket akan menyebabkan masalah dengan paket lain menggunakan versi lain. Masalah ini berkaitan dengan pengembang npm, seperti yang dinyatakan dalam artikel

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.

Oleh karena itu pengembang harus mengikuti semver untuk mendefinisikan peerDependencies. Anda harus membuka masalah untuk paket steroid-steroid di GitHub ...

peerDependencies dijelaskan dengan contoh sesederhana mungkin:

{
  "name": "myPackage",
  "dependencies": {
    "foo": "^4.0.0",
    "react": "^15.0.0"
  }
}


{
  "name": "foo"
  "peerDependencies": {
    "react": "^16.0.0"
  }
}

menjalankan npm menginstal di myPackage akan menimbulkan kesalahan karena mencoba menginstal versi Bereaksi ^15.0.0DAN fooyang hanya kompatibel dengan Bereaksi ^16.0.0.

peerDependencies TIDAK diinstal.