ساخت و انتشار پکیج NPM

معرفی NPM

NPM بزرگترین رجیستری نرم افزار در اینترنت است. بیش از یک میلیون بسته در کتابخانه NPM وجود دارد.

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

در این مقاله با نحوه ساخت پکیج آشنا می شوید. و همچنین یاد خواهید گرفت که چگونه بسته خود را در NPM منتشر کنید تا دیگران بتوانند آن را دانلود و استفاده کنند.

گام اول: انتخاب نام برای پکیج

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

وقتی نامی را انتخاب کردید، به رجیستری NPM بروید و جستجو کنید. مطمئن شوید که هیچ تطابق دقیقی با نامی که انتخاب کرده اید (یا تطابقی که خیلی شبیه است) وجود ندارد.

به عنوان مثال، اگر بسته ای به نام hellonpmpackage وجود داشته باشد و شما تصمیم بگیرید که بسته hello-npm-package خود را فراخوانی کنید، NPM هنگام تلاش برای انتشار آن با خطا مواجه می شود.

در این آموزش ما نام farid-karami-npm را برای پکیج خود انتخاب می کنیم.

گام دوم: نصب Node

اگر قبلا Node را نصب نکرده اید، باید آن را نصب کنید. برای دانلود و نصب Node.js می توانید به وب سایت رسمی آن مراجعه کنید.

توجه نمایید که بعد از نصب کردن Node نیازی به نصب NPM نیست زیرا همراه با Node نصب می شود.

گام سوم: راه اندازی ریپازیتوری Git

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

نکته: بهتر است نام پوشه همان نامی باشد که برای پکیج انتخاب کرده اید.

git init

نکته: قرار دادن پروژه در Git جزو الزامات ساخت پیج در NPM نیست و می توانید از این مرحله صرف نظر کنید اما این به شما کمک می کند تغییراتی که در پکیج خود ایجاد می کنید را پیگیری کنید. همچنین پکیج هایی که لینک ریپازیتوری Git ندارند از نظر جامعه نرم افزاری قابل اعتماد نیستند.

گام چهارم: راه اندازی NPM در پروژه

برای انجام این کار، به دایرکتوری اصلی پروژه خود بروید و دستور زیر را اجرا کنید.

npm init

این دستور یک فایل package.json ایجاد می کند. برای ارائه اطلاعات زیر پیام هایی دریافت خواهید کرد.

• package-name: همانطور که قبلا در این آموزش آموختید، نام پکی شما باید منحصر به فرد باشد. همچنین باید با حروف کوچک باشد. ممکن است شامل خط فاصله باشد.
• version: مقدار اولیه 1.0.0 است. وقتی بسته خود را با استفاده از نسخه سازی معنایی به روز می کنید، شماره را به روز می کنید.
• description: در اینجا می توانید توضیحات بسته خود را ارائه دهید. مشخص کنید پیکج شما چه کاری انجام می دهد و چگونه از آن استفاده کنید.
• entry point: فایل ورودی برای کد شما. مقدار پیش فرض index.js است.
• test command: در اینجا، می توانید دستوری را که می خواهید هنگام اجرای npm run test اجرا کنید، اضافه کنید.
• git repository: پیوند به مخزن Git.
• keywords: کلمات کلیدی مرتبط را اضافه کنید که به دیگران کمک می کند پکیج شما را در رجیستری NPM پیدا کنند.
• author: نام خود را اضافه کنید.
• license: می توانید یک مجوز اضافه کنید یا از مجوز پیش فرض (مجوز کنسرسیوم سیستم های اینترنت – ISC) استفاده کنید.

گام پنجم: پیاده سازی منطق و کدنویسی

اکنون شروع به کدنویسی می کنیم و منطق پکیج خود را پیاده سازی می کنیم.

ابتدا باید فایلی را ایجاد کنید که زمانی که ماژول شما توسط برنامه دیگری مورد نیاز است بارگذاری شود. برای این آموزش، آن فایل index.js خواهد بود.

داخل فایل index.js، کد پیکج خود را اضافه کنید.

فرض کنید پکیج ما قرار است دو عدد را دریافت کند و حاصل جمع آن ها را برگرداند.

//index.js

function app(a, b) {
  return a + b;
}

module.exports = app;

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

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

گام ششم: تست پکیج

تست تضمین می کند که پکیج NPM شما همانطور که انتظار می رود کار می کند. راه های زیادی برای تست پکیج شما وجود دارد. در این آموزش یکی از ساده ترین روش های تست زنی را خواهید آموخت.

ابتدا به درون پروژه پکیج خود بروید. سپس دستور زیر را اجرا کنید.

npm link

با این کار پکیج شما در همه جای سیستم عامل در دسترس خواهد بود و شما می توانید به پکیج در پروژه دیگری دسترسی داشته باشید.

یک پوشه جدید به نام test-package بسازید و داخل آن یک فایل script.js اضافه کنید.

تا به اینجا پوشه test-package فقط حاوی فایل script.js است و هنوز حاوی پکیج نیست. برای افزودن پکیجی که ایجاد کرده اید در پوشه test-package خود، دستور زیر را اجرا کنید.

npm link <name-of-package>

پس از افزودن پکیج به پروژه test-package می توانیم به شکل زیر از آن استفاده کنیم.

// test-package/script.js

const fkNPM = require('farid-karami-npm');

console.log(fkNPM(8, 2));

گام هفتم: انتشار پکیج

برای انتشار پکیج در رجیستری NPM، باید یک حساب کاربری داشته باشید. اگر حسابی ندارید، ابتدا در NPM یک حساب کاربری بسازید.

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

npm login

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

Logged in as <your-username> on https://registry.npmjs.org/.

اکنون می توانید دستور زیر را برای انتشار پکیج خود در رجیستری NPM اجرا کنید.

npm publish