ایجاد یک بسته NPM – انجمن DEV

می توانید یک فایل اضافه کنید package.json به بسته شما تا مدیریت و نصب آن برای دیگران آسان تر شود. بسته های منتشر شده در رجیستری باید حاوی یک فایل باشند package.json.

یک فایل package.json:

• بسته هایی را لیست می کند که پروژه شما به آنها بستگی دارد
• نسخه هایی از یک بسته را مشخص می کند که پروژه شما می تواند با استفاده از قوانین نسخه سازی معنایی از آنها استفاده کند
• ساخت شما را قابل پخش می کند و بنابراین اشتراک گذاری آن با دیگر توسعه دهندگان را آسان تر می کند

مشاهده
برای سهولت یافتن بسته در وب سایت npm، توصیه می کنیم a descrição سفارشی در فایل package.json.

کامپوس package.json

زمینه ها name ه version اجباری هستند

یک فایل package.json باید شامل فیلدها باشد "name" ه "version".

میدان "name" حاوی نام بسته شما است و باید با حروف کوچک و یک کلمه باشد و می تواند حاوی خط فاصله و زیرخط باشد.

میدان "version" باید در قالب باشد x.x.x و دستورالعمل‌های نسخه‌سازی معنایی را دنبال کنید.

نویسنده کامپو

اگر می خواهید اطلاعات نویسنده بسته را در آن قرار دهید "author"، از فرمت زیر استفاده کنید (ایمیل و وب سایت اختیاری هستند):

نام شما email@example.com (http://example.com)

مثال

{
  "name": "meu-maravilhoso-pacote",
  "version": "1.0.0",
  "author": "Guilherme Siquinelli <email@guiseek.dev>"
}

ایجاد یک فایل جدید package.json

می توانید یک فایل ایجاد کنید package.json اجرای یک نظرسنجی CLI یا ایجاد یک فایل package.json استاندارد

اجرای مسابقه CLI

برای ایجاد یک فایل package.json با مقادیری که ارائه می کنید، از دستور استفاده کنید npm init.

1. در ترمینال، به دایرکتوری ریشه بسته خود بروید.

cd /caminho/para/pacote

1. دستور زیر را اجرا کنید:

npm init

1. به سوالات مسابقه از خط فرمان پاسخ دهید.

سفارشی کردن پرسشنامه package.json

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

1. در دایرکتوری خانه (home)، فایلی به نام ایجاد کنید .npm-init.js.
2. برای افزودن سؤالات سفارشی، با استفاده از ویرایشگر متن، سؤالات را با تابع اضافه کنید prompt:

module.exports = prompt("qual é o seu sabor de sorvete preferido, amigo?", "Gosto de todos");

1. برای افزودن فیلدهای سفارشی، با استفاده از ویرایشگر متن، فیلدهای مورد نظر را به فایل اضافه کنید .npm-init.js:

module.exports = {
    customField: 'Example custom field',
    otherCustomField: 'This example field is really cool'
}

برای کسب اطلاعات بیشتر در مورد ایجاد سفارشی سازی npm init پیشرفته، مخزن init-package-json GitHub را ببینید.

ایجاد یک فایل package.json استاندارد

برای ایجاد یک package.json الگو با استفاده از اطلاعات استخراج شده از دایرکتوری فعلی، از دستور استفاده کنید npm init با علامت --yes یا -y. برای فهرستی از مقادیر پیش‌فرض، «مقادیر پیش‌فرض استخراج‌شده از فهرست فعلی» را ببینید.

1. در خط فرمان، به دایرکتوری ریشه بسته خود بروید.

cd /caminho/para/pacote

1. دستور زیر را اجرا کنید:

npm init --yes

{
  "name": "seu-maravilhoso-pacote",
  "description": "",
  "version": "1.0.0",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "repository": {
    "type": "git",
    "url": "https://github.com/seu-usuario/seu-maravilhoso-pacote.git"
  },
  "keywords": [],
  "author": "",
  "license": "ISC",
  "bugs": {
    "url": "https://github.com/seu-usuario/seu-maravilhoso-pacote/issues"
  },
  "homepage": "https://github.com/seu-usuario/seu-maravilhoso-pacote"
}

مقادیر پیش فرض استخراج شده از فهرست فعلی

• name: نام دایرکتوری فعلی
• version: همیشه 1.0.0
• description: اطلاعات README یا یک رشته خالی ""
• scripts: به طور پیش فرض یک اسکریپت ایجاد می کند test خالی
• keywords: خالی
• author: خالی
• license: ISC
• bugs: اطلاعات فهرست فعلی، در صورت وجود
• homepage: اطلاعات فهرست فعلی، در صورت وجود

گزینه های پیکربندی را برای دستور init تنظیم کنید

می توانید گزینه های پیکربندی پیش فرض را برای دستور init تنظیم کنید. به عنوان مثال، برای تنظیم ایمیل پیش فرض نویسنده، نام نویسنده و مجوز، از خط فرمان دستورات زیر را اجرا کنید

npm set init-author-email "example-user@example.com"
npm set init-author-name "example_user"
npm set init-license "MIT"