roave/you-are-using-it-wrong
, completeness of composer.json
(#2140)
* Test against `roave/you-are-using-it-wrong` * Added CI step to ensure BC of declared API * Added step to ensure `composer.json` has all used deps * Including CI check tools as dev dependencies * Typo fix: s/backwards/backward * Run `roave/backward-compatibility-check` off an isolated location with no other dependencies * Run `test-with-real-projects` task with PHP 7.4 as base runtime * Run `testing-with-real-projects` also against `ocramius/proxy-manager` `ocramius/proxy-manager` is an extremely heavy `vimeo/psalm` consumer, and relies on a lot of the templated types system to generate real types for proxies produced by runtime evaluation.
Psalm
Psalm is a static analysis tool for finding errors in PHP applications, built on top of PHP Parser.
It's able to find a large number of issues, but it can also be configured to only care about a small subset of those.
Try a live demo, or install it in your project by following the Quickstart Guide below.
Psalm documentation
Documentation is available on Psalm’s website, generated from the docs folder.
Quickstart Guide
Install via Composer:
composer require --dev vimeo/psalm
Add a config:
./vendor/bin/psalm --init
Then run Psalm:
./vendor/bin/psalm
The config created above will show you all issues in your code, but will emit INFO
issues (as opposed to ERROR
) for certain common trivial code problems. If you want a more lenient config, you can specify the level with
./vendor/bin/psalm --init [source_dir] [level]
You can also learn how to suppress certain issues.
How Psalm Works
A basic rundown of Psalm’s internals can be found in docs/how_psalm_works.md.
Acknowledgements
The engineering team @vimeo for encouragement and patience, especially @nbeliard, @erunion and @nickyr.