danog/psalm
1
0
Fork 0
mirror of https://github.com/danog/psalm.git synced 2024-11-27 04:45:20 +01:00
Code Issues Projects Releases Wiki Activity
2,115 Commits 43 Branches 314 Tags 108 MiB
PHP 100%
4b87612bb4
Go to file
Matt Brown 4b87612bb4 Add better issue message for bad array offset 
Fixes #492
2018-02-06 11:27:01 -05:00
assets/config_levels Split UntypedParam into MissingParamType and MissingClosureParamType 2018-01-28 20:03:47 -05:00
bin Move Psalm execution code into PHP file that Psalm can analyse 2017-12-29 17:02:56 -05:00
docs Provide more information about the scanning step 2018-02-04 12:51:45 -05:00
examples Break apart the Codebase class 2018-02-03 18:56:54 -05:00
src Add better issue message for bad array offset 2018-02-06 11:27:01 -05:00
tests Add better issue message for bad array offset 2018-02-06 11:27:01 -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 Ignore useless dirs 2018-02-03 20:08:14 -05:00
.travis.yml Disable coveralls on all but the PHP 7.2 build 2018-01-29 01:09:09 -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 Fix #479 - allow PhpStorm generic syntax behind a config flag 2018-02-01 01:10:27 -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 Break apart the Codebase class 2018-02-03 18:56: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.