Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/psalm/psalm-plugin-symfony
Psalm Plugin for Symfony
https://github.com/psalm/psalm-plugin-symfony
Last synced: about 2 months ago
JSON representation
Psalm Plugin for Symfony
- Host: GitHub
- URL: https://github.com/psalm/psalm-plugin-symfony
- Owner: psalm
- License: mit
- Created: 2019-11-12T13:35:50.000Z (about 5 years ago)
- Default Branch: 5.x
- Last Pushed: 2024-07-03T11:58:28.000Z (6 months ago)
- Last Synced: 2024-08-02T20:46:12.036Z (5 months ago)
- Language: Gherkin
- Size: 432 KB
- Stars: 226
- Watchers: 10
- Forks: 53
- Open Issues: 33
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Symfony Psalm Plugin
### Installation
```
composer require --dev psalm/plugin-symfony
vendor/bin/psalm --init
vendor/bin/psalm-plugin enable psalm/plugin-symfony
```
### Versions & Dependencies
| Symfony Psalm Plugin | PHP | Symfony | Psalm |
|----------------------|------------|---------|-------|
| 5.x | ^8.0 | 5, 6, 7 | 5 |
| 4.x | ^7.4, ^8.0 | 4, 5, 6 | 4 |
| 3.x | ^7.1, ^8.0 | 4, 5, 6 | 4 |
| 2.x | ^7.1, ^8.0 | 4, 5 | 4 |
| 1.x | ^7.1 | 3, 4, 5 | 3 |
### Features
- Detects the `ContainerInterface::get()` result type. Works better if you [configure](#configuration) a compiled container XML file.
- Detects parameter return types from `ContainerInterface::getParameter()`.
- Supports [Service Subscribers](https://github.com/psalm/psalm-plugin-symfony/issues/20). Works only if you [configure](#configuration) a compiled container XML file.
- Detects return types from console arguments (`InputInterface::getArgument()`) and options (`InputInterface::getOption()`).
Enforces to use "InputArgument" and "InputOption" constants as a best practice.
- Detects Doctrine repository classes associated to entities when configured via annotations.
- Fixes `PossiblyInvalidArgument` for `Symfony\Component\HttpFoundation\Request::getContent()`.
The plugin determines the real return type by checking the given argument and marks it as either "string" or "resource".
- Detects the return type of `Symfony\Component\HttpFoundation\HeaderBag::get()` by checking the default value (third argument for < Symfony 4.4).
- Detects the return types of `Symfony\Component\Messenger\Envelope::last` and `Symfony\Component\Messenger\Envelope::all`, based on the provided argument.
- Taint analysis for Symfony.
- Detects services and parameters [naming conventions](https://symfony.com/doc/current/contributing/code/standards.html#naming-conventions) violations.
- Complains when `Container` is injected in a service, and asks to use dependency-injection instead.
- Fixes `PropertyNotSetInConstructor` false positive issues:
- $container in AbstractController
- $context in ConstraintValidator classes
- properties in custom `@Annotation` classes
- And [much more](https://github.com/psalm/psalm-plugin-symfony/tree/master/tests/acceptance/acceptance)!
### Configuration
If you follow the installation instructions, the psalm-plugin command will add this plugin configuration to the `psalm.xml` configuration file.
```xml
```
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:
```xml
var/cache/dev/App_KernelDevDebugContainer.xml
```
This file path may change based on your Symfony version, file structure and environment settings.
Default files are:
- 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, the first valid file is taken into account.
If none of the given files is valid, a configuration exception is thrown.
Example:
```xml
var/cache/dev/App_KernelDevDebugContainer.xml
var/cache/dev/App_KernelTestDebugContainer.xml
```
If you're using PHP config files for Symfony 5.3+, you also need this for auto-loading of `Symfony\Config`:
```xml
```
If you're using Symfony's `env()` or `param()` functions in your PHP config files, you also need this for auto-loading them:
```xml
```
If you're getting the following error
> MissingFile - config/preload.php - Cannot find file ...var/cache/prod/App_KernelProdContainer.preload.php to include
...you can suppress it like this:
```xml
```
#### Symfony version
By default, the plugin uses the `Kernel::MAJOR_VERSION` constant to determine your version of Symfony. However, this
might not be accurate if you have Psalm installed globally. You can set the version explicitly using
the `symfonyMajorVersion` configuration option:
```xml
6
```
### Twig tainting (experimental)
When it comes to taint analysis for Twig templates, there are currently two approaches:
- The first one is based on a specific file analyzer (`Psalm\SymfonyPsalmPlugin\Twig\TemplateFileAnalyzer`) which leverages the Twig parser and visits the AST nodes.
- The second one is based on the already compiled Twig templates, it only bridges calls from `Twig\Environment::render` to the actual `doRender` method of the compiled template.
#### Twig Analyzer
This approach is more robust since it relies on the official Twig parser and node visitor mechanisms.
For the moment, it is only able to detect simple tainted paths.
To leverage the real Twig file analyzer, you have to configure a checker for the `.twig` extension as follows:
```xml
```
[See the currently supported cases.](https://github.com/psalm/psalm-plugin-symfony/blob/master/tests/acceptance/acceptance/TwigTaintingWithAnalyzer.feature)
#### Cache Analyzer
This approach is "dirtier", since it tries to connect the taints from the application code to the compiled PHP code representing a given template.
It is theoretically able to detect more taints than the previous approach out-of-the-box, but it still lacks ways to handle inheritance and stuff like that.
To allow the analysis through the cached template files, you have to add the `twigCachePath` entry to the plugin configuration :
```xml
/cache/twig
```
[See the currently supported cases.](https://github.com/psalm/psalm-plugin-symfony/blob/master/tests/acceptance/acceptance/TwigTaintingWithCachedTemplates.feature)
### Credits
- Plugin created by [@seferov](https://github.com/seferov)
- [@weirdan](https://github.com/weirdan) for [codeception psalm module](https://github.com/weirdan/codeception-psalm-module)