Extra strict and opinionated PHPStan rules for Laravel.

You can install the package via composer:

composer require --dev canvural/larastan-strict-rules

To enable all the rules, include rules.neon in your project's PHPStan config:

includes:
    - vendor/canvural/larastan-strict-rules/rules.neon

You can disable rules using configuration parameters:

parameters:
    larastanStrictRules:
        noDynamicWhere: false
        noFacade: false
        noGlobalLaravelFunction: false
        noLocalQueryScope: false
        noPropertyAccessor: false
        noValidationInController: false
        scopeShouldReturnQueryBuilder: false
        listenerShouldHaveVoidReturnType: false

If you don't want to start using all the available strict rules at once but only one or two, you can!

You can disable all rules from the included rules.neon with:

parameters:
	larastanStrictRules:
		allRules: false

Then you can re-enable individual rules with configuration parameters:

parameters:
	larastanStrictRules:
		allRules: false
		noDynamicWhere: true

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 allowedGlobalFunctions parameter. Like so:

parameters:
    allowedGlobalFunctions:
        - app
        - event

This 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:

parameters:
    listenerPaths:
        - app/Listeners
        - app/DomainA/Listeners

Please see CHANGELOG for more information on what has changed recently.

Please see CONTRIBUTING for details.

People:

• Can Vural
• All Contributors

The MIT License (MIT). Please see License File for more information.