danog/psalm
1
0
Fork 0
mirror of https://github.com/danog/psalm.git synced 2024-12-13 09:47:29 +01:00
Code Issues Projects Releases Wiki Activity
1708bae984
psalm/docs
History
Matt Brown 74749d20cc Improve documentation for taints a little 
Ref #4590
2020-11-17 16:03:50 -05:00
..
annotating_code Update to more specific example 2020-11-06 17:56:39 -05:00
manipulating_code Add more accurate description of functionality 2020-09-30 16:12:18 -04:00
running_psalm Improve documentation for taints a little 2020-11-17 16:03:50 -05:00
security_analysis $expr->name is not prefixed with $ (#4554) 2020-11-15 20:28:24 -05:00
how_psalm_works.md
README.md 4.x (#4363) 2020-10-18 23:28:05 -04:00
what_makes_psalm_complicated.md

README.md

About Psalm

Psalm is a static analysis tool that attempts to dig into your program and find as many type-related bugs as possible.

It has a few features that go further than other similar tools:

  • Mixed type warnings
    If Psalm cannot infer a type for an expression then it uses a mixed placeholder type. mixed types can sometimes mask bugs, so keeping track of them helps you avoid a number of common pitfalls.

  • Intelligent logic checks
    Psalm keeps track of logical assertions made about your code, so if ($a && $a) {} and if ($a && !$a) {} are both treated as issues. Psalm also keeps track of logical assertions made in prior code paths, preventing issues like if ($a) {} elseif ($a) {}.

  • Property initialisation checks
    Psalm checks that all properties of a given object have values after the constructor is called.

Psalm also has a few features to make it perform as well as possible on large codebases:

  • Multi-threaded mode
    Wherever possible Psalm will run its analysis in parallel to save time. Useful for large codebases, it has a massive impact on performance.

  • Incremental checks
    By default Psalm only analyses files that have changed and files that reference those changed files.

Example output

Given a file implode_strings.php:

<?php
$a = ['foo', 'bar'];
echo implode($a, ' ');

> ./vendor/bin/psalm implode_strings.php
ERROR: InvalidArgument - somefile.php:3:14 - Argument 1 of implode expects `string`, `array` provided (see https://psalm.dev/004)

Inspirations

There are two main inspirations for Psalm:

  • Etsy's Phan, which uses nikic's php-ast extension to create an abstract syntax tree
  • Facebook's Hack, a PHP-like language that supports many advanced typing features natively, so docblocks aren't necessary.

Index