psalm

mirror of https://github.com/danog/psalm.git synced 2024-11-26 20:34:47 +01:00

Go to file

Matt Brown c91e457c28 Add psalm.xml support for checking tests		2016-12-14 12:55:23 -05:00
bin	Add JSON output format	2016-12-07 22:38:57 -05:00
examples	Fix references, add helpful comments	2016-12-12 16:07:45 -05:00
src/Psalm	Change NullReference issue to NullArgument when in method call	2016-12-14 12:54:34 -05:00
tests	Add psalm.xml support for checking tests	2016-12-14 12:55:23 -05:00
.gitignore	Fixing a typo in the .gitignore filename.	2016-10-20 11:52:14 -04:00
.travis.yml	Fix files	2016-12-07 00:16:15 -05:00
composer.json	Add TypeDoesNotContainType issue and fix those issues in Psalm code	2016-12-11 13:48:11 -05:00
composer.lock	Add TypeDoesNotContainType issue and fix those issues in Psalm code	2016-12-11 13:48:11 -05:00
LICENSE	Add license	2016-11-21 14:48:17 -05:00
phpcs.xml	PSR-2	2016-11-02 17:50:54 -04:00
phpunit.xml	Add bootstrap	2016-12-07 00:21:46 -05:00
psalm.xml	Add psalm.xml support for checking tests	2016-12-14 12:55:23 -05:00
PsalmLogo.png	Update border	2016-10-29 12:46:34 -04:00
README.md	Change image link	2016-12-12 15:32:01 -05:00

README.md

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.5+ 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:dev-master"
composer install

Add a psalm.xml config:

cat > psalm.xml << EOF
<?xml version="1.0"?>
<psalm
  stopOnFirstError="false"
  useDocblockTypes="true"
>
    <inspectFiles>
        <directory name="src" />
    </inspectFiles>
</psalm>
EOF

Then run Psalm with:

./vendor/bin/psalm

The above config is spartan, and will show you all possible errors, including many that are likely irrelevant to you. A more lenient config is provided here.