30 روز با Node - روز هشتم: انتشار پکیج در کتابخانه npm

22 مرداد 1397
publish-npm-package

قصد دارید که یک پکیج از خودتان در کتابخانه  npm منتشر کنید؟ خب باید به شما بگویم که ابتدا باید یک حساب کاربری در npm ایجاد کنید. اگر از قبل یک حساب کاربری دارید که عالی است و در غیر این صورت باید مراحل زیر را دنبال کنید.

از (اینجا) یک حساب کاربری ایجاد کنید.

۱) روی signup کلیک کنید:

ثبت نام در سایت npmjs

۲) اطلاعات خود را وارد کنید:

وارد کردن اطلاعات در سایت npmjs

۳) روی Create an Account کلیک کنید:

کلیک روی دکمه create an account در وب سایت npmjs.com

به شما تبریک می گوییم. حساب کاربری شما ساخته شد.

ایجاد یک پکیج آماده‌ی انتشار

اکنون باید متدها را export کنیم. بدین خاطر که بتوان آنها را دردسترس اپلیکیشن های دیگر قرارداد. روش کار چنین است:

								
var function_name_1 = function (parameters){
						
					Function code starts
					...				...
					...				...
					Functionality
					...  			...
					...				...
					Function ends here 
					}
var function_name_2 = function (parameters){

						
					Function code starts
					...				...
					...				...
					Functionality
					...  			...
					...				...
					Function ends here 				
					}
module.exports = {
	function_1 : function_name_1,
	function_2 : function_name_2
	}; 
								

آزمایش: برای بررسی اینکه کار می کند یا خیر، بهترین کار این است که آن را در یک اپلیکیشن محلی ایمپورت کنیم. به صورت زیر:

var fun = require('/filename');
var param = ["a" , "demo" , "array"];
var output =  fun(param);
console.log(output);

اگر کد بالا بخوبی اجرا شد، بدین معناست که آزمایش با موفقیت به پایان رسیده و پکیج ما آماده انتشار است.

package.json

مهمترین فایلی که در زمان انتشار باید به آن توجه کنید، همین فایل است: package.json. بدون این فایل، انتشار ممکن نیست. ولی شما در روز هفتم آموزش نود جی اس یاد گرفتید چگونه آن را بسازید. پس مشکلی نباید داشته باشید. package.json حاوی تمام اطلاعات مرتبط با پکیج شما خواهد بود.

انتشار در npm

برای انتشار یک پکیج، باید مراحل زیر را انجام دهید:

Login: با استفاده از نام کاربری و رمز عبور خود در npm، از طریق خط فرمان، وارد حساب کاربری خود شوید: npm login

>npm login
Username: roxo
Password:
Email: (this IS public) youemail@nodejsera.com
Logged in as nodejsera on https://registry.npmjs.org/.			

شما با موفقیت وارد شده اید!

انتشار: وارد ریشه‌ی پوشه‌ی پکیج خود شوید و دستور npm publish را وارد کنید. این کار باعث می‌شود که اطلاعات پکیج شما از package.json خوانده شود. چنانچه در پکیج شما نامی وجود داشته باشد که با پکیج های دیگر برخورد داشته باشد، خطایی اتفاق می افتد، در غیر اینصورت پکیج شما منتشر خواهد شد و می توانید آن را در npm ببینید.

>npm publish

با دستور فوق، هر چیزی در پوشه منتشر خواهد شد مگر آنهایی که در فایلهای .gitignore یا .npmignore مستثنی کرده اید.

بروزرسانی یک پکیج که قبلا منتشر شده است

چنانچه پکیجی را منتشر کردیم و بعدها تغییری در آن دادیم، باید در npm هم بروزرسانی کنیم. این کار با دستور
npm version <update_type>
انجام می گیرد. update_type در واقع یکی از شماره نسخه های گونه، اصلی، فرعی و patch است .شماره نسخه نیز از فایل package.json بروزرسانی می‌شود. پس از بروزرسانی شماره نسخه، باید مجددا همانند آنچه در بالا گفتیم، با دستور
npm publish
پکیج را منتشر کنیم.

Summary

در این فصل از سری آموزشی 30 روز با نودجی اس، نحوه ایجاد حساب کاربری در npm را یادگرفتیم و علاوه بر آن پکیج خودمان را آماده انتشار کردیم. اهمیت فایل package.json را برای انتشار متوجه شدیم و در نهایت نحوه انتشار پکیج و بروزرسانی آن را به کمک npm فرا گرفتیم.

نویسنده شوید

دیدگاه‌های شما (1 دیدگاه)

در این قسمت، به پرسش‌های تخصصی شما درباره‌ی محتوای مقاله پاسخ داده نمی‌شود. سوالات خود را اینجا بپرسید.

حسن مرادی فرد
10 اردیبهشت 1399
بسیار بسیار عالی و کاربردی.فقط یه سوال برام پیش اومده.این پکیج که من گذاشتم تو سایت npm فقط با یوزر و پسورد خودم قابل مشاهده است.چون تو داکیومنت پروژم یه لینک دادم که بیان تو سایت npm و از این پکیج در صورت نیاز استفاده کنند ولی نام کاربری و رمز عبور از کاربر میخواد.در صورت امکان راهنمایی کنید ممنون میشم

در این قسمت، به پرسش‌های تخصصی شما درباره‌ی محتوای مقاله پاسخ داده نمی‌شود. سوالات خود را اینجا بپرسید.