Psalm integration

[boesing]

Feature Request

Q	A
QA	yes

Summary

As decided during the Technical-Steering-Committee Meeting on August 3rd, 2020, Laminas wants to implement vimeo/psalm in all packages.

Implementing psalm is quite easy.

Required

• [ ] Create a .psalm.xml.dist in the project root
• [ ] Copy and paste the contents from this psalm.xml.dist
• [ ] Run $ composer require vimeo/psalm
• [ ] Run $ vendor/bin/psalm --set-baseline=psalm-baseline.xml
• [ ] Add a composer script static-analysis with the command psalm --shepherd --stats
• [ ] Add a new line to script: in .travis.yml: - if [[ $TEST_COVERAGE == 'true' ]]; then composer static-analysis ; fi
• [ ] Remove phpstan from the project (phpstan.neon.dist, .travis.yml entry, composer.json require-dev and scripts)

Optional

• [ ] Fix as many psalm errors as possible.

[gennadiylitvinyuk]

Small correction:

The file should be named psalm.xml.dist, not .psalm.xml.dist

You need to run

composer require --dev vimeo/psalm
composer require --dev psalm/plugin-phpunit
vendor/bin/psalm-plugin enable psalm/plugin-phpunit

@boesing

1. Do I need to commit both files? (the baseline too?)
2. Should I modify .gitattributes too?

[boesing]

@gennadiylitvinyuk Yes, if a baseline is needed, it should be part of the source (otherwise, the psalm.xml.dist would be invalid.

Sadly, I've created plenty of issues with the same template and thus all issues contain falsy information. So you are absolutely right with these changes.

TBH: I havent thought about the .gitattributes. I wont require a change in there but you are welcome if you want to do so.