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

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

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

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

Thí dụ

Tôi đang làm việc với AppGyver Steroids tại thời điểm 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 phục vụ trên một thiết bị cục bộ. Tôi khá mới ở npm và grunt vì vậy tôi muốn hiểu đầy đủ những gì đang diễn ra.

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

[rootfolder] /package.json nói với 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 [rootfolder] phát hiện sự phụ thuộc và cài đặt grunt-steroid trong [rootfolder] / node_modules / grunt-steroids .

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

"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 hợp lý với tôi.

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

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

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

TL; DR: ^[1] 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 bị lộ và chỉ là một chi tiết triển khai.

Các 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 cho các kịch bản đơn giản hơn là khi bạn cài đặt gói npm, gói đó mang phụ thuộc riêng của nó với nó để nó sẽ hoạt động tốt.

Nhưng vấn đề phát 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ô-đ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 vào một phiên bản khác, nói 1.0. Miễn là 2 phiên bản đó không đáp ứng, không có vấn đề gì. Thực tế JacksModulelà sử dụng JillsModulebên dưới bề mặt chỉ là một chi tiết thực hiện. Chúng tôi đang 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ờ nếu như JacksModulephơi bày sự phụ thuộc của nó vào JillsModulemột cách nào đó. Nó chấp nhận một ví dụ của JillsClassví dụ ... Điều gì 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ó sang jacksFunction? Tất cả địa ngục sẽ vỡ ra! 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.

Làm thế nào phụ thuộc ngang hàng giải quyết điều này

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 là 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 sử dụng bởi các dự án khác, 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 kịch bản phổ biến là các plugin cho các khung 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.

Chú thích

1. Quá lâu; đã không đọc. Được sử dụng để chỉ một bản tóm tắt ngắn cho một văn bản mà người ta cho là quá dài.

Tôi muốn giới thiệu bạn đọc lại bài viết trước. Hơi khó hiểu một chút nhưng ví dụ với winston-mail cho bạn thấy câu trả lời tại sao:

Ví dụ: hãy giả vờ rằng nó winston-mail@0.2.3được chỉ định "winston": "0.5.x"trong "dependencies"đối tượng của nó bởi 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 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à đặt chúng trong gói.json của bạn như

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

Nhưng bây giờ, chạy npm cài đặt kết quả trong biểu đồ phụ thuộc không mong muốn của

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

Trong trường hợp này, có thể có nhiều phiên bản của gói sẽ gây ra một số vấn đề. Các 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 quan điểm mô tả một phiên bản cụ thể của gói sẽ dẫn đến các vấn đề với các gói khác 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

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 các phụ thuộc thông thường, nên được khoan dung . Bạn không nên khóa 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 ngang hàng. Bạn nên mở một sự cố cho gói grunt-steroid trên GitHub ...

peerDependencies giải thích với 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 cài đặt npm trong myPackage sẽ gây ra lỗi vì nó đang cố cài đặt phiên bản React ^15.0.0VÀ foochỉ tương thích với React ^16.0.0.

ngang hàng KHÔNG được cài đặt.