NPM peerDependencies in Depth: Satu Pengenalan Komprehensif

Sebagai pembangun Javascript, kita semua mengetahui dua kebergantungan berbeza dalam projek kami, kebergantungan dan devDependencies, tetapi bagaimana pula dengan peerDependencies?

Dalam siri ini, kami akan mengkaji pergantungan yang kurang biasa ini dalam Javascript. Kami akan mengkaji apa itu, perkara yang perlu saya ketahui sebagai pengguna perpustakaan dan amalan terbaik untuk pengarang perpustakaan.

Apakah kebergantungan dalam NPM

Mari kita imbas semula jenis biasa yang berbeza:

• pergantungan: ini ialah alatan yang digunakan dalam aplikasi anda; contoh yang baik ialah tindak balas, sudut, dan nyata. Apabila aplikasi anda sedang dalam pengeluaran, kod perpustakaan pada kebergantungan akan dijalankan di bawah hud dan kuasa aplikasi anda.

• devDependencies: Anda akan menggunakan utiliti ini untuk membina aplikasi anda. Di sini, anda akan menemui perpustakaan untuk menyusun atau menghuraikan kod anda dan perpustakaan untuk menjalankan ujian anda.

Apakah itu PeerDependencies

Pengarang menentukan perpustakaan tertentu sebagai PeerDependency apabila mereka memerlukannya untuk dipasang di ruang kerja/projek agar semuanya berfungsi seperti yang diharapkan. Mereka memberitahu NPM (dan pembangun memasang perpustakaan) bahawa pakej tersebut memerlukan versi khusus pakej lain (atau julat versi) untuk berfungsi dengan betul. Namun, pengguna bertanggungjawab untuk memasang dan mengurus pergantungan itu.

Mari bayangkan contoh: Anda sedang mencipta utiliti untuk rangka kerja kegemaran anda, yang harus dipasang dalam persekitaran tempat pustaka anda akan dijalankan. Cara untuk menentukan senario ini dengan tepat ialah menggunakan ciri Kebergantungan rakan sebaya NPM. Ia menyediakan garis panduan yang jelas untuk penyepaduan lancar perpustakaan anda.

Amalan ini sangat biasa di perpustakaan yang berfungsi sebagai "pemalam", kerana ia perlu menunjukkan keperluan ruang kerja untuk kefungsian yang betul.

Contoh Sebenar Kebergantungan rakan sebaya

Mari kita analisa perpustakaan React yang popular, react-datepicker; jika kita melihat bagaimana package.jsonnya kelihatan hari ini, kita dapat mengetahui bahawa kita memerlukan sekurang-kurangnya versi React ^16.9.0 untuk pemilih tarikh tindak balas berfungsi dengan betul.

"peerDependencies": {
  "react": "^16.9.0 || ^17 || ^18",
  "react-dom": "^16.9.0 || ^17 || ^18"
},

Jika kita gagal mematuhi keperluan ini, tingkah laku yang tidak dijangka akan timbul.

The Challenges peerDependencies Alamat

Konflik versi berlaku apabila pakej dalam projek bergantung pada versi pustaka yang sama yang berbeza. Ini boleh membawa kepada ralat, terutamanya untuk perpustakaan seperti React, yang berkongsi contoh yang sama adalah penting untuk pengurusan negeri dan komunikasi komponen. Tanpa PeerDependencies, berbilang versi perpustakaan boleh dipasang, mengakibatkan tingkah laku yang tidak dijangka.

Untuk mengelakkan isu ini, peerDependencies membenarkan pengarang pakej untuk menentukan versi pergantungan yang diperlukan oleh pakej mereka tanpa memasangnya secara langsung. Ini mengalihkan tanggungjawab kepada pembangun menggunakan pakej, memastikan mereka memasang versi pergantungan tunggal yang serasi. Contohnya, perpustakaan seperti react-datepicker dan react-router menggunakan peerDependencies untuk memastikan ia berfungsi dengan lancar dengan versi React yang sama dalam projek.

Contoh lain

Bayangkan senario ini: Anda sedang mencipta pustaka untuk berkongsi pengendali mewah untuk rxjs. Jika anda menetapkan rxjs sebagai dependensi dan bukannya peerDependency, pustaka anda akan memasang versi rxjs sendiri. Ini mungkin tidak kelihatan seperti masalah besar pada mulanya, tetapi sebenarnya, ia boleh menyebabkan konflik versi.

Jika projek yang memasang pustaka anda sudah menggunakan versi rxjs yang berbeza, ia boleh menyebabkan isu yang ketara. Aplikasi mungkin berakhir dengan dua contoh rxjs (satu daripada pustaka anda dan satu daripada projek itu sendiri). Memandangkan rxjs sangat bergantung pada pemerhatian dan langganan dikongsi, menjalankan dua versi serentak boleh mengakibatkan tingkah laku yang tidak dapat diramalkan, seperti strim tidak disegerakkan dengan betul atau acara hilang.

Dengan menggunakan peerDependencies sebaliknya, anda boleh mengelakkan masalah ini. Pakej anda akan memberi isyarat kepada projek bahawa ia menjangkakan versi tertentu (atau julat) rxjs akan hadir, tetapi ia tidak akan memasang versinya sendiri. Dengan cara ini, projek akan menggunakan satu versi rxjs yang dikongsi oleh pustaka anda dan bahagian lain pangkalan kod, memastikan semuanya berjalan lancar dan harmoni.

Kesimpulan

peerDependencies mungkin tidak dibincangkan seperti yang biasa dibincangkan seperti dependencies atau devDependencies, tetapi mereka memainkan peranan penting dalam memastikan keserasian dan mengelakkan konflik versi dalam projek yang kompleks. Dengan mentakrifkan dengan jelas versi pergantungan kongsi yang diperlukan oleh perpustakaan tanpa memasangnya secara langsung, peerDependencies membenarkan pembangun mengekalkan kawalan ke atas persekitaran projek mereka.

Matlamat siaran pertama ini adalah untuk mewujudkan asas pemahaman yang baik tentang Ketergantungan rakan sebaya. Dalam bab seterusnya siri ini, kami akan meneroka dengan cara yang lebih praktikal aspek berbeza PeerDependencies sebagai pengguna perpustakaan dengan peerDependencies, cara mengatasi masalah biasa dan cara mereka berkelakuan dalam pengurus pakej javascript yang berbeza.

Atas ialah kandungan terperinci NPM peerDependencies in Depth: Satu Pengenalan Komprehensif. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!