mirror of
https://github.com/danog/psalm.git
synced 2024-11-26 20:34:47 +01:00
69 lines
2.9 KiB
Markdown
69 lines
2.9 KiB
Markdown
# 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**<br />
|
|
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**<br />
|
|
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**<br />
|
|
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**<br />
|
|
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**<br />
|
|
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
|
|
<?php
|
|
$a = ['foo', 'bar'];
|
|
echo implode($a, ' ');
|
|
```
|
|
|
|
```bash
|
|
> ./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](https://github.com/etsy/phan), which uses nikic's [php-ast](https://github.com/nikic/php-ast) extension to create an abstract syntax tree
|
|
- Facebook's [Hack](http://hacklang.org/), a PHP-like language that supports many advanced typing features natively, so docblocks aren't necessary.
|
|
|
|
## Index
|
|
|
|
- Running Psalm:
|
|
- [Installation](running_psalm/installation.md)
|
|
- [Configuration](running_psalm/configuration.md)
|
|
- Plugins
|
|
- [Using plugins](running_psalm/plugins/using_plugins.md)
|
|
- [Authoring plugins](running_psalm/plugins/authoring_plugins.md)
|
|
- [How Psalm represents types](running_psalm/plugins/plugins_type_system.md)
|
|
- [Command line usage](running_psalm/command_line_usage.md)
|
|
- [IDE support](running_psalm/language_server.md)
|
|
- Handling errors:
|
|
- [Dealing with code issues](running_psalm/dealing_with_code_issues.md)
|
|
- [Issue Types](running_psalm/issues.md)
|
|
- [Checking non-PHP files](running_psalm/checking_non_php_files.md)
|
|
- Annotating code:
|
|
- [Typing in Psalm](annotating_code/typing_in_psalm.md)
|
|
- [Supported Annotations](annotating_code/supported_annotations.md)
|
|
- [Template Annotations](annotating_code/templated_annotations.md)
|
|
- Manipulating code:
|
|
- [Fixing code](manipulating_code/fixing.md)
|
|
- [Refactoring code](manipulating_code/refactoring.md)
|
|
|