هیچ شکی در آن وجود ندارد: کتابخانه های جاوا اسکریپت قابل توجه در npm هستند. کتابخانه شما می تواند با چند مرحله ساده به آنها بپیوندد.
Node Package Manager که با نام عمومی npm شناخته می شود، یک مخزن آنلاین برای انتشار بسته ها و کتابخانه های NodeJS است.
همچنین یک ابزار خط فرمان است که به شما امکان می دهد با بسته های ثبت شده تعامل داشته باشید. می تواند به نصب بسته، مدیریت نسخه و مدیریت وابستگی کمک کند.
توسعه دهندگان کتابخانه های جاوا اسکریپت خود را هر روز در npm منتشر می کنند. این فرآیند نسبتاً ساده است، بنابراین شما نیز می توانید یک بسته را در npm منتشر کنید.
مرحله 1: نصب NodeJS
برای تعامل با npm، باید آن را به صورت سراسری روی سیستم خود نصب کنید.
با نصب NodeJS و npm در اوبونتو، در ویندوز، یا با دنبال کردن دستورالعمل های وب سایت NodeJS شروع کنید.
مرحله 2: ایجاد یک حساب npm
برای انتشار بسته های خود در npm، باید یک حساب npm در وب سایت رسمی npm ایجاد کنید.
برای ایجاد حساب npm مراحل زیر را دنبال کنید:
- به صفحه ثبت نام npm بروید.
- مشخصات خود را پر کنید، با مجوز و خط مشی رازداری موافقت کنید و روی “ایجاد حساب” کلیک کنید.
- ایمیل خود را با پیوندی که از npm در صندوق پستی خود دریافت خواهید کرد، تأیید کنید.
اگر آدرس ایمیل خود را تأیید نکنید، npm هنگام تلاش برای انتشار بسته های خود با خطا مواجه می شود.
مرحله 3: راه اندازی یک مخزن Git
در مرحله بعد، باید یک مخزن Git را مقداردهی اولیه کنید تا تمام تغییراتی که در پروژه خود ایجاد می کنید را ردیابی کنید.
در ترمینال خود، به دایرکتوری ریشه پروژه خود بروید و دستور زیر را برای مقداردهی اولیه یک مخزن خالی Git اجرا کنید.
git init
یک فایل .gitignore ایجاد کنید و هر فایلی را که نمی خواهید Git ردیابی کند اضافه کنید. سپس دستور زیر را برای ردیابی فایل های باقی مانده اجرا کنید:
git add -A
سپس دستور زیر را اجرا کنید تا با قرار دادن کد در Git، اولین عکس فوری خود را بگیرید.
git commit -m initial-commit
برای همکاری بی‌وقفه می‌توانید مخزن Git خود را در GitHub یا سرویسی مشابه مانند Gitlab میزبانی کنید.
مرحله 4: مقداردهی اولیه npm در پروژه شما
سپس، npm را در پروژه خود مقداردهی کنید تا جزئیات پروژه خود را به فایل package.json اضافه کنید. این جزئیات در npm عمومی خواهد شد.
در ترمینال خود، به دایرکتوری ریشه پروژه خود بروید و دستور زیر را برای مقداردهی اولیه npm در پروژه خود اجرا کنید.
npm init
دستور بالا مجموعه ای از دستورات را در خط فرمان شما راه اندازی می کند:
- بسته نام: این نام بسته npm شما است. اگر می خواهید بسته را در npm منتشر کنید باید منحصر به فرد باشد. در غیر این صورت، npm یک خطا ایجاد می کند.
- version: این ویژگی نشان دهنده نسخه فعلی بسته شما است. هر بار که بسته خود را به روز می کنید باید آن را افزایش دهید در غیر این صورت npm خطایی ایجاد می کند. مقدار پیش فرض 1.0.0 است.
- description: این ویژگی توضیحات بسته شما است. زمانی که بسته خود را منتشر کنید، عمومی خواهد شد.
- نقطه ورود: این ویژگی نشان دهنده نام فایلی است که اجرای کد شما از آنجا شروع می شود.
- دستور test: این ویژگی فرمانی را نشان می دهد که هنگام اجرای npm run test اجرا می شود.
- git repository: این ویژگی URL مخزن Git راه دور شما است.
- کلمات کلیدی: این ویژگی کلمات کلیدی مرتبط با پروژه شما را نشان می دهد که به موتور جستجو در یافتن آن کمک می کند.
- نویسنده: این ویژگی باید نام یا نام مستعار شما باشد.
- License: این مجوزی است که می خواهید بسته را تحت آن منتشر کنید. مجوز پیش فرض مجوز کنسرسیوم سیستم های اینترنت (ISC) است.
پس از تنظیم، می توانید بسته خود را ایجاد کنید.
مرحله 5: آزمایش بسته خود
پس از اتمام ایجاد بسته خود، باید آن را به صورت محلی آزمایش کنید تا ببینید پس از استقرار آن در npm چگونه رفتار می کند.
برای آزمایش بسته خود به صورت محلی، ابتدا دستور زیر را در دایرکتوری پروژه خود اجرا کنید:
npm link
دستور بالا به شما این امکان را می دهد که به بسته خود به صورت محلی مانند یک بسته میزبان npm ارجاع دهید.
سپس، یک پوشه دیگر در دایرکتوری ریشه پروژه خود ایجاد کنید و داخل آن سی دی بزنید.
mkdir test
cd test
در پوشه تست، دستور زیر را اجرا کنید تا بسته خود را به پوشه پیوند دهید:
npm link name-of-your-package
در نهایت، یک فایل ساختگی برای آزمایش عملکرد بسته خود ایجاد کنید.
پس از اتمام تست های خود، می توانید با خیال راحت پوشه آزمون خود را حذف کنید.
مرحله 6: ورود به سیستم npm در سیستم شما
در مرحله بعد، باید وارد حساب npm خود در سیستم خود شوید.
برای ورود به حساب npm خود دستور زیر را اجرا کنید:
npm login
این از شما می خواهد که نام کاربری، رمز عبور و یک کد احراز هویت دو مرحله ای (اگر آن را در حساب خود فعال کرده باشید) وارد کنید.
مرحله 7: انتشار بسته خود
پس از انجام تمام مراحل بالا، دستور زیر را اجرا کنید تا بسته خود را در npm منتشر کنید.
npm publish
این دستور به یک رمز عبور یکبار مصرف نیاز دارد که به ایمیل شما ارسال می شود. سپس، بسته شما را در npm منتشر می کند.
می توانید بسته هایی را که در npm منتشر کرده اید مشاهده کنید. به حساب npm خود در npmjs.com وارد شوید و به بخش بسته ها در داشبورد نمایه خود بروید.
برای نصب بسته خود و استفاده از آن به عنوان وابستگی به هر یک از پروژه های خود، اجرا کنید:
npm install name-of-your-package
حذف بسته خود از npm
شما همچنان روی بسته های خود در npm کنترل کامل دارید، به این معنی که می توانید بسته خود را برای همیشه از npm تغییر دهید و حتی آن را حذف کنید. با رفتن به قسمت تنظیمات بسته خود و انتخاب گزینه حذف بسته می توانید بسته های خود را حذف کنید.