psalm/plugin-laravel

A Laravel plugin for Psalm

v2.8.0 2023-02-26 18:23 UTC

Requires

• php: ^8.0.2
• ext-simplexml: *
• barryvdh/laravel-ide-helper: ^2.13
• illuminate/config: ^9.48 || ^10.0
• illuminate/container: ^9.48 || ^10.0
• illuminate/contracts: ^9.48 || ^10.0
• illuminate/database: ^9.48 || ^10.0
• illuminate/events: ^9.48 || ^10.0
• illuminate/http: ^9.48 || ^10.0
• illuminate/routing: ^9.48 || ^10.0
• illuminate/support: ^9.48 || ^10.0
• illuminate/view: ^9.48 || ^10.0
• nikic/php-parser: ^4.13
• orchestra/testbench: ^7.19 || ^8.0
• symfony/console: ^6.0
• vimeo/psalm: ^4.30 || ^5.1

Requires (Dev)

• codeception/codeception: ^5.0
• codeception/module-asserts: ^3.0
• codeception/module-cli: ^2.0
• codeception/module-filesystem: ^3.0
• codeception/module-phpbrowser: ^3.0
• phpunit/phpunit: ^9.6 || ^10.0
• ramsey/collection: ^1.3
• slevomat/coding-standard: ^8.8
• squizlabs/php_codesniffer: *
• symfony/http-foundation: ^6.0

MIT

• Matthew Brown

README

Overview

This Psalm plugin brings static analysis and type support to projects using Laravel. 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!

Versions & Dependencies

Laravel Psalm Plugin	PHP	Laravel	Psalm
2.x	^8.0	8, 9, 10	4, 5
1.x	^7.1	5, 6, 7, 8	3, 4

See releases for more details about supported PHP, Laravel and Psalm versions.

Quickstart

Step 1: Install

composer require --dev psalm/plugin-laravel

Step 2: Configure

If you didn't use Psalm on the project before, you need to create a Psalm config:

./vendor/bin/psalm --init

Step 3: enable the plugin:

./vendor/bin/psalm-plugin enable psalm/plugin-laravel

Step 4: Run 🚀

Run your usual Psalm command:

./vendor/bin/psalm

You can customize Psalm configuration using XML config and/or cli parameters.

Recommendation: use baseline file and increase errorLevel at least to 4: this way you can catch more issues. Step by step set errorLevel to 1 and use Psalm and this plugin at full power 🚀.

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.

Psalm-Laravel-Plugin or Larastan?

Both! It's fine to use both tools at the same project: they use different approaches to analyze code, and thus you can find more bugs! Psalm and PHPStan use almost same the syntax annotations, so you should not have any conflicts.