brokeyourbike/plugin-laravel

A Laravel 8 plugin for Psalm. PHP 8 only.

Installs: 106

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 0

Forks: 34

Type:psalm-plugin

v2.0.0 2021-06-29 20:38 UTC

README

Packagist Packagist Type coverage Tests

Overview

This package brings static analysis and type support to projects using Laravel 8. Our goal is to find as many type-related bugs as possible, therefore increasing developer productivity and application health. Find bugs without the overhead of writing tests!

Screenshot

Quickstart

Please refer to the full Psalm documentation for a more detailed guide on introducing Psalm into your project.

First, start by installing Psalm if you have not done so already:

composer require --dev vimeo/psalm
./vendor/bin/psalm --init

Next, install this package and enable the plugin

composer require --dev brokeyourbike/plugin-laravel
./vendor/bin/psalm-plugin enable brokeyourbike/plugin-laravel

Finally, run Psalm to analyze your codebase

./vendor/bin/psalm

How it works

Under the hood it just runs https://github.com/barryvdh/laravel-ide-helper and feeds the resultant stubs into Psalm, which can read PhpStorm meta stubs.

It also parses any database migrations it can find to try to understand property types in your database models.