README

Since the release of PHP 8.0 more and more libraries, frameworks and tools have been updated to use attributes instead of annotations in PHPDocs.

However, static analysis tools like Psalm have not made this transition to attributes and they still rely on annotations in PHPDocs for a lot of their functionality.

This is a Psalm plugin that allows Psalm to understand a new set of attributes that replace the PHPDoc annotations. These attributes are defined in this repository

NOTE: Version 0.4.0 of this plugin requires Php Parser v5. The current available version of Psalm (v5) does not support this version of the parser, so currently this library only supports the dev-master version of Psalm. If you need to use Psalm 5, you will need to use version 0.3 of this plugin.

Example

In order to show how code would look with these attributes, we can look at the following example. This is how a class looks like with the current annotations:

<?php class ArrayAdder { /** @var array<string> */ private array $result; /**  * @param array<string> $array1  * @param array<string> $array2  * @return array<string>  */ public function addArrays(array $array1, array $array2): array { $this->result = $array1 + $array2; return $this->result; } }

And this is how it would look like using the new attributes:

<?php use PhpStaticAnalysis\Attributes\Type; use PhpStaticAnalysis\Attributes\Param; use PhpStaticAnalysis\Attributes\Returns; class ArrayAdder { #[Type('array<string>')] private array $result; #[Param(array1: 'array<string>')] #[Param(array2: 'array<string>')] #[Returns('array<string>')] public function addArrays(array $array1, array $array2): array { $this->array = $array1 + $array2; return $this->array; } }

Installation

First of all, to make the attributes available for your codebase use:

composer require php-static-analysis/attributes 

To use this plugin, require it in Composer:

composer require --dev php-static-analysis/psalm-plugin 

NOTE: When adding this dependency, composer will ask you if you want to allow this dependency as a composer plugin. This is needed so that this plugin can patch Psalm in order to enable its functionality. This will add an entry in your allow-plugins composer config entry.

Then run this command to enable the plugin:

vendor/bin/psalm-plugin enable php-static-analysis/psalm-plugin 

This will add this plugin configuration to the psalm.xml configuration file:

 <plugins> <pluginClass class="PhpStaticAnalysis\PsalmPlugin\Plugin" /> </plugins>

If you prefer, you can also manually add this configuration to your psalm.xml file instead of running the psalm-plugin enable command.

Using the extension

This extension works by interacting with the parser that Psalm uses to parse the code and replacing the new Attributes with PHPDoc annotations that Psalm can understand. The functionality provided by the attribute is exactly the same as the one provided by the corresponding PHPDoc annotation.

These are the available attributes and their corresponding PHPDoc annotations:

Sponsor this project

If you would like to support the development of this project, please consider sponsoring me