danog/psalm
1
0
Fork 0
mirror of https://github.com/danog/psalm.git synced 2024-11-30 04:39:00 +01:00
Code Issues Projects Releases Wiki Activity
1,876 Commits 43 Branches 314 Tags 108 MiB
PHP 100%
310f91ea81
Go to file
Matt Brown 310f91ea81 Warn when methods with typehints don’t return for all codepaths
2018-01-02 16:57:40 -05:00
assets/config_levels Improve dead code detection, reducing false positives for params 2017-12-29 17:27:16 -05:00
bin Move Psalm execution code into PHP file that Psalm can analyse 2017-12-29 17:02:56 -05:00
docs Add PossibyInvalidFunctionCall, emitted when function call may not be valid 2018-01-01 12:00:02 -05:00
examples Add code replacement api to allow Psalm to update arbitrary parts of the codebase 2018-01-02 09:46:50 -05:00
src Warn when methods with typehints don’t return for all codepaths 2018-01-02 16:57:40 -05:00
tests Warn when methods with typehints don’t return for all codepaths 2018-01-02 16:57:40 -05:00
.editorconfig adding editorconfig that seems to match the php files (#163) 2017-06-26 00:22:05 -04:00
.gitignore Add code coverage checks by @SignpostMarv (#388) 2017-12-14 00:40:22 -05:00
.php_cs.dist adding editorconfig that seems to match the php files (#163) 2017-06-26 00:22:05 -04:00
.scrutinizer.yml
.travis.yml Look for dead code in every Psalm build (#417) 2017-12-30 09:51:01 -05:00
CODE_OF_CONDUCT.md Add code of conduct 2017-12-31 16:53:56 -05:00
composer.json Update PackageVersions version to one that doesn’t replace other similar packages 2018-01-01 09:53:21 -05:00
composer.lock Update PackageVersions version to one that doesn’t replace other similar packages 2018-01-01 09:53:21 -05:00
config.xsd Add PossibyInvalidFunctionCall, emitted when function call may not be valid 2018-01-01 12:00:02 -05:00
CONTRIBUTING.md Add CONTRIBUTING 2017-12-31 17:02:53 -05:00
LICENSE
phpcs.xml
phpunit.xml.dist Add test that analyses a class with a mapped property 2017-12-30 10:42:06 -05:00
psalm Move Psalm execution code into PHP file that Psalm can analyse 2017-12-29 17:02:56 -05:00
psalm.xml Add code replacement api to allow Psalm to update arbitrary parts of the codebase 2018-01-02 09:46:50 -05:00
PsalmLogo.png
README.md Add code coverage checks by @SignpostMarv (#388) 2017-12-14 00:40:22 -05:00

README.md

logo

Packagist Travis CI Coverage Status

Psalm is a static analysis tool for finding errors in PHP applications.

  • v0.3.x supports checking PHP 5.4 - 7.1 code, and requires PHP 5.6+ to run.
  • v0.2.x supports checking PHP 5.4 - 7.0 code and requires PHP 5.4+ to run.

Check out the wiki or try a live demo!

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.

Acknowledgements

The engineering team @vimeo for encouragement and patience, especially @nbeliard, @erunion and @nickyr.

Thanks also to @nikic for creating the excellent php-parser, on top of which Psalm is built.