tooeo/psalm-plugin-jms

Checking JMS annotation

0.1.0 2023-07-26 05:46 UTC

Requires

• php: ^8
• vimeo/psalm: ^5.13

Requires (Dev)

• codeception/codeception: ^4.1
• phpunit/phpunit: ^9.5.5
• psalm/plugin-phpunit: ^0.18.4
• squizlabs/php_codesniffer: ^3.3
• weirdan/codeception-psalm-module: ^0.13.1
• weirdan/prophecy-shim: ^2.0

MIT

• Tabota Oleg

README

Plugin for Psalm wich check JMS serializer annotation&

When you use JMS serializer you need add annotation for properties. And some times you can user classes as a type for properties.

For example:

class SomeTestFile
{
    /**
     * @JMS\Type('\Tooeo\PsalmPluginJms\Tests\Fixtures\JmsDto');
     * @psalm-suppress PropertyNotSetInConstructor
     */
    public string $good;
    /**
     * @JMS\Type('array<JmsDto>');
     * @psalm-suppress PropertyNotSetInConstructor
     */
    public string $goodArray;
}

And you can make a mistake by typing the class name.

So if you don't have enough tests, you can get problems on production. This plugin helps avoid that behavior and prevent creating code with unexist classes in annotations.

Installation

composer require --dev tooeo/psalm-plugin-jms
vendor/bin/psalm-plugin enable tooeo/psalm-plugin-jms