phpstan.el

phpstan.el

emacs واجهة إلى phpstan ، تشمل المدقق ل flycheck.

نسخة الدعم

• emacs 25+
• Phpstan أحدث/dev-master (لا تدعم 0.9 سلسلة)
• PHP 7.1+ أو وقت تشغيل Docker

كيفية التثبيت

تثبيت من Melpa

1. إذا لم تكن قد قمت بإعداد MELPA ، فراجع البدء - MELPA.
2. Mx package-install flycheck-phpstan

كيفية استخدام

لمستخدم flycheck

( defun my-php-mode-setup ()
  " My PHP-mode hook. "
  ( require 'flycheck-phpstan )
  (flycheck-mode t ))

( add-hook 'php-mode-hook 'my-php-mode-setup )

لمستخدم flymake

( add-hook 'php-mode-hook # 'flymake-phpstan-turn-on )

باستخدام Docker (Phpstan/Docker-Image)

تثبيت صورة Docker و Phpstan/Phpstan.

إذا كنت تستخدم دائمًا Docker لـ phpstan ، فأضف ما يلي إلى ملف .emacs الخاص بك (~~/.emacs.d/init.el ~)

( setq-default phpstan-executable 'docker )

ضع ما يلي في ملفات .dir-locals.el على دليل الجذر للمشروع.

(( nil . ((php-project-root . git)
         (phpstan-executable . docker)
         (phpstan-working-dir . (root . " path/to/dir " ))
         (phpstan-config-file . (root . " path/to/dir/phpstan-docker.neon " ))
	 (phpstan-memory-limit . " 1G " )
         (phpstan-level . 7 ))))

باستخدام الملحن (مشروع محدد)

إذا كان مؤلف المشروع الخاص بك يعتمد على Phpstan ، فلن تحتاج إلى تعيين أي شيء.

(( nil . ((php-project-root . git)
         (phpstan-executable . docker)
         (phpstan-working-dir . (root . " path/to/dir " ))
         (phpstan-config-file . (root . " path/to/dir/phpstan-docker.neon " ))
         (phpstan-level . 7 ))))

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

يرجى تثبيت حزمة phpstan/phpstan لكل بيئة مستخدم أو مشروع باستخدام الملحن.

إذا لم تكن على دراية بحل التبعيات ، يوصى بأوامر shell التالية.

$ composer global require phpstan/phpstan

إشعار : تم إهمال phpstan/phpstan-shim. يرجى قراءة phpstan 0.12 صدر!.

باستخدام أرشيف PHAR

إشعار : يتطلب phpstan.el phpstan ** 0.10+**. نوصي بشدة باستخدام أحدث phpstan.

يرجى تنزيل phpstan.phar من الإصدارات · phpstan/phpstan.

إعدادات

يتم التحكم بشكل رئيسي في متغيرات phpstan بواسطة متغيرات الدليل ( .dir-locals.el ).

في كثير من الأحيان (root. "path/to/file") يظهر في هذه المتغيرات. إنه نسبة إلى الدليل الأعلى للمشروع. بشكل عام ، يكون الدليل الذي يحتوي على واحد من ملف .projectile ، composer.json ، .git (أو الدليل) في المستوى الأعلى.

يرجى العلم أن الدليل الجذر لمشروع PHP قد لا يتطابق مع أي من Phpstan %rootDir% و/أو %currentWorkingDirectory% .

عادة ، يمكنك تعيين ما يلي .dir-locals.el .

(( nil . ((php-project-root . auto)
         (phpstan-executable . docker)
         (phpstan-working-dir . (root . " path/to/dir/ " ))
         (phpstan-config-file . (root . " path/to/dir/phpstan-custom.neon " ))
         (phpstan-level . max ))))

إذا كان هناك ملف phpstan.neon في الدليل الجذر للمشروع ، فلن تحتاج إلى تعيين كل من phpstan-working-dir و phpstan-config-file .

الأوامر

توفر هذه الحزمة أوامر مريحة لاستخدام phpstan من EMACs.

القيادة phpstan-insert-dumptype

إضافة PHPStandumpType(...); إلى رمز PHP الخاص بك وتحليله لجعل phpstan يعرض نوع التعبير.

 (define-key-mode-map (kbd "cc ^") #'phpstan-insert-dumptype)

بشكل افتراضي ، إذا قمت بالضغط على Cu قبل استدعاء الأمر ، فسيتم إدراج PHPStandumpPhpDocType() .

تمت إضافة هذه الميزة في phpstan 1.12.7 وسوف تفريغ أنواع متوافقة مع علامات phpdoc @param و @return .

القيادة phpstan-insert-ignore

أدخل علامة @phpstan-ignore لقمع أي أخطاء phpstan على السطر الحالي.

بشكل افتراضي ، يقوم بإدراج العلامة في السطر السابق ، ولكن إذا كان هناك بالفعل علامة في نهاية السطر الحالي أو على السطر السابق ، فسيتم إلحاق المعرفات هناك.

إذا لم يكن هناك علامة موجودة وتم الضغط على Cu قبل الأمر ، فسيتم إدراجها في نهاية السطر.

API

معظم المتغيرات المحددة في هذه الحزمة هي العازلة المحلية. إذا كنت ترغب في تعيينها لمشاريع متعددة ، فاستخدم SetQ-Default.

المتغير المحلي phpstan-working-dir

دليل العمل في Phpstan.

خيط

المسار المطلق إلى دليل العمل "phpstan".

• على سبيل المثال) "/path/to/phpstan.phar"

(root . STRING)

المسار النسبي إلى دليل العمل "Phpstan" من دليل الجذر للمشروع.

• على سبيل المثال) (root . "path/to/dir")

nil

استخدم (php-project-get-root-dir) كدليل عمل.

متغير محلي phpstan-config-file

مسار لمشروع ملف تكوين محدد من phpstan.

خيط

المسار المطلق إلى ملف تكوين phpstan .

(root . STRING)

المسار النسبي إلى ملف تكوين phpstan من دليل جذر المشروع.

لا شيء

البحث phpstan.neon(.dist) في (phpstan-get-working-dir) .

متغير محلي phpstan-level

مستوى القاعدة من تحليل phpstan. يرجى الاطلاع على مستويات readme #Rule من phpstan. 0 هو أهم ويمكنك أيضًا استخدام max ككمال مستعار لأعلى مستوى. المستوى الافتراضي هو 0 .

المتغير المحلي phpstan-executable

خيط

المسار المطلق إلى ملف "phpstan" قابل للتنفيذ.

• على سبيل المثال) "/path/to/phpstan.phar"

docker

استخدم Docker باستخدام Phpstan/Docker-Disage.

(root . STRING)

المسار النسبي إلى ملف "phpstan" القابل للتنفيذ من دليل جذر المشروع.

• السابقين) (root . "script/phpstan")

(STRING . (ARGUMENTS ...))

اسم الأمر والوسائط.

• على سبيل المثال) ("docker" "run" "--rm" "-v" "/path/to/project-dir/:/app" "your/docker-image")

nil

Auto اكتشاف ملف phpstan القابل للتنفيذ بواسطة تبعيات الملحن للمشروع أو الأمر القابل للتنفيذ في متغير بيئة PATH .

متغير مخصص phpstan-flycheck-auto-set-executable

قم بتعيين flycheck phpstan-executable تلقائيًا عند عدم nil.

متغير مخصص phpstan-memory-limit

استخدم خيار حد ذاكرة Phpstan عندما يكون غير مكيف.

خيط

يحدد حد الذاكرة بنفس التنسيق الذي يقبله php.ini.

• على سبيل المثال) "1G"

nil

استخدم حد الذاكرة في php.ini

متغير مخصص phpstan-docker-image

Docker Image URL أو Docker Hub اسم صورة أو NIL. الافتراضي باسم "ghcr.io/phpstan/phpstan" . انظر Docker - وثائق Phpstan و Github Container Registory - Package Phpstan.