عن المشروع

تساعد Commitizen الفرق على فرض وتوصيل اصطلاحات رسائل الالتزام أثناء إنشاء الالتزام. بدلاً من انتظار خطاف لرفض رسالة غير صالحة، يجيب المساهمون على المطالبات للحقول المطلوبة، ويقوم المحول المختار بإنشاء رسالة الالتزام المنسقة. يتم توزيع الأداة من خلال npm ويمكن تثبيتها عالميًا باستخدام npm install -g commitizen، أو تشغيلها مباشرة باستخدام npx cz، أو تثبيتها كاعتماد تطوير للمشروع بحيث يستخدم كل مساهم نفس الإصدار. في مستودع مهيأ، يمكن للمستخدمين تشغيل git cz أو cz أو git-cz بدلاً من git commit. يمكن أيضًا عرضها من خلال سكريبت npm. يتم جعل المستودع صديقًا لـ Commitizen عن طريق اختيار محول. يستخدم الإعداد الموثق commitizen init cz-conventional-changelog مع npm أو Yarn أو pnpm، والذي يقوم بتثبيت المحول وحفظه في package.json وإضافة إعداد config.commitizen.path. يمكن وضع التكوين بدلاً من ذلك في ملف .czrc. يمكن أن يحل مسار المحول حزم npm أو ملفات JavaScript المحلية أو الدلائل التي تحتوي على index.js أو مسارات نسبية أو مسارات مطلقة. يعتمد Commitizen على المحولات، لذا يمكن للمشاريع استخدام خيارات منشورة مثل cz-conventional-changelog أو cz-customizable أو cz-emoji أو cz-commitlint أو cz-git أو محولات موجهة لـ Jira أو بناء محول خاص بها. تتلقى المحولات المخصصة مثيل Inquirer.js وتعيد سلسلة الالتزام النهائية من خلال رد اتصال الالتزام. للمشرفين الذين يرغبون في ظهور المطالبات أثناء git commit عادي، يمكن استدعاء Commitizen من خطاف Git prepare-commit-msg باستخدام الخيار --hook. يقدم ملف README أمثلة لكل من خطافات Git التقليدية وHusky، بما في ذلك إعادة توجيه الإدخال من /dev/tty بحيث يمكن أن يكون الخطاف تفاعليًا. تهدف Commitizen إلى العمل جنبًا إلى جنب مع خطافات الالتزام والأدوات ذات الصلة بدلاً من استبدالها. تشمل القدرات الأخرى التكوين العالمي من خلال ~/.czrc للاستخدام عبر المستودعات، ودعم خيارات git commit القياسية مثل git cz -a، ونمط متعدد المستودعات حيث يمكن للفريق نشر واجهة CLI Node.js مخصصة صغيرة تقوم بتشغيل Commitizen مع محول ثابت. يمكن لأمر git cz --retry إعادة استخدام محاولة الالتزام السابقة بعد فشل خطاف أو تشغيل اختبار، مع ربط بيانات إعادة المحاولة بمسار المستودع وربما مسحها عن طريق الترقيات أو حذف ملف ذاكرة التخزين المؤقت. يسرد ملف README إصدارات Node.js المختبرة 12 و14 و16 ويتطلب npm 6 أو أحدث، مع الإشارة إلى أنه قد يعمل على إصدارات Node.js الأقدم. تشمل المشاريع ذات الصلة المذكورة conventional-changelog لإنشاء سجلات التغييرات وcommitlint لفحص رسائل الالتزام.