phpstan.el

phpstan.el

L'interface EMACS à PHPSTAN, comprend un vérificateur pour le mouche.

Version de support

• Emacs 25+
• PHPSTAN DERNITE / DEV-MASTER (NON PRÉPRIBLE 0.9 Série)
• Php 7.1+ ou Docker Runtime

Comment installer

Installer depuis Melpa

1. Si vous n'avez pas configuré Melpa, voyez commencer - Melpa.
2. Mx package-install flycheck-phpstan

Comment utiliser

Pour l'utilisateur de mouche

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

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

Pour l'utilisateur de mouches

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

Utilisation de Docker (PhpStan / Docker-Image)

Installez l'image Docker et PHPSTAN / PHPSTAN.

Si vous utilisez toujours Docker pour phpstan, ajoutez ce qui suit dans votre fichier .emacs (~~ / .emacs.d / init.el ~)

( setq-default phpstan-executable 'docker )

Mettez ce qui suit dans des fichiers .dir-locals.el sur le répertoire racine du projet.

(( 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 ))))

Utilisation du compositeur (Spécifique au projet)

Si votre compositeur de projet s'appuie sur PHPSTAN, vous n'avez rien à définir.

(( 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 ))))

Utilisation du compositeur

Veuillez installer le package PHPSTAN / PHPSTAN pour chaque environnement ou projet utilisateur en utilisant Composer.

Si vous n'êtes pas familier avec la résolution des dépendances, les commandes de shell suivantes sont recommandées.

$ composer global require phpstan/phpstan

AVIS : PHPSTAN / PHPSTAN-SHIM est déprécié. Veuillez lire PHPSTAN 0.12 libéré!.

Utilisation d'archives phar

Remarque : phpstan.el nécessite phpstan ** 0,10 + **. Nous recommandons fortement d'utiliser le dernier phpstan.

Veuillez télécharger phpstan.phar à partir des versions · phpstan / phpstan.

Paramètres

Les variables pour PHPSTAN sont principalement contrôlées par des variables de répertoire ( .dir-locals.el ).

La notation fréquemment (root. "path/to/file") apparaît dans ces variables. Il est relatif au répertoire de niveau supérieur du projet. En général, le répertoire contenant l'un des .projectile , composer.json , .git File (ou répertoire) est au niveau supérieur.

Veuillez noter que le répertoire racine du projet PHP peut correspondre à l'un ou l'autre des %rootDir% de PhpStan et / ou %currentWorkingDirectory% .

En règle générale, vous définissez les .dir-locals.el suivants.

(( 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 ))))

S'il y a un fichier phpstan.neon dans le répertoire racine du projet, vous n'avez pas besoin de définir à la fois phpstan-working-dir et phpstan-config-file .

Commandes

Ce package fournit des commandes pratiques pour l'utilisation de phpstan à partir d'EMACS.

Commande phpstan-insert-dumptype

Add PHPStandumpType(...); À votre code PHP et analysez-le pour faire afficher le type d'expression.

 (Define-Key PHP-Mode-Map (KBD "CC ^") # 'PHPSTAN-INSERT-DUMPTYPE)

Par défaut, si vous appuyez sur Cu avant d'invoquer la commande, PHPStandumpPhpDocType() sera inséré.

Cette fonction a été ajoutée dans PHPSTAN 1.12.7 et videra les types compatibles avec les balises @param et @return phpDoc.

Commande phpstan-insert-ignore

Insérez une balise @phpstan-ignore pour supprimer toutes les erreurs phpstan sur la ligne actuelle.

Par défaut, il insère la balise sur la ligne précédente, mais s'il y a déjà une balise à la fin de la ligne actuelle ou sur la ligne précédente, les identifiants y seront ajoutés.

S'il n'y a pas de balise existante et que Cu est enfoncée avant la commande, il sera inséré à la fin de la ligne.

API

La plupart des variables définies dans ce package sont locales de tampon. Si vous souhaitez le définir pour plusieurs projets, utilisez SetQ-Default.

Variable locale phpstan-working-dir

Path to Working Directory of PHPSTAN.

CHAÎNE

Chemin absolu vers le répertoire de travail «PhpStan».

• ex) "/path/to/phpstan.phar"

(root . STRING)

Chemin relatif vers le répertoire de travail «PhpStan» à partir du répertoire racine du projet.

• ex) (root . "path/to/dir")

nil

Utiliser (php-project-get-root-dir) comme répertoire de travail.

Variable locale phpstan-config-file

Chemin vers le fichier de configuration spécifique du projet de PHPSTAN.

CHAÎNE

Chemin absolu vers le fichier de configuration phpstan .

(root . STRING)

Chemin relatif vers le fichier de configuration phpstan à partir du répertoire racine du projet.

NÉANT

Recherchez phpstan.neon(.dist) dans (phpstan-get-working-dir) .

phpstan-level variable local

Niveau de règle de l'analyse PHPSTAN. Veuillez consulter ReadMe #rule Les niveaux de phpstan. 0 est le plus lâche et vous pouvez également utiliser max comme alias pour le plus haut niveau. Le niveau de défaut est 0 .

Variable locale phpstan-executable

CHAÎNE

Chemin absolu vers le fichier exécutable «PhpStan».

• ex) "/path/to/phpstan.phar"

docker

Utilisez Docker à l'aide de PhpStan / Docker-Image.

(root . STRING)

Chemin relatif vers le fichier exécutable «PhpStan» à partir du répertoire racine du projet.

• ex) (root . "script/phpstan")

(STRING . (ARGUMENTS ...))

Nom et arguments de commande.

• ex) ("docker" "run" "--rm" "-v" "/path/to/project-dir/:/app" "your/docker-image")

nil

Détectez automatiquement le fichier exécutable phpstan par dépendances compositeurs du projet ou de la commande exécutable dans la variable d'environnement PATH .

Variable personnalisée phpstan-flycheck-auto-set-executable

Définissez automatiquement le mouchard PHPSTAN-EXECUT en cas de non-NIL.

Variable personnalisée phpstan-memory-limit

Utilisez l'option de limite de mémoire PHPSTAN lorsque non-NIL.

CHAÎNE

Spécifie la limite de mémoire au même format PHP.ini accepte.

• ex) "1G"

nil

Utilisez la limite de mémoire dans php.ini

Variable personnalisée phpstan-docker-image

URL de l'image Docker ou nom d'image Docker Hub ou nil. Par défaut comme "ghcr.io/phpstan/phpstan" . Voir Docker - PhpStan Documentation et GitHub Container Registory - Package PHPSTAN.