danog/psalm
1
0
Fork 0
mirror of https://github.com/danog/psalm.git synced 2024-11-26 20:34:47 +01:00
Code Issues Projects Releases Wiki Activity
746 Commits 43 Branches 314 Tags 108 MiB
PHP 100%
ff409a7f01
Go to file
Matthew Brown ff409a7f01 Update minimum requirements
2016-12-04 23:19:14 -05:00
bin Add --help for --update-docblocks 2016-11-14 14:49:49 -05:00
examples Add MissingPropertyType to default exceptions 2016-12-04 00:08:53 -05:00
src/Psalm Add support for PHP 7.1 iterable pseudo-type 2016-12-04 21:04:25 -05:00
tests Add support for PHP 7.1 iterable pseudo-type 2016-12-04 21:04:25 -05:00
.gitignore Fixing a typo in the .gitignore filename. 2016-10-20 11:52:14 -04:00
composer.json Update minimum requirements 2016-12-04 23:19:14 -05:00
composer.lock Update nikic/php-parser for PHP 7.1 support 2016-12-03 20:04:42 -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
psalm.xml Remove exceptions 2016-11-04 22:13:50 -04:00
PsalmLogo.png Update border 2016-10-29 12:46:34 -04:00
README.md Update minimum requirements 2016-12-04 23:19:14 -05:00

README.md

logo

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

Version 0.3.x supports checking PHP 5.4 - 7.1 code, and requires PHP 5.5 and higher to run.

Version 0.2.x supports checking PHP 5.4 - 7.0 code and requires PHP 5.4 and higher to run.

Check out the wiki!

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.