Extra strict and opinionated PHPStan rules for Laravel.
You can install the package via composer:
composer require --dev canvural/larastan-strict-rulesTo enable all the rules, include rules.neon in your project's PHPStan config:
includes:
- vendor/canvural/larastan-strict-rules/rules.neon
If you don't want to start using all the available strict rules at once but only one or two, you can! Just don't include the whole rules.neon from this package in your configuration, but look at its contents and copy only the rules you want to your configuration under the services key. For example:
services:
-
class: Vural\LarastanStrictRules\Rules\NoDynamicWhereRule
tags:
- phpstan.rules.rule
-
class: Vural\LarastanStrictRules\Rules\NoFacadeRule
tags:
- phpstan.rules.rule
This rule disallows the usage of dynamic where methods on Eloquent query builder.
This rule disallows the usage of Laravel Facades. Also, checks for the real time facade usage.
This rule disallows the usage of global helper functions that comes with Laravel.
If you want to allow some functions, you can use the allowedFunctions parameter for this rule. Like so:
-
class: Vural\LarastanStrictRules\Rules\NoGlobalLaravelFunctionRule
arguments:
allowedFunctions:
- app
- eventThis rule disallows validating the request in controllers.
This rule makes sure Illuminate\Database\Eloquent\Builder instance is returned from Eloquent local query scopes.
This rule disallows the usage of local model query scopes all together.
This rule disallows the usage of model property accessors.
This rule makes sure your event listeners have a void return type.
If you return false from an event listener, Laravel will stop the propagation of an event to other listeners. Sometimes this can be useful. But other time it can cause bugs that you will need to debug for hours. So this opinionated rule makes sure you always have void return type for your event listeners.
You need to configure this rule by adding the directories that your event listeners are in to the listenerPaths parameter:
-
class: Vural\LarastanStrictRules\Rules\ListenerShouldHaveVoidReturnTypeRule
arguments:
listenerPaths:
- app/Listeners
- app/DomainA/ListenersPlease see CHANGELOG for more information on what has changed recently.
Please see CONTRIBUTING for details.
People:
The MIT License (MIT). Please see License File for more information.