Tại sao sử dụng phụ thuộc ngang hàng trong npm cho các plugin?

230
Thomas Stock 2014-11-05 04:36.

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ì)?

3 answers

434
Stijn de Witt 2016-01-07 13:57.

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.0JillsModule 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 falsejillsObjectthự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,
  • Thư viện này đang sử dụng một số thư viện khác
  • 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.

27
Fer To 2015-03-05 03:05.

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 ...

16
Christopher Tokar 2019-05-24 23:13.

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.0foochỉ tương thích với React ^16.0.0.

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

Related questions

MORE COOL STUFF

Cate Blanchett chia tay chồng sau 3 ngày bên nhau và vẫn kết hôn với anh ấy 25 năm sau

Cate Blanchett chia tay chồng sau 3 ngày bên nhau và vẫn kết hôn với anh ấy 25 năm sau

Cate Blanchett đã bất chấp những lời khuyên hẹn hò điển hình khi cô gặp chồng mình.

Tại sao Michael Sheen là một diễn viên phi lợi nhuận

Tại sao Michael Sheen là một diễn viên phi lợi nhuận

Michael Sheen là một diễn viên phi lợi nhuận nhưng chính xác thì điều đó có nghĩa là gì?

Hallmark Star Colin Egglesfield Các món ăn gây xúc động mạnh đối với người hâm mộ tại RomaDrama Live! [Loại trừ]

Hallmark Star Colin Egglesfield Các món ăn gây xúc động mạnh đối với người hâm mộ tại RomaDrama Live! [Loại trừ]

Ngôi sao của Hallmark Colin Egglesfield chia sẻ về những cuộc gặp gỡ với người hâm mộ ly kỳ tại RomaDrama Live! cộng với chương trình INSPIRE của anh ấy tại đại hội.

Tại sao bạn không thể phát trực tuyến 'chương trình truyền hình phía Bắc'

Tại sao bạn không thể phát trực tuyến 'chương trình truyền hình phía Bắc'

Bạn sẽ phải phủi sạch đầu đĩa Blu-ray hoặc DVD để xem tại sao Northern Exposure trở thành một trong những chương trình nổi tiếng nhất của thập niên 90.

Where in the World Are You? Take our GeoGuesser Quiz

Where in the World Are You? Take our GeoGuesser Quiz

The world is a huge place, yet some GeoGuessr players know locations in mere seconds. Are you one of GeoGuessr's gifted elite? Take our quiz to find out!

8 công dụng tuyệt vời của Baking Soda và Giấm

8 công dụng tuyệt vời của Baking Soda và Giấm

Bạn biết đấy, hai sản phẩm này là nguồn điện để làm sạch, riêng chúng. Nhưng cùng với nhau, chúng có một loạt công dụng hoàn toàn khác.

Hạn hán, biến đổi khí hậu đe dọa tương lai của thủy điện Hoa Kỳ

Hạn hán, biến đổi khí hậu đe dọa tương lai của thủy điện Hoa Kỳ

Thủy điện rất cần thiết cho lưới điện của Hoa Kỳ, nhưng nó chỉ tạo ra năng lượng khi có nước di chuyển. Bao nhiêu nhà máy thủy điện có thể gặp nguy hiểm khi các hồ và sông cạn kiệt?

Quyên góp tóc của bạn để giúp giữ nước sạch của chúng tôi

Quyên góp tóc của bạn để giúp giữ nước sạch của chúng tôi

Tóc tỉa từ các tiệm và các khoản quyên góp cá nhân có thể được tái sử dụng như những tấm thảm thấm dầu và giúp bảo vệ môi trường.

BoJack Horseman vẫn gan ruột và gan dạ hơn bao giờ hết trong phần 3

BoJack Horseman vẫn gan ruột và gan dạ hơn bao giờ hết trong phần 3

BoJack Horseman (Ảnh: Netflix) BoJack Horseman bắt đầu mùa thứ ba với sự xuất hiện của nhân vật tiêu biểu, người vẫn đang theo đuổi những lời khen ngợi từ giới phê bình trong một nỗ lực tuyệt vọng để tìm ra ý nghĩa trong cuộc sống của mình. Mùa thứ hai về số phận bi kịch của Raphael Bob-Waksberg dày đặc những trò đùa cũng như tuyệt vọng.

Xem cách tính năng lái tự động cập nhật của Tesla bùng phát như thế nào khi bạn bỏ qua các cảnh báo của nó

Xem cách tính năng lái tự động cập nhật của Tesla bùng phát như thế nào khi bạn bỏ qua các cảnh báo của nó

Bản nâng cấp Phiên bản 8.0 gần đây của Tesla đối với hệ thống Lái xe tự động được thiết kế để cải thiện hệ thống và mối quan hệ của nó với người lái.

UnREAL, Chương trình Truyền hình Về Truyền hình Thực tế Chúng tôi Không biết Chúng tôi Cần

UnREAL, Chương trình Truyền hình Về Truyền hình Thực tế Chúng tôi Không biết Chúng tôi Cần

Chắc chắn khi con cái chúng ta xem lại các chương trình chúng ta đã xem vào khoảng năm 2015, chúng sẽ thấy UnREAL, một chương trình truyền hình mới chiếu vào tối Thứ Hai của Lifetime — bạn sẽ thấy đúng lúc, sẽ phát sóng ngay sau khi The Bachelor kết thúc — như một chương trình không thể được thực hiện vào bất kỳ thời điểm nào khác trong lịch sử truyền hình, nhưng một chương trình cảm thấy cần thiết để xem bây giờ. UnREAL có sự tham gia của Shiri Appleby trong vai Rachel, một nhà sản xuất truyền hình cho một chương trình về cơ bản là The Bachelor, mặc dù trong thế giới này, nó được gọi là Vĩnh viễn.

Sau tất cả, Josh Trank sẽ không đạo diễn bộ phim tuyển tập Star Wars thứ hai

Sau tất cả, Josh Trank sẽ không đạo diễn bộ phim tuyển tập Star Wars thứ hai

Thông báo chính thức đến trực tiếp từ trang web của Star Wars: Fantastic Four, đạo diễn Josh Trank, một người bí ẩn không xuất hiện tại đại hội Star Wars Celebration gần đây, sẽ không chỉ đạo phần hai Star Wars Anthology. Đây là tuyên bố được đăng ngày hôm qua: Tất cả thực sự là ngôn ngữ rất lịch sự, nhưng một bài báo của Hollywood Reporter cho thấy tất cả đều không tốt ở hậu trường, gọi sự ra đi là "một vụ sa thải" một phần dựa trên "hành vi bất thường" của Trank trong khi quay Fantastic Four: The Bài báo trích dẫn các nguồn gọi là Trank “đôi khi thiếu quyết đoán và thiếu sáng tạo,” và lưu ý rằng Fantastic Four, khởi chiếu vào ngày 7 tháng 8, đã được khởi động lại vào cuối tháng 4.

Edwin McCain ra mắt Grand Ole Opry: Quay cảnh hậu trường với nhạc sĩ 'I'll Be'

Edwin McCain ra mắt Grand Ole Opry: Quay cảnh hậu trường với nhạc sĩ 'I'll Be'

McCain, người đang làm việc cho một album mới, lần đầu tiên bước vào vòng kết nối vào tối thứ Sáu ở Nashville

Nicky Hilton Forced to Borrow Paris' 'I Love Paris' Sweatshirt After 'Airline Loses All [My] Luggage'

Nicky Hilton Forced to Borrow Paris' 'I Love Paris' Sweatshirt After 'Airline Loses All [My] Luggage'

Nicky Hilton Rothschild's luggage got lost, but luckily she has an incredible closet to shop: Sister Paris Hilton's!

Kate Middleton dành một ngày bên bờ nước ở London, cùng với Jennifer Lopez, Julianne Hough và hơn thế nữa

Kate Middleton dành một ngày bên bờ nước ở London, cùng với Jennifer Lopez, Julianne Hough và hơn thế nữa

Kate Middleton dành một ngày bên bờ nước ở London, cùng với Jennifer Lopez, Julianne Hough và hơn thế nữa. Từ Hollywood đến New York và mọi nơi ở giữa, hãy xem các ngôi sao yêu thích của bạn đang làm gì!

17 tuổi bị đâm chết trong khi 4 người khác bị thương trong một cuộc tấn công bằng dao trên sông Wisconsin

17 tuổi bị đâm chết trong khi 4 người khác bị thương trong một cuộc tấn công bằng dao trên sông Wisconsin

Các nhà điều tra đang xem xét liệu nhóm và nghi phạm có biết nhau trước vụ tấn công hay không

Tôi viết như thế nào

Tôi viết như thế nào

Đối với tôi, mọi thứ là về dòng đầu tiên đó và nó sẽ đưa bạn đến đâu. Một số nhà văn bị điều khiển bởi cốt truyện, sự sắp xếp tinh tế của các quân cờ, trong khi những người khác bị lôi cuốn bởi một nhân vật và khả năng thực hiện một cuộc hành trình với một người bạn hư cấu mới.

Đường băng hạ cánh

Đường băng hạ cánh

Cuối hè đầu thu là mùa hoài niệm. Những chiếc đèn đường chiếu ánh sáng của chúng qua những con đường đẫm mưa, và những chiếc lá dưới chân - màu đỏ cam tắt trong bóng chạng vạng - là lời nhắc nhở về những ngày đã qua.

Hãy tưởng tượng tạo ra một chiến lược nội dung thực sự CHUYỂN ĐỔI. Nó có thể.

Hãy tưởng tượng tạo ra một chiến lược nội dung thực sự CHUYỂN ĐỔI. Nó có thể.

Vào năm 2021, tôi khuyến khích bạn suy nghĩ lại mọi thứ bạn biết về khách hàng mà bạn phục vụ và những câu chuyện bạn kể cho họ. Lùi lại.

Sự mất mát của voi ma mút đã mở ra trái tim tôi để yêu

Sự mất mát của voi ma mút đã mở ra trái tim tôi để yêu

Vào ngày sinh nhật thứ 9 của Felix The Cat, tôi nhớ về một trong những mất mát lớn nhất trong cuộc đời trưởng thành của tôi - Sophie của tôi vào năm 2013. Tôi đã viết bài luận này và chia sẻ nó trên nền tảng này một thời gian ngắn vào năm 2013.

Language