راهنمای جامع انتشار پکیج JavaScript در NPM

انتشار پکیج در NPM (Node Package Manager) یکی از بهترین روش‌ها برای اشتراک‌گذاری کدهای کاربردی با جامعه توسعه‌دهندگان است. در این مقاله، به شما نشان خواهیم داد چگونه می‌توانید یک پکیج جاوااسکریپت را ایجاد کرده و آن را در NPM منتشر کنید.

پیش‌نیازها

  • نصب Node.js و NPM روی سیستم شما.
  • یک حساب کاربری فعال در NPM.

مراحل انتشار پکیج

1. ایجاد پروژه

ابتدا یک پوشه جدید برای پروژه خود ایجاد کنید و وارد آن شوید:

mkdir my-package
cd my-package

سپس فایل package.json را با استفاده از دستور زیر ایجاد کنید:

npm init

اطلاعات خواسته‌شده را وارد کنید، مانند نام پکیج، نسخه، توضیحات و غیره.

2. نوشتن کد اصلی

کد اصلی پکیج خود را در فایل مناسب قرار دهید. مثلاً:

// index.js
function greet(name) {
  return `Hello, ${name}!`;
}
module.exports = greet;

3. اضافه کردن README.md

یک فایل README.md اضافه کنید تا توضیحاتی درباره نحوه استفاده از پکیج ارائه دهید:

# My Package

A simple package to greet users.

## Installation
```bash
npm install my-package
```
## Usage
```javascript
const greet = require('my-package');
console.log(greet('World')); // Hello, World!
```

4. ورود به حساب کاربری NPM

برای ورود به حساب کاربری خود از دستور زیر استفاده کنید:

npm login

اطلاعات حساب کاربری شامل نام کاربری، رمز عبور و ایمیل را وارد کنید.

5. انتشار پکیج

پس از آماده شدن کد و اطلاعات مربوطه، می‌توانید با دستور زیر پکیج خود را منتشر کنید:

npm publish

نکات مهم برای موفقیت در انتشار پکیج

  • نام پکیج باید منحصربه‌فرد باشد.
  • نسخه‌بندی دقیق (Semantic Versioning) انجام دهید.
  • Add keywords مناسب برای جستجوی بهتر.

مدیریت نسخه‌های آینده

اگر بسته‌ی خود را به‌روزرسانی می‌کنید، شماره نسخه را در فایل package.json افزایش دهید، سپس دستور npm publish را اجرا کنید. برای تغییرات عمده، به‌طور دقیق از قوانین نسخه‌بندی معنایی (Semantic Versioning) پیروی کنید.