1
0
mirror of https://github.com/danog/psalm.git synced 2024-11-26 20:34:47 +01:00
Go to file
2018-01-14 15:38:00 -05:00
assets/config_levels Fix XML formatting for example files 2018-01-10 11:01:32 -05:00
bin Move Psalm execution code into PHP file that Psalm can analyse 2017-12-29 17:02:56 -05:00
docs Remove stray bracket 2018-01-14 15:38:00 -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 Move ClassLikeChecker::analyze into ClassChecker and InterfaceChecker 2018-01-14 13:08:24 -05:00
tests Don’t investigate property mutations if they’re not visible 2018-01-13 01:52:46 -05:00
.editorconfig adding editorconfig that seems to match the php files (#163) 2017-06-26 00:22:05 -04:00
.gitignore Remove lockfile because it’s wholly unnecessary 2018-01-02 20:44:10 -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 scrutinizer-ci (#152) 2017-05-26 18:26:14 -04:00
.travis.yml Increase Psalm memory limit in anticipation of PHPUnit 6 2018-01-09 01:13:58 -05:00
CODE_OF_CONDUCT.md Add code of conduct 2017-12-31 16:53:56 -05:00
composer.json Add --dry-run option 2018-01-07 17:25:23 -05:00
config.xsd Allow the use of property docblocks without all docblocks 2018-01-13 00:32:20 -05:00
CONTRIBUTING.md Add reference to how Psalm works overview 2018-01-14 15:35:52 -05:00
LICENSE Add license 2016-11-21 14:48:17 -05:00
phpcs.xml PSR-2 adjustments and adding PHPCS checks into the Travis config. (#149) 2017-04-28 00:31:55 -04:00
phpunit.xml.dist Update PHPUnit configuration to follow best practices 2018-01-09 01:14:38 -05:00
psalm Move Psalm execution code into PHP file that Psalm can analyse 2017-12-29 17:02:56 -05:00
psalm.xml Find unused properties with dead code checks 2018-01-10 23:29:18 -05:00
PsalmLogo.png New and improved logo 2017-01-16 17:24:26 -05:00
psalter Break file manipulation out into Psalter 2018-01-07 17:25:23 -05:00
README.md Add reference to how Psalm works overview 2018-01-14 15:35:52 -05:00

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.

How Psalm Works

A basic rundown of Psalms internals can be found in docs/how_psalm_works.md.

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.