githooks

1. wtyd/githooks

هي العديد من الأدوات الأخرى والمكونات الإضافية الملحمية لإدارة السنانير GIT. لكن Githooks تقدم:

• تطبيق مستقل. Githooks هو ثنائي (. phar) بحيث لا تتداخل تبعياتها مع تبعيات طلبك.
• تدار مع الملحن. لا تحتاج إلى أدوات أخرى مثل Phive أو غيرها.
• يتكوين جميع أدوات ضمان الجودة (جميع الأدوات المدعومة على الأقل).
• يقوم بتخصيص المطورين بعيدًا عن كيفية تنفيذ أدوات ضمان الجودة باستخدام أمر githooks tool name-of-the-tool .
• يمكنك أيضًا إنشاء البرامج النصية الخاصة بك وتكوين أي خطاف GIT.

علاوة على ذلك ، يمكن استخدامه مع أدوات التحقق من صحة JavaScript مثل Typicode/Husky إذا كان لديك مشاريع هجينة.

2. المتطلبات

• PHP> = 7.1
• الأدوات التي تحتاجها للتحقق من الرمز.
• أو تملك البرامج النصية لخطافات.

3. تثبيت

1. يجب تثبيت githooks مثل متطلبات DIV مع الملحن:

composer require --dev wtyd/githooks

ملاحظة: بالنسبة لـ PHP <8.1 ، يجب عليك إضافة حدث post-update-cmd التالي إلى قسم scripts في composer.json :

 "scripts" : {
    "post-update-cmd" : [
      " Wtyd \ GitHooks \ Utils \ ComposerUpdater::phpOldVersions "
    ]
}

ثم قم بتشغيل composer update wtyd/githooks .

حتى الإصدار 2.3.0 ، كانت الطريقة المستخدمة هي php72orminorupdate ولكن تم إهمالها وسيتم إزالتها من الإصدار 3.0.0

من المريح أيضًا إضافته إلى حدث post-install-cm حتى لا يواجه مطورو المشروع مشاكل في الإنشاء

 "scripts" : {
    "post-update-cmd" : " Wtyd \ GitHooks \ Utils \ ComposerUpdater::phpOldVersions " ,
    "post-install-cmd" : " Wtyd \ GitHooks \ Utils \ ComposerUpdater::phpOldVersions "
}

2. تثبيت جميع الأدوات المدعومة المطلوبة. كيف تقوم بتثبيت الأدوات لا يهم.

3. تهيئة githooks مع githooks conf:init . يقوم هذا الأمر بإنشاء ملف التكوين في مسار الجذر ( githooks.yml ).

4. تشغيل githooks hook . يقوم بنسخ البرنامج النصي لإطلاق githooks على حدث ما قبل الالتزام في دليل .git/hooks . يمكنك أيضًا تشغيل githooks hook otherHook MyScriptFile.php لتعيين أي خطاف مع برنامج نصي مخصص. انظر الويكي لمزيد من المعلومات.

للتأكد من تكوينه تلقائيًا ، يمكننا تكوين الأمر في أحداث post-update-cmd وأحداث post-install-cmd في ملف composer.json (قسم scripts ):

 "scripts" : {
    "post-update-cmd" : [
    " vendor/bin/githooks hook " // or "vendor/bin/githooks hook pre-commit MyScriptFile.php"
    ],
    "post-install-cmd" : [
    " vendor/bin/githooks hook "
    ]
}

5. اضبط ملف التكوين.

4. الاستخدام

عند الالتزام ، يتم تشغيل جميع أدوات فحص التعليمات البرمجية المكوّنة تلقائيًا. إذا اجتاز الكود الخاص بك جميع الشيكات ، فإن Githooks يتيح لك الالتزام. إذا لم يكن الأمر كذلك ، يجب عليك إصلاح الرمز والمحاولة مرة أخرى:

يمكنك أيضًا تشغيل githooks وقتما تشاء. جميع الأدوات في نفس الوقت أو واحد تلو الآخر:

githooks tool all # Run all tools
githooks tool phpcs # Run only phpcs

5. الأدوات المدعومة

في هذه اللحظة ، الأدوات المدعومة هي:

• PHP CODESNIFFER (PHPCS و PHPCBF)
• PHP Copy Paste Detector
• PHP Mess Detector
• متوازي
• PHP ستان
• مدقق أمان PHP المحلي

ولكن يمكنك تعيين البرنامج النصي الخاص بك على أي خطاف git.

6. اضبط ملف التكوين

يتم تقسيم ملف githooks.yml على ثلاثة أجزاء:

6.1. خيارات

6.1.1. تنفيذ

يمثل علامة execution كيفية تشغيل githooks:

• full (الخيار الافتراضي): ينفذ دائمًا جميع الأدوات التي يتم تعيينها مقابل كل المسار الذي تم تعيينه لكل أداة. على سبيل المثال ، قمت بتخصيص PHPCs للتشغيل في أدلة src و app . يحتوي الالتزام فقط على ملفات معدلة من دليل database . ستتحقق PHPCS من أدلة src و app حتى لو لم يتم تعديل أي ملفات في هذه الدلائل.
• fast : يقوم هذا الخيار بتشغيل الأدوات فقط مقابل الملفات المعدلة عن طريق الالتزام.
  • يؤثر هذا الخيار فقط على الأدوات التالية: PHPCs و PHPMD و Phpstan و Parallel-Lint. سيتم تشغيل بقية الأدوات كخيار كامل.
  • تحذير!!! يجب عليك تعيين استبعاد الأدوات إما في githooks.yml أو في ملف التكوين الخاص بـ eath tool لأن هذا الخيار يكتب paths الرئيسية للأدوات بحيث يتم تنفيذها فقط مقابل الملفات المعدلة.

6.1.2. العمليات

قم بتشغيل أدوات متعددة في عمليات متعددة في نفس الوقت ( tool all Command). العدد الافتراضي للعمليات هو 1.

6.2. أدوات

إنها صفيف يحمل اسم الأدوات التي سيتم تشغيل Githooks. اسم الأدوات قابلة للتنفيذ. إذا كنت تريد تنفيذ جميع الأدوات ، فسيكون مفتاح Tools كما يلي:

 Tools :
    - phpstan
    - security-checker
    - parallel-lint
    - phpcs
    - phpcbf
    - phpmd
    - phpcpd

الترتيب الذي تكون فيه الأدوات هو الترتيب الذي سيتم فيه تنفيذها.

6.3. تحديد الأدوات

في الخطوة التالية ، يجب عليك تكوين الأدوات بنفس الاسم كما في مفتاح الأدوات . على سبيل المثال ، لمجموعة phpcs:

 phpcs :
    executablePath : vendor/bin/phpcs
    paths : [src, tests]
    ignore : [vendor]
    standard : ' PSR12 '

جميع الخيارات المتاحة موجودة في الويكي.

7. المساهمة

المساهمات من الآخرين ستكون موضع تقدير كبير! إرسال طلب السحب/المشكلة. تحقق من جميع خطوات القيام بذلك في قسم الويكي للمساهمة. شكرًا!

8. ترخيص

ترخيص معهد ماساتشوستس للتكنولوجيا (MIT). يرجى الاطلاع على ملف الترخيص لمزيد من المعلومات.