phpstan.el

phpstan.el

A interface do EMACS para o Phpstan, inclui verificador para flycheck.

Versão de suporte

• Emacs 25+
• Phpstan mais recente/dev-mestre (não suporta 0,9 séries)
• Php 7.1+ ou tempo de execução do Docker

Como instalar

Instale a partir de Melpa

1. Se você não configurou Melpa, consulte o início - Melpa.
2. Mx package-install flycheck-phpstan

Como usar

Para o usuário do 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 )

Para usuário de flymake

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

Usando Docker (Phpstan/Docker-Image)

Instale a imagem do docker e phpstan/phpstan.

Se você sempre usa o Docker para o Phpstan, adicione o seguinte ao seu arquivo .emacs (~~/.emacs.d/init.el ~)

( setq-default phpstan-executable 'docker )

Coloque o seguinte nos arquivos .dir-locals.el no diretório raiz do projeto.

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

Usando compositor (específico do projeto)

Se o seu projeto compositor depende do Phpstan, você não precisará definir nada.

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

Usando compositor

Instale o pacote phpstan/phpstan para cada ambiente ou projeto do usuário usando o Composer.

Se você não estiver familiarizado com a resolução de dependências, os seguintes comandos do shell serão recomendados.

$ composer global require phpstan/phpstan

Aviso : Phpstan/phpstan-shim está descontinuado. Por favor, leia o Phpstan 0.12 lançado!.

Usando o Arquivo Phar

Aviso : phpstan.el requer phpstan ** 0.10+**. Recomendamos fortemente o uso do Phpstan mais recente.

Faça o download phpstan.phar de lançamentos · phpstan/phpstan.

Configurações

As variáveis ​​para o phpstan são controladas principalmente por variáveis ​​de diretório ( .dir-locals.el ).

Freqüentemente (root. "path/to/file") A notação aparece nessas variáveis. É relativo ao diretório de nível superior do projeto. Em geral, o diretório que contém um do arquivo .projectile , composer.json , .git (ou diretório) está no nível superior.

Esteja ciente de que o diretório raiz do projeto PHP não pode corresponder a um dos %rootDir% e/ou %currentWorkingDirectory% .

Normalmente, você definia os seguintes .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 ))))

Se houver um arquivo phpstan.neon no diretório raiz do projeto, você não precisará definir phpstan-working-dir e phpstan-config-file .

Comandos

Este pacote fornece comandos convenientes para o uso do Phpstan da EMACS.

Comando phpstan-insert-dumptype

Adicione PHPStandumpType(...); ao seu código PHP e analisá -lo para fazer com que o Phpstan exiba o tipo de expressão.

 (Definir-Key-PHP-Mode-MAP (KBD "CC ^") #'Phpstan-Insert-Dumptype)

Por padrão, se você pressionar Cu antes de invocar o comando, PHPStandumpPhpDocType() será inserido.

Esse recurso foi adicionado nos tipos Phpstan 1.12.7 e despejarão os tipos compatíveis com as tags @param e @return phpdoc.

Comando phpstan-insert-ignore

Insira uma tag @phpstan-ignore para suprimir qualquer erro do Phpstan na linha atual.

Por padrão, ele insere a tag na linha anterior, mas se já houver uma tag no final da linha atual ou na linha anterior, os identificadores serão anexados lá.

Se não houver tag existente e Cu for pressionado antes do comando, ela será inserida no final da linha.

API

A maioria das variáveis ​​definidas neste pacote é o buffer local. Se você deseja configurá-lo para vários projetos, use o setq-default.

Variável local phpstan-working-dir

Caminho para o diretório de trabalho do Phpstan.

CORDA

Caminho absoluto para o diretório de trabalho do 'phpstan'.

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

(root . STRING)

Caminho relativo para o diretório de trabalho do 'phpstan' do diretório raiz do projeto.

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

nil

Use (php-project-get-root-dir) como diretório de trabalho.

Variável local phpstan-config-file

Caminho para projetar arquivo de configuração específico do Phpstan.

CORDA

Caminho absoluto para o arquivo de configuração phpstan .

(root . STRING)

Caminho relativo para o arquivo de configuração phpstan do diretório raiz do projeto.

Nil

Pesquise phpstan.neon(.dist) em (phpstan-get-working-dir) .

Variável local phpstan-level

Nível de regra da análise do Phpstan. Por favor, consulte os níveis de readme #RULE do Phpstan. 0 é o mais rápido e você também pode usar max como um alias para o nível mais alto. O nível padrão é 0 .

Variável local phpstan-executable

CORDA

Caminho absoluto para o arquivo executável `phpstan '.

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

docker símbolo

Use o Docker usando o Phpstan/Docker-Image.

(root . STRING)

Caminho relativo para o arquivo executável `phpstan 'do diretório raiz do projeto.

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

(STRING . (ARGUMENTS ...))

Nome do comando e argumentos.

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

nil

Detectar automaticamente o arquivo executável phpstan por dependências do compositor do projeto ou comando executável na variável do ambiente PATH .

Variável personalizada phpstan-flycheck-auto-set-executable

Defina o FlyCheck Phpstan, executável automaticamente, quando não é NIL.

Variável personalizada phpstan-memory-limit

Use a opção Limite de memória do Phpstan quando não-NIL.

CORDA

Especifica o limite de memória no mesmo formato Php.ini aceita.

• ex) "1G"

nil

Use o limite de memória em php.ini

Variável personalizada phpstan-docker-image

Docker Image URL ou Nome da imagem do hub do docker ou nulo. Padrão como "ghcr.io/phpstan/phpstan" . Consulte Docker - Documentação do Phpstan e Registório de Container Github - Pacote Phpstan.