تعمل أداة PHP Coding Standards Fixer (PHP CS Fixer) على إصلاح التعليمات البرمجية الخاصة بك لاتباع المعايير؛ سواء كنت تريد اتباع معايير ترميز PHP كما هو محدد في PSR-1، أو PSR-2، وما إلى ذلك، أو المعايير الأخرى التي يحركها المجتمع مثل Symfony. يمكنك أيضًا تحديد نمط (فريقك) الخاص بك من خلال التكوين.
يمكنه تحديث التعليمات البرمجية الخاصة بك (مثل تحويل وظيفة pow
إلى عامل التشغيل **
في PHP 5.6) وتحسينها (الصغير).
إذا كنت تستخدم بالفعل linter لتحديد مشكلات معايير الترميز في التعليمات البرمجية الخاصة بك، فأنت تعلم أن إصلاحها يدويًا أمر شاق، خاصة في المشاريع الكبيرة. هذه الأداة لا تكتشفها فحسب، بل تقوم أيضًا بإصلاحها لك.
ملاحظة: يتطلب كل إصدار PHP جديد جهدًا كبيرًا لدعم البنية الجديدة. ولهذا السبب قد لا يكون الإصدار الأخير من PHP مدعومًا حتى الآن. إذا كنت في حاجة إليها، من فضلك فكر في دعم المشروع بأي طريقة مناسبة، على سبيل المثال من خلال المساهمة بالكود أو مراجعة العلاقات العامة الحالية. لتشغيل PHP CS Fixer على إصدارات غير مدعومة حتى الآن "على مسؤوليتك الخاصة" - استخدم PHP_CS_FIXER_IGNORE_ENV.
الطريقة الموصى بها لتثبيت PHP CS Fixer هي استخدام Composer في ملف composer.json
المخصص في مشروعك، على سبيل المثال في دليل tools/php-cs-fixer
:
mkdir -p tools/php-cs-fixer
composer require --working-dir=tools/php-cs-fixer friendsofphp/php-cs-fixer
أو باستخدام composer.json
الرئيسي :
composer require --dev friendsofphp/php-cs-fixer
لمزيد من التفاصيل وطرق التثبيت الأخرى، راجع تعليمات التثبيت.
يمكنك استخدام صور Docker المضمنة مسبقًا لتشغيل php-cs-fixer
.
docker run -it --rm -v $(pwd):/code ghcr.io/php-cs-fixer/php-cs-fixer:${FIXER_VERSION:-3-php8.3} fix src
$FIXER_VERSION
المستخدم في المثال أعلاه هو معرف الإصدار الذي تريد استخدامه، والذي يعتمد على إصدارات Fixer وPHP مجتمعة. هناك علامات مختلفة لكل مستوى SemVer الخاص بـ Fixer وإصدار PHP مع بناء الجملة <php-cs-fixer-version>-php<php-version>
. على سبيل المثال:
3.57.0-php7.4
3.57-php8.0
3-php8.3
بافتراض أنك قمت بتثبيت PHP CS Fixer كما هو موضح أعلاه، يمكنك تشغيل الأمر التالي لإصلاح ملفات PHP في دليل src
:
tools/php-cs-fixer/vendor/bin/php-cs-fixer fix src
راجع الاستخدام وقائمة القواعد المضمنة وقائمة مجموعات القواعد ووثائق ملف التكوين لمزيد من التفاصيل.
إذا كنت بحاجة إلى تطبيق أنماط التعليمات البرمجية التي لا تدعمها الأداة، فيمكنك إنشاء قواعد مخصصة.
توجد مكونات إضافية مخصصة لـ:
تتم صيانة PHP CS Fixer على GitHub على https://github.com/PHP-CS-Fixer/PHP-CS-Fixer. نرحب بتقارير الأخطاء والأفكار حول الميزات الجديدة هناك.
يمكنك التواصل معنا في مناقشات GitHub بخصوص المشروع والتكوين والتحسينات الممكنة والأفكار والأسئلة. يرجى زيارتنا هناك!
تأتي الأداة مع عدد لا بأس به من أدوات التثبيت المضمنة، ولكن الجميع مرحب بهم للمساهمة بالمزيد منها.