phpstan.el

phpstan.el

phpstan的Emacs接口，包括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软件包。

如果您不熟悉解决依赖项，则建议使用以下外壳命令。

$ composer global require phpstan/phpstan

注意：phpstan/phpstan-shim被弃用。请阅读phpstan 0.12发布！

使用PHAR档案

注意： phpstan.el需要phpstan ** 0.10+**。我们强烈建议使用最新的phpstan。

请从版本/phpstan/phpstan下载phpstan.phar 。

设置

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 。

命令

该软件包提供了使用emacs的phpstan的方便命令。

命令phpstan-insert-dumptype

添加PHPStandumpType(...);对于您的PHP代码，并分析它以使PHPSTAN显示表达式的类型。

 （Dewine-Key Php-Mode-Map（kbd“ cc ^”）＃'phpstan-insert-dumptype）

默认情况下，如果在调用命令之前按Cu ，将插入PHPStandumpPhpDocType() 。

此功能添加在phpstan 1.12.7中，并将转储与@param和@return phpdoc标签兼容。

命令phpstan-insert-ignore

插入@phpstan-ignore标签，以抑制当前行上的任何PHPSTAN错误。

默认情况下，它将标签插入上一行，但是如果当前行的末尾或上线上已经有一个标签，则标识符将附加在此处。

如果没有现有标签，并且在命令之前按下Cu ，则将在行末尾插入。

API

此软件包中定义的大多数变量是缓冲区本地的。如果要为多个项目设置它，请使用setQ-default。

局部变量phpstan-working-dir

Phpstan工作目录的路径。

细绳

通往“ phpstan”工作目录的绝对路径。

• 例如） "/path/to/phpstan.phar"

(root . STRING)

来自项目根目录的“ phpstan”工作目录的相对路径。

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

nil

使用(php-project-get-root-dir)作为工作目录。

局部变量phpstan-config-file

PHPSTAN的项目特定配置文件的路径。

细绳

phpstan配置文件的绝对路径。

(root . STRING)

来自项目根目录的phpstan配置文件的相对路径。

零

在(phpstan-get-working-dir)中搜索phpstan.neon(.dist) 。

局部变量phpstan-level

PHPSTAN分析的规则水平。请参阅phpstan的Readme #rule级别。 0是最松散的，您也可以将max用作最高级别的别名。默认级别为0 。

局部变量phpstan-executable

细绳

绝对路径到“ phpstan”可执行文件。

• 例如） "/path/to/phpstan.phar"

符号docker

使用phpstan/docker-image使用docker。

(root . STRING)

从项目root目录到“ phpstan”可执行文件的相对路径。

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

(STRING . (ARGUMENTS ...))

命令名称和参数。

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

nil

自动检测PATH环境变量中项目或可执行命令的作曲家依赖性的phpstan可执行文件。

自定义变量phpstan-flycheck-auto-set-executable

在非nil时将flycheck phpstan-phpstan-phpstan否定。

自定义可变phpstan-memory-limit

非nil时使用PHPSTAN内存限制选项。

细绳

指定以相同格式的php.ini接受的内存限制。

• 例如） "1G"

nil

在php.ini中使用内存限制

自定义变量phpstan-docker-image

Docker Image URL或Docker Hub图像名称或零。默认为"ghcr.io/phpstan/phpstan" 。请参阅Docker -PHPSTAN文档和GitHub容器Registory -Package phpstan。