danog/psalm-plugin-symfony
1
0
Fork 0
mirror of https://github.com/danog/psalm-plugin-symfony.git synced 2024-11-30 04:29:10 +01:00
Code Issues Packages Projects Releases Wiki Activity
23 Commits 2 Branches 0 Tags 499 KiB
Gherkin 54.2%
PHP 45.8%
32b2307316
Go to file
Ben Davies 32b2307316 Github Actions: fix badge
2020-03-13 16:16:51 +00:00
.github/workflows Github Actions: fix codeception 2020-03-13 16:13:45 +00:00
src Migrate Seferov => Psalm 2020-03-13 10:51:18 -04:00
tests Migrate Seferov => Psalm 2020-03-13 10:51:18 -04:00
.gitignore refactor container check (#8) 2020-03-09 15:24:39 +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 Migrate Seferov => Psalm 2020-03-13 10:51:18 -04: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 psalm config (#1) 2019-11-12 16:51:13 +03:00
README.md Github Actions: fix badge 2020-03-13 16:16:51 +00: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.
  • 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.
  • 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

Credits