Ví dụ: tại sao một plugin Grunt lại định nghĩa sự phụ thuộc của nó vào grunt là " sự phụ thuộc ngang hàng "?

Tại sao plugin không thể chỉ có Grunt làm phần phụ thuộc của chính nó trong grunt-plug / node_modules ?

Sự phụ thuộc ngang hàng được mô tả tại đây: https://nodejs.org/en/blog/npm/peer-dependencies/

Nhưng tôi không thực sự hiểu nó.

Thí dụ

Hiện tại, tôi đang làm việc với AppGyver Steroids, công cụ này sử dụng các tác vụ Grunt để xây dựng các tệp nguồn của tôi thành một thư mục / dist / để được cung cấp trên thiết bị cục bộ. Tôi còn khá mới vào npm và hay càu nhàu nên tôi muốn hiểu đầy đủ những gì đang xảy ra.

Cho đến nay tôi nhận được điều này:

[rootfolder] /package.json cho biết npm nó phụ thuộc vào grunt-steroidsgói npm để phát triển:

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

Được chứ. Chạy cài đặt npm trong [thư mục gốc] sẽ phát hiện sự phụ thuộc và cài đặt grunt-steroid trong [thư mục gốc] / node_modules / grunt-steroid .

Npm sau đó đọc [rootfolder] /node_modules/grunt-steroids/package.json để nó có thể cài đặt các grunt-steroidsphụ thuộc của riêng mình.:

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

Các gói " phụ thuộc " được cài đặt vào [rootfolder] / node_modules / grunt-steroids / node_modules , điều này là hợp lý đối với tôi.

" DevDependencies " không được cài đặt, mà tôi chắc chắn được kiểm soát bởi npm phát hiện ra rằng tôi chỉ đang cố gắng sử dụng grunt-steroidschứ không phát triển trên nó.

Nhưng sau đó chúng ta có " peerDependencies ".

Chúng được cài đặt trong [rootfolder] / node_modules và tôi không hiểu tại sao lại có và không có trong [rootfolder] / node_modules / grunt-steroids / node_modules để tránh xung đột với các plugin khác (hoặc bất cứ thứ gì)?

TL; DR: peerDependencies dành cho các phụ thuộc được tiếp xúc với (và dự kiến ​​sẽ được sử dụng bởi) mã tiêu thụ, trái ngược với các phụ thuộc "riêng tư" không được hiển thị và chỉ là chi tiết triển khai.

Vấn đề phụ thuộc ngang hàng giải quyết

Hệ thống mô-đun của NPM là phân cấp. Một lợi thế lớn đối với các kịch bản đơn giản hơn là khi bạn cài đặt gói npm, gói đó mang theo các phụ thuộc của riêng nó với nó nên nó sẽ hoạt động hiệu quả.

Nhưng vấn đề nảy sinh khi:

• Cả dự án của bạn và một số mô-đun bạn đang sử dụng đều phụ thuộc vào một mô-đun khác.
• Ba mô-đun phải nói chuyện với nhau.

Trong ví dụ

Giả sử bạn đang xây dựng YourCoolProjectvà bạn đang sử dụng cả hai JacksModule 1.0và JillsModule 2.0. Và giả sử điều đó JacksModulecũng phụ thuộc vào JillsModule, nhưng trên một phiên bản khác 1.0. Miễn là 2 phiên bản đó không gặp nhau thì không có vấn đề gì. Thực tế JacksModuleđang sử dụng JillsModulebên dưới bề mặt chỉ là một chi tiết triển khai. Chúng tôi đang đóng gói JillsModulehai lần, nhưng đó là một cái giá nhỏ phải trả khi chúng tôi nhận được phần mềm ổn định.

Nhưng bây giờ điều gì sẽ xảy JacksModulera nếu lộ ra sự phụ thuộc của nó JillsModuletheo một cách nào đó. Nó chấp nhận một phiên bản chẳng JillsClasshạn ... Điều gì sẽ xảy ra khi chúng ta tạo một new JillsClassphiên bản sử dụng 2.0của thư viện và chuyển nó đến jacksFunction? Tất cả địa ngục sẽ tan vỡ! Những điều đơn giản như thế jillsObject instanceof JillsClasssẽ bất ngờ quay trở lại falsevì jillsObjectthực sự là một thể hiện của một JillsClass , các 2.0phiên bản.

Cách giải quyết vấn đề phụ thuộc ngang hàng

Họ nói với npm

Tôi cần gói này, nhưng tôi cần phiên bản là một phần của dự án, không phải một số phiên bản riêng tư cho mô-đun của tôi.

Khi npm thấy rằng gói của bạn đang được cài đặt vào một dự án không có sự phụ thuộc đó hoặc có phiên bản không tương thích của nó, nó sẽ cảnh báo người dùng trong quá trình cài đặt.

Khi nào bạn nên sử dụng phụ thuộc ngang hàng?

• Khi bạn đang xây dựng một thư viện để các dự án khác sử dụng, và
• Thư viện này đang sử dụng một số thư viện khác và
• Bạn mong đợi / cần người dùng làm việc với thư viện khác

Các tình huống phổ biến là các phần bổ trợ cho các khuôn khổ lớn hơn. Hãy nghĩ về những thứ như Gulp, Grunt, Babel, Mocha, v.v. Nếu bạn viết một plugin Gulp, bạn muốn plugin đó hoạt động với cùng một Gulp mà dự án của người dùng đang sử dụng, không phải với phiên bản Gulp riêng của bạn.

Tôi muốn khuyên bạn đọc lại bài báo trước. Nó hơi khó hiểu nhưng ví dụ với wonton-mail cho bạn thấy câu trả lời tại sao:

Ví dụ: hãy giả sử điều đó winston-[email protected]được chỉ định "winston": "0.5.x"trong "dependencies"đối tượng của nó vì đó là phiên bản mới nhất mà nó đã được thử nghiệm. Là một nhà phát triển ứng dụng, bạn muốn có những thứ mới nhất và tuyệt vời nhất, vì vậy, bạn tìm kiếm các phiên bản mới nhất winstonvà của winston-mailvà đưa chúng vào package.json của bạn như

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

Nhưng bây giờ, việc chạy npm install dẫn đến biểu đồ phụ thuộc không mong đợi của

├── [email protected]  
└─┬ [email protected]                
  └── [email protected]

Trong trường hợp này, có thể có nhiều phiên bản của một gói sẽ gây ra một số vấn đề. Sự phụ thuộc ngang hàng cho phép các nhà phát triển npm đảm bảo rằng người dùng có mô-đun cụ thể (trong thư mục gốc). Nhưng bạn đúng với điểm rằng việc mô tả một phiên bản cụ thể của một gói sẽ dẫn đến các vấn đề với các gói khác bằng cách sử dụng các phiên bản khác. Vấn đề này liên quan đến các nhà phát triển npm, như các bài báo nêu rõ

Một lời khuyên : các yêu cầu phụ thuộc ngang hàng, không giống như các yêu cầu đối với phụ thuộc thông thường, nên được khoan dung . Bạn không nên khóa các phụ thuộc ngang hàng của mình xuống các phiên bản vá cụ thể.

Do đó, các nhà phát triển nên tuân theo semver để xác định peerDependencies. Bạn nên mở một vấn đề cho gói grunt-steroid trên GitHub ...

peerDependencies được giải thích bằng ví dụ đơn giản nhất có thể:

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


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

chạy npm install trong myPackage sẽ gặp lỗi vì nó đang cố gắng cài đặt phiên bản React ^15.0.0VÀ foochỉ tương thích với React ^16.0.0.

peerDependencies KHÔNG được cài đặt.