danog/psalm-plugin-symfony
1
0
Fork 0
mirror of https://github.com/danog/psalm-plugin-symfony.git synced 2024-11-26 20:04:58 +01:00
Code Issues Packages Projects Releases Wiki Activity
49 Commits 2 Branches 0 Tags 499 KiB
Gherkin 54.2%
PHP 45.8%
3b5b7016fc
Go to file
Farhad Safarov 3b5b7016fc
container dependency handler attribute fix (#48) 
* container dependency handler attribute fix

* no message

* no message

* no message
2020-06-23 23:42:21 +03:00
.build cache psalm cache in ci to allow --diff --diff-methods 2020-03-19 10:12:43 +00:00
.github/workflows fix composer.json hashing 2020-03-19 10:12:43 +00:00
src container dependency handler attribute fix (#48) 2020-06-23 23:42:21 +03:00
tests container dependency handler attribute fix (#48) 2020-06-23 23:42:21 +03:00
.gitignore doctrine repository handler (#40) 2020-06-16 04:17:22 +03:00
.php_cs.dist refactor container check (#8) 2020-03-09 15:24:39 +03:00
codeception.yml refactor container check (#8) 2020-03-09 15:24:39 +03:00
composer.json container dependency handler attribute fix (#48) 2020-06-23 23:42:21 +03:00
LICENSE initial commit 2019-11-12 16:36:05 +03:00
phpunit.xml add container unit tests (#9) 2020-03-10 19:00:55 +03:00
psalm.xml [container] multiple container xml file support (#45) 2020-06-19 16:18:31 +03:00
README.md [container] multiple container xml file support (#45) 2020-06-19 16:18:31 +03:00

README.md

Symfony Psalm Plugin

Integrate

Installation

composer require --dev psalm/plugin-symfony
vendor/bin/psalm-plugin enable psalm/plugin-symfony

Features

  • Detect ContainerInterface::get() result type. Works better if you configure compiled container XML file.
  • Detect return type of console arguments (InputInterface::getArgument()) and options (InputInterface::getOption()). Enforces to use InputArgument and InputOption constants as a part of best practise.
  • Detects correct Doctrine repository class if entities are configured with annotations.
  • Fixes PossiblyInvalidArgument for Symfony\Component\HttpFoundation\Request::getContent. The plugin calculates real return type by checking the given argument and marks return type as either string or resource.
  • Detect return type of Symfony\Component\HttpFoundation\HeaderBag::get (by checking third argument for < Symfony 4.4)
  • Detects service naming convention violations
  • Complains when Container is injected to a service. Use dependency-injection.

Configuration

If you followed installation instructions, psalm-plugin command would added plugin configuration to psalm.xml

<?xml version="1.0"?>
<psalm totallyTyped="true">
    <!--  project configuration -->

    <plugins>
        <pluginClass class="Psalm\SymfonyPsalmPlugin\Plugin" />
    </plugins>
</psalm>

To be able to detect return types of services using ID (generally starts with @ in Symfony YAML config files. Ex: logger service) containerXml must be provided. Example:

<pluginClass class="Psalm\SymfonyPsalmPlugin\Plugin">
    <containerXml>var/cache/dev/App_KernelDevDebugContainer.xml</containerXml>
</pluginClass>

This file path may change based on your Symfony version, file structure and environment settings. Default file for Symfony versions:

  • Symfony 3: var/cache/dev/srcDevDebugProjectContainer.xml
  • Symfony 4: var/cache/dev/srcApp_KernelDevDebugContainer.xml
  • Symfony 5: var/cache/dev/App_KernelDevDebugContainer.xml

Multiple container files can be configured. In this case, first valid file is taken into account. If none of the given files is valid, configuration exception is thrown. Example:

<pluginClass class="Psalm\SymfonyPsalmPlugin\Plugin">
    <containerXml>var/cache/dev/App_KernelDevDebugContainer.xml</containerXml>
    <containerXml>var/cache/dev/App_KernelTestDebugContainer.xml</containerXml>
</pluginClass>

Credits