ما هو package.json؟

ملف package.json هو قلب أي مشروع Node.js، حيث يعمل كملف بيان يحدد بيانات المشروع والمتعلقات والنصوص والإعدادات. يخبر ملف JSON هذا npm (مدير حزم Node) والأدوات الأخرى كيفية التعامل مع المشروع وما هي الحزم التي يجب تثبيتها وكيفية تشغيل المهام المختلفة. وهو مطلوب لنشر الحزم على npm وهو أول ملف يفحصه المطورون عند استكشاف مشروع Node.js.

بالإضافة إلى إدراج المتعلقات، يتحكم package.json في الإصدار الدلالي ويحدد نقاط الدخول ويحدد إصدارات Node المتوافقة ويمكن أن يتضمن نصوصًا مخصصة للبناء والاختبار ونشر التطبيقات. يعتبر ملف package.json صحيح ومنظم جيدًا ضروريًا لسهولة صيانة المشروع والتعاون.

وصف الأداة

تتحقق هذه الأداة عبر الإنترنت من ملف package.json الخاص بك من حيث الصحة والامتثال لمواصفات npm وأفضل الممارسات. الصق محتوى package.json الخاص بك للحصول على ملاحظات فورية حول الأخطاء والتحذيرات والتوصيات للتحسين.

أمثلة

بناء جملة JSON غير صحيح:

{
  "name": "my-package",
  "version": "1.0.0" // التعليقات غير مسموحة
}

خطأ: JSON لا يدعم التعليقات؛ يؤدي إلى خطأ في التحليل.

حقول مطلوبة مفقودة:

{
  "description": "حزمة بدون اسم أو إصدار"
}

خطأ: حقول مطلوبة مفقودة "name" و "version".

تنسيق إصدار غير صحيح:

{
  "name": "my-package",
  "version": "1.0"
}

تحذير: يجب أن يتبع الإصدار الإصدار الدلالي (على سبيل المثال، "1.0.0").

الميزات

  • التحقق في الوقت الفعلي من بناء جملة وهيكل package.json
  • تحديد الأخطاء الحرجة التي تمنع npm من العمل
  • تحذيرات للحقول المهملة أو الممارسات غير القياسية
  • توصيات لتحسين جودة package.json
  • دعم تكوينات الحزم العامة والخاصة

حالات الاستخدام

التحقق قبل النشر: تحقق من أن ملف package.json الخاص بك خالي من الأخطاء قبل النشر على npm لتجنب الرفض أو مشاكل التثبيت.

تدقيق المتعلقات: تحقق من ملفات package.json من مشاريع أخرى لفهم هيكلها وتحديد مشاكل الإعدادات المحتملة.

التعلم وتصحيح الأخطاء: استكشف أخطاء تثبيت npm بالتحقق من هيكل package.json عندما تكون رسائل الخطأ غير واضحة.