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
2,036 Commits 43 Branches 314 Tags 108 MiB
PHP 100%
95adccaa5f
Go to file
Matthew Brown 95adccaa5f Make Scrutinizer check Psalm
2018-01-24 20:38:09 -05:00
assets/config_levels Remove stopOnFirstError config option, because it hasn’t worked for a while 2018-01-24 16:22:54 -05:00
bin Move Psalm execution code into PHP file that Psalm can analyse 2017-12-29 17:02:56 -05:00
docs Add tick 2018-01-14 15:43:26 -05:00
examples Create Codebase out from ProjectChecker 2018-01-21 13:45:33 -05:00
src Allow @psalm-ignore-falsable-return annotation 2018-01-24 18:52:58 -05:00
tests Allow @psalm-ignore-falsable-return annotation 2018-01-24 18:52:58 -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 Fix formatting in examples 2018-01-18 17:41:14 -05:00
.scrutinizer.yml Make Scrutinizer check Psalm 2018-01-24 20:38:09 -05: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 Add DeprecatedInterface and emit DeprecatedClass in more places 2018-01-23 09:09:43 -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 Fix formatting in examples 2018-01-18 17:41:14 -05:00
phpunit.xml.dist Allow tests to not test anything 2018-01-22 00:27:22 -05:00
psalm Move Psalm execution code into PHP file that Psalm can analyse 2017-12-29 17:02:56 -05:00
psalm.xml Remove stopOnFirstError config option, because it hasn’t worked for a while 2018-01-24 16:22:54 -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 total downloads 2018-01-23 17:25:42 -05:00

README.md

logo

Packagist 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 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.

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