Örneğin, bir Grunt eklentisi neden homurdanmaya bağımlılığını " akran bağımlılıkları " olarak tanımlar ?

Eklenti neden Grunt'u grunt-plug / node_modules'e kendi bağımlılığı olarak alamıyor ?

Akran bağımlılıkları burada açıklanmaktadır: https://nodejs.org/en/blog/npm/peer-dependencies/

Ama gerçekten anlamıyorum.

Misal

Şu anda yerel bir cihazda sunulacak bir / dist / klasörüne kaynak dosyalarımı oluşturmak için Grunt görevlerini kullanan AppGyver Steroids ile çalışıyorum. Ben npm ve grunt oldukça yeniyim, bu yüzden neler olup bittiğini tam olarak anlamak istiyorum.

Şimdiye kadar bunu alıyorum:

[rootfolder] /package.json , npm'ye grunt-steroidsgeliştirme için npm paketine bağlı olduğunu söyler :

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

Tamam. [Rootfolder] 'da npm kurulumunu çalıştırmak bağımlılığı algılar ve [rootfolder] / node_modules / grunt-steroid'lerine homurdanma steroidleri kurar .

Npm sonra kendi bağımlılıklarını yükleyebilir böylece [rootfolder] /node_modules/grunt-steroids/package.json okur . grunt-steroids:

"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"
  },

" Bağımlılıklar " paketleri benim için mantıklı olan [rootfolder] / node_modules / grunt-steroids / node_modules içine kurulur .

" DevDependencies " yüklü değil, eminim sadece kullanmaya çalışıyorum grunt-steroidsve üzerinde geliştirmek değil npm tespit tarafından kontrol edilir .

Ama sonra " peerDependencies " var.

Bunlar [rootfolder] / node_modules içine kuruludur ve [rootfolder] / node_modules / grunt-steroids / node_modules içinde neden bulunmadığını ve diğer homurdanma eklentileriyle (ya da her neyse) çatışmaların önlenmesini neden anlamıyorum ?

TL; DR: ^[1] peerDependencies , açıkta olmayan "özel" bağımlılıkların aksine, tüketen koda maruz kalan (ve kullanması beklenen) bağımlılıklar içindir ve yalnızca bir uygulama ayrıntısıdır.

Eş akran bağımlılıklarının çözdüğü problem

NPM'nin modül sistemi hiyerarşiktir. Daha basit senaryolar için büyük bir avantaj, bir npm paketi yüklediğinizde, bu paketin kendi bağımlılıklarını beraberinde getirmesi ve böylece kutudan çıkmasıdır.

Ancak sorunlar şu durumlarda ortaya çıkar:

• Hem projeniz hem de kullandığınız bazı modüller başka bir modüle bağlıdır.
• Üç modül birbiriyle konuşmak zorundadır.

Örnek olarak

Diyelim ki bina YourCoolProjectyapıyorsunuz JacksModule 1.0ve ikisini de kullanıyorsunuz ve JillsModule 2.0. Diyelim ki bunun JacksModuleda bağlı olduğunu JillsModule, ancak farklı bir versiyona, diyelim 1.0. Bu 2 sürüm karşılanmadığı sürece sorun yoktur. Yüzeyin altında JacksModulekullanılması gerçeği JillsModulesadece bir uygulama detayıdır. JillsModuleİki kez paketliyoruz , ancak kutudan istikrarlı yazılım aldığımızda ödemek için küçük bir fiyat.

Ama şimdi ya bir JacksModuleşekilde bağımlılığını ortaya çıkarırsa JillsModule. Örneğin bir örneğini kabul eder JillsClass... Kütüphanenin kullanım new JillsClasssürümünü oluşturup 2.0ona ilettiğimizde ne olur jacksFunction? Bütün cehennem gevşeyecek! Basit şeyler gibi jillsObject instanceof JillsClassaniden dönecektir falseçünkü jillsObjectaslında bir örneğidir başka JillsClass , 2.0versiyonu.

Akran bağımlılıkları bunu nasıl çözer?

Npm söylüyorlar

Bu pakete ihtiyacım var, ancak modülün bazı özel sürümlerine değil, projenin bir parçası olan sürüme ihtiyacım var.

Npm, paketinizin bu bağımlılığa sahip olmayan veya uyumsuz bir sürümü olan bir projeye yüklendiğini gördüğünde , yükleme işlemi sırasında kullanıcıyı uyarır.

Akran bağımlılıklarını ne zaman kullanmalısınız?

• Diğer projeler tarafından kullanılacak bir kütüphane oluştururken ve
• Bu kütüphane başka bir kütüphane kullanıyor ve
• Kullanıcının diğer kütüphaneyle de çalışmasını beklersiniz / ihtiyacınız var

Genel senaryolar, daha büyük çerçeveler için eklentilerdir. Gulp, Grunt, Babel, Mocha, vs. gibi şeyleri düşünün. Bir Gulp eklentisi yazarsanız, bu eklentinin, Gulp'in kendi özel sürümünüzle değil, kullanıcının projesinin kullandığı aynı Gulp ile çalışmasını istersiniz.

Açıklamalar

1. Çok uzun; okumadım. Çok uzun sayılan bir metnin kısa bir özetini belirtmek için kullanılır.

Önce makaleyi tekrar okumanızı tavsiye ederim. Biraz kafa karıştırıcı ama Winston-mail ile olan örnek size bunun cevabını gösteriyor:

Örneğin, bu gibi yapalım winston-mail@0.2.3belirtilen "winston": "0.5.x"onun içinde "dependencies"o karşı test edilmiştir son sürümü çünkü nesne. Bir uygulama geliştiricisi olarak, en son ve en harika şeyleri istersiniz, böylece en son sürümlerini arar winstonve winston-mailpaketinize koyarsınız.

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

Ancak şimdi, npm install komutunun çalıştırılması,

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

Bu durumda, bazı sorunlara neden olacak bir paketin birden fazla sürümüne sahip olmak mümkündür. Eş bağımlılıkları, npm geliştiricilerinin kullanıcının belirli bir modüle (kök klasöründe) sahip olduğundan emin olmasını sağlar. Ancak, bir paketin belirli bir sürümünü tanımlamanın, diğer sürümleri kullanan diğer paketlerle ilgili sorunlara yol açacağı noktasında haklısınız. Makalelerin belirttiği gibi, bu sorun npm geliştiricileriyle ilgilidir.

Tek bir tavsiye : düzenli bağımlılıklardan farklı olarak, akran bağımlılığı gereklilikleri yumuşak olmalıdır . Eş bağımlılıklarınızı belirli yama sürümlerine kilitlememelisiniz.

Bu nedenle geliştiriciler peerDependencies tanımlamak için semver takip etmelidir. GitHub'daki grunt-steroid paketi için bir sorun açmalısınız ...

peerDependencies mümkün olan en basit örnekle açıkladı:

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


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

myPackage'da npm install çalıştırıldığında, React sürümünü ^15.0.0VE fooyalnızca React ile uyumlu olan yüklemeye çalıştığı için bir hata gönderilir ^16.0.0.

peerDependencies yüklü DEĞİLDİR.