Skip to content

Add a note about static analysis #235

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Nyholm merged 4 commits into from
Feb 28, 2021
Merged

Add a note about static analysis #235

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
07b3ef8
Add a note about static analysis
staabm Jan 19, 2021
fc9223d
Update README.md
staabm Jan 19, 2021
1c1d4cb
Update README.md
staabm Jan 19, 2021
5f47c6d
Update README.md
Nyholm Feb 28, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -249,6 +249,12 @@ Overriding the following methods in your assertion class allows you to change th
* `protected static function reportInvalidArgument($message)`
* This method is called when an assertion fails, with the specified error message. Here you can throw your own exception, or log something.

## Static analysis support

Where applicable, assertion functions are annotated to support Psalm's
[Assertion syntax](https://psalm.dev/docs/annotating_code/assertion_syntax/).
A dedicated [PHPStan Plugin](https://github.com/phpstan/phpstan-webmozart-assert) is
required for proper type support.

Authors
-------
Expand Down