psalm-plugin-laravel/README.md

19 lines
605 B
Markdown
Raw Normal View History

2019-02-19 00:11:29 +01:00
# laravel-psalm-plugin
A Psalm plugin for Laravel
2019-02-19 01:02:49 +01:00
2020-01-08 06:17:32 +01:00
![Type coverage](https://shepherd.dev/github/psalm/laravel-psalm-plugin/coverage.svg)
2019-02-19 01:02:49 +01:00
## Installation
2019-03-11 05:53:27 +01:00
First [install Psalm](https://psalm.dev/quickstart) in your project, making sure to run `--init`, then run the following commands:
2019-02-19 01:02:49 +01:00
```
composer require --dev psalm/plugin-laravel
vendor/bin/psalm-plugin enable psalm/plugin-laravel
```
## How it works
Under the hood it just runs https://github.com/barryvdh/laravel-ide-helper and feeds the resultant stubs into Psalm. It also uses a couple of function return type providers, but nothing special.