mirror of
https://github.com/danog/psalm.git
synced 2024-11-27 04:45:20 +01:00
77 lines
2.1 KiB
Markdown
77 lines
2.1 KiB
Markdown
# Dealing with code issues
|
||
|
||
Psalm has a large number of [code issues](issues.md). Each project can specify its own reporting level for a given issue.
|
||
|
||
Code issue levels in Psalm fall into three categories:
|
||
<dl>
|
||
<dt>error</dt>
|
||
<dd>This will cause Psalm to print a message, and to ultimately terminate with a non-zero exit status</dd>
|
||
<dt>info</dt>
|
||
<dd>This will cause Psalm to print a message</dd>
|
||
<dt>suppress</dt>
|
||
<dd>This will cause Psalm to ignore the code issue entirely</dd>
|
||
</dl>
|
||
|
||
The third category, `suppress`, is the one you will probably be most interested in, especially when introducing Psalm to a large codebase.
|
||
|
||
## Suppressing issues
|
||
|
||
There are two ways to suppress an issue – via the Psalm config or via a function docblock.
|
||
|
||
### Config suppression
|
||
|
||
You can use the `<issueHandlers>` tag in the config file to influence how issues are treated.
|
||
|
||
Some issue types allow the use of `referencedMethod` and `referencedClass` to isolate known trouble spots.
|
||
|
||
```xml
|
||
<issueHandlers>
|
||
<MissingPropertyType errorLevel="suppress" />
|
||
|
||
<InvalidReturnType>
|
||
<errorLevel type="suppress">
|
||
<directory name="some_bad_directory" /> <!-- all InvalidReturnType issues in this directory are suppressed -->
|
||
<file name="some_bad_file.php" /> <!-- all InvalidReturnType issues in this file are suppressed -->
|
||
</errorLevel>
|
||
</InvalidReturnType>
|
||
<UndefinedMethod>
|
||
<errorLevel type="suppress">
|
||
<referencedMethod name="Bar\Bat::bar" />
|
||
<file name="some_bad_file.php" />
|
||
</errorLevel>
|
||
</UndefinedMethod>
|
||
<UndefinedClass>
|
||
<errorLevel type="suppress">
|
||
<referencedClass name="Bar\Bat\Baz" />
|
||
</errorLevel>
|
||
</UndefinedMethod>
|
||
</issueHandlers>
|
||
```
|
||
|
||
### Docblock suppression
|
||
|
||
You can also use `@psalm-suppress IssueName` on a function's docblock to suppress Psalm issues e.g.
|
||
|
||
```php
|
||
/**
|
||
* @psalm-suppress InvalidReturnType
|
||
*/
|
||
function (int $a) : string {
|
||
return $a;
|
||
}
|
||
```
|
||
|
||
You can also suppress issues at the line level e.g.
|
||
|
||
```php
|
||
/**
|
||
* @psalm-suppress InvalidReturnType
|
||
*/
|
||
function (int $a) : string {
|
||
/**
|
||
* @psalm-suppress InvalidReturnStatement
|
||
*/
|
||
return $a;
|
||
}
|
||
```
|