انشاء حزمة ( Package / Module ) ورفعها على مدير الحزم NPM

بسم الله الرحمن الرحيم

السلام عليكم ورحمة الله وبركاته

هل فكرت في بناء حزمة لإطار Node.JS ورفعها على NPM ؟

في هذا الشرح سوف اشرح طريقة التسجيل في موقع مدير حزم Node.JS (  npmjs.com) وانشاء حزمة ورفعها عليه

 

التسجيل في موقع مدير حزم   NPM (Node Package Manager)

لتقوم برفع حزمة الى مدير الحزم Npm سوف تحتاج الى التسجيل في موقع مدير حزم Node.js

للتسجيل يجب عليك الولوج الى الرابط التالي
https://www.npmjs.com/signup

 

وتعبئة البيانات بالشكل التالي

بعد تعبئة البيانات قم بالضغط على "Create An Account" ( انشاء حساب ) سوف يأتيك اشعار في الموقع يطلب منك تأكيد البريد الإلكتروني على الشكل التالي 

اذهب للبريد الأكتروني الذي قمت بالتسجيل به وسوف تجد رسال تحمل العنوان "Verify your npm email address‏"

افتح الرسالة واضغط على رابط تأكيد البريد الأكتروني كما موضح في الصورة التالية

سوف يعيد توجيهك الى موقع NPM 

انشاء الحزمة

اولًا قم بإنشاء مجلد ليحتوي المشروع وليكون اسم المجلد بنفس اسم المشروع (للمثال سوف يكون 3alampro-publish-npm-example) ثم قم بالدخول على الملجد عن طريق الطرفية

mkdir 3alampro-publish-npm-example
cd 3alampro-publish-npm-example

ثم قم بانشاء ملف package.json بكتابة الأمر التالي في الطرفية

npm init

وتعبئته بالشكل التالي

package name اسم الحزمة
version إصدار التطبيق
main الملف الرئيسي ( الذي سوف يعمل عن كتابة الأمر npm start )
author اسم مطور الحزمة
license الترخيص ( انصح ان يكون MIT )
description وصف الحزمة
scripts يحتوي عناصر من عدة اوامر يتم تنفيذها من الطرفيه بكتابة npm run <اسم العنصر>
( مثل npm run test ) 

 

الان قم بانشاء ملف ( الملف الرئيسي main file ) index.js ويستخرج ( exports ) دالة تحمل الأسم sayHello 

exports.sayHello = function sayHello(name){
        console.log('Hello ' + name);
}

 

رفع الحزمة الى NPM

من الطرفية قم بتسجيل الدخول في NPM بالأمر التالي

npm login

سوف يطبع في الطرفية ثلاث حقول ادخال اول حقل لإدخال لأسم المستخدم والحقل الثاني لإدخال كلمة السر والحقل الثلاث لإدخال البريد العام ( سوف يظهر للعامة )

بعد تسجيل الدخول في الطرفية قم بنشر الحزمة بكتابة الأمر التالي في مجلد المشروع لرفعه الى npm

npm publish

 

كيف اقوم بتحديث الحزمة التي رفعتها؟

قد تحتاج الى تحديث الحزمة لاصلاح عله او اضافة خاصية الخ..

لتحديث الحزمة في npm الأمر سهل كل ماعليك فعله هو تعديل رقم الإصدار ( version ) في ملف package.json الى إصدار احد من اخر اصدار رفعته على مدير الحزم

{
  "name": "3alampro-publish-npm-example",
  "version": "1.0.1", <-- قم بتحديث الأصدار بزيادته
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "salem1",
  "license": "ISC"
}

ثم كتابة نشر (publish) لرفع الحزمة الى NPM  (** يجب ان تكون مسجل دخولك عن طريق الطرفية) 

npm publish

 

كيف اقوم بإستخدام الحزمة التي قمت ببنائها في احد مشاريعي؟

لإستخدام اي حزمة من NPM يجب عليك اضافتها لمجلد Node_Modules بكتابة امر تثبيت الحزمة في مجلد المشروع 

npm install <اسم الحزمة>

 

تثبيت الحزمة التي قمت ببنائها في المقال

قم بالدخول لمجلد مشروع في الطرفية ثم اكتب الأمر التالي 

npm install 3alampro-publish-npm-example

ثم في ملف الرئيسي للمشروع الخاص بك قم بإستدعاء الدالة sayHello من الحزمة التي قمت ببنائها

const { sayHello } = require("3alampro-publish-npm-example");

sayHello("عالم البرمجة");

 

node app.js

الناتج

 

كلمات دليلية: module node.js npm حزمة رفع