phpstan-rules

This project provides a composer package with rules for phpstan/phpstan.

Run

composer require --dev ergebnis/phpstan-rules

All of the rules provided (and used) by this library are included in rules.neon.

When you are using phpstan/extension-installer, rules.neon will be automatically included.

Otherwise you need to include rules.neon in your phpstan.neon:

includes:
	- vendor/ergebnis/phpstan-rules/rules.neon

💡 You probably want to use these rules on top of the rules provided by:

• phpstan/phpstan
• phpstan/phpstan-deprecation-rules
• phpstan/phpstan-strict-rules

This package provides the following rules for use with phpstan/phpstan:

• Ergebnis\PHPStan\Rules\ArrowFunctions\NoNullableReturnTypeDeclarationRule
• Ergebnis\PHPStan\Rules\ArrowFunctions\NoParameterPassedByReferenceRule
• Ergebnis\PHPStan\Rules\ArrowFunctions\NoParameterWithNullDefaultValueRule
• Ergebnis\PHPStan\Rules\ArrowFunctions\NoParameterWithNullableTypeDeclarationRule
• Ergebnis\PHPStan\Rules\CallLikes\NoNamedArgumentRule
• Ergebnis\PHPStan\Rules\Classes\FinalRule
• Ergebnis\PHPStan\Rules\Classes\NoExtendsRule
• Ergebnis\PHPStan\Rules\Classes\PHPUnit\Framework\TestCaseWithSuffixRule
• Ergebnis\PHPStan\Rules\Closures\NoNullableReturnTypeDeclarationRule
• Ergebnis\PHPStan\Rules\Closures\NoParameterPassedByReferenceRule
• Ergebnis\PHPStan\Rules\Closures\NoParameterWithNullDefaultValueRule
• Ergebnis\PHPStan\Rules\Closures\NoParameterWithNullableTypeDeclarationRule
• Ergebnis\PHPStan\Rules\Expressions\NoAssignByReferenceRule
• Ergebnis\PHPStan\Rules\Expressions\NoCompactRule
• Ergebnis\PHPStan\Rules\Expressions\NoErrorSuppressionRule
• Ergebnis\PHPStan\Rules\Expressions\NoEvalRule
• Ergebnis\PHPStan\Rules\Expressions\NoIssetRule
• Ergebnis\PHPStan\Rules\Files\DeclareStrictTypesRule
• Ergebnis\PHPStan\Rules\Files\NoPhpstanIgnoreRule
• Ergebnis\PHPStan\Rules\Functions\NoNullableReturnTypeDeclarationRule
• Ergebnis\PHPStan\Rules\Functions\NoParameterPassedByReferenceRule
• Ergebnis\PHPStan\Rules\Functions\NoParameterWithNullDefaultValueRule
• Ergebnis\PHPStan\Rules\Functions\NoParameterWithNullableTypeDeclarationRule
• Ergebnis\PHPStan\Rules\Functions\NoReturnByReferenceRule
• Ergebnis\PHPStan\Rules\Methods\FinalInAbstractClassRule
• Ergebnis\PHPStan\Rules\Methods\InvokeParentHookMethodRule
• Ergebnis\PHPStan\Rules\Methods\NoConstructorParameterWithDefaultValueRule
• Ergebnis\PHPStan\Rules\Methods\NoNullableReturnTypeDeclarationRule
• Ergebnis\PHPStan\Rules\Methods\NoParameterPassedByReferenceRule
• Ergebnis\PHPStan\Rules\Methods\NoParameterWithContainerTypeDeclarationRule
• Ergebnis\PHPStan\Rules\Methods\NoParameterWithNullDefaultValueRule
• Ergebnis\PHPStan\Rules\Methods\NoParameterWithNullableTypeDeclarationRule
• Ergebnis\PHPStan\Rules\Methods\NoReturnByReferenceRule
• Ergebnis\PHPStan\Rules\Methods\PrivateInFinalClassRule
• Ergebnis\PHPStan\Rules\PropertyHooks\NoParameterWithNullableTypeDeclarationRule
• Ergebnis\PHPStan\Rules\PropertyHooks\NoReturnByReferenceRule
• Ergebnis\PHPStan\Rules\Statements\NoSwitchRule

This rule reports an error when an arrow function uses a nullable return type declaration.

💡 Find out more in the rule documentation for ArrowFunctions\NoNullableReturnTypeDeclarationRule.

This rule reports an error when an arrow function has a parameter that is passed by reference.

💡 Find out more in the rule documentation for ArrowFunctions\NoParameterPassedByReferenceRule.

This rule reports an error when an arrow function has a parameter with null as default value.

💡 Find out more in the rule documentation for ArrowFunctions\NoParameterWithNullDefaultValueRule.

This rule reports an error when an arrow function has a parameter with a nullable type declaration.

💡 Find out more in the rule documentation for ArrowFunctions\NoParameterWithNullableTypeDeclarationRule.

This rule reports an error when an anonymous function, a function, or a method is invoked using a named argument.

💡 Find out more in the rule documentation for CallLikes\NoNamedArgumentRule.

This rule reports an error when a non-anonymous class is not final.

💡 By default, this rule ignores classes that

• use @Entity, @ORM\Entity, or @ORM\Mapping\Entity annotations
• use Doctrine\ORM\Mapping\Entity attributes

on the class level.

💡 Find out more in the rule documentation for Classes\FinalRule.

This rule reports an error when a class extends another class.

💡 Find out more in the rule documentation for Classes\NoExtendsRule.

This rule reports an error when a concrete class is a sub-class of PHPUnit\Framework\TestCase but does not have a Test suffix.

💡 Find out more in the rule documentation for Classes\PHPUnit\Framework\TestCaseWithSuffixRule.

This rule reports an error when a closure uses a nullable return type declaration.

💡 Find out more in the rule documentation for Closures\NoNullableReturnTypeDeclarationRule.

This rule reports an error when a closure has a parameter that is passed by reference.

💡 Find out more in the rule documentation for Closures\NoParameterPassedByReferenceRule.

This rule reports an error when a closure has a parameter with null as default value.

💡 Find out more in the rule documentation for Closures\NoParameterWithNullDefaultValueRule.

This rule reports an error when a closure has a parameter with a nullable type declaration.

💡 Find out more in the rule documentation for Closures\NoParameterWithNullableTypeDeclarationRule.

This rule reports an error when a variable is assigned by reference.

💡 Find out more in the rule documentation for Expressions\NoAssignByReferenceRule.

This rule reports an error when the function compact() is used.

💡 Find out more in the rule documentation for Expressions\NoCompactRule.

This rule reports an error when @ is used to suppress errors.

💡 Find out more in the rule documentation for Expressions\NoErrorSuppressionRule.

This rule reports an error when the language construct eval() is used.

💡 Find out more in the rule documentation for Expressions\NoEvalRule.

This rule reports an error when the language construct isset() is used.

💡 Find out more in the rule documentation for Expressions\NoIssetRule.

This rule reports an error when a non-empty file does not contain a declare(strict_types=1) declaration.

💡 Find out more in the rule documentation for Files\DeclareStrictTypesRule.

This rule reports an error when a @phpstan-ignore, @phpstan-ignore-line, or @phpstan-ignore-next-line tag is used to ignore errors reported by phpstan/phpstan.

💡 Find out more in the rule documentation for Files\NoPhpstanIgnoreRule.

This rule reports an error when a function uses a nullable return type declaration.

💡 Find out more in the rule documentation for Functions\NoNullableReturnTypeDeclarationRule.

This rule reports an error when a function has a parameter that is passed by reference.

💡 Find out more in the rule documentation for Functions\NoParameterPassedByReferenceRule.

This rule reports an error when a function has a parameter with null as default value.

💡 Find out more in the rule documentation for Functions\NoParameterWithNullDefaultValueRule.

This rule reports an error when a function has a parameter with a nullable type declaration.

💡 Find out more in the rule documentation for Functions\NoParameterWithNullableTypeDeclarationRule.

This rule reports an error when a function returns by reference.

💡 Find out more in the rule documentation for Functions\NoReturnByReferenceRule.

This rule reports an error when a concrete public or protected method in an abstract class is not final.

💡 By default, this rule ignores Doctrine entities.

💡 Find out more in the rule documentation for Methods\FinalInAbstractClassRule.

This rule reports an error when a hook method that overrides a hook method in a parent class does not invoke the overridden hook method in the expected order.

💡 Find out more in the rule documentation for Methods\InvokeParentHookMethodRule.

This rule reports an error when a constructor has a parameter with a default value.

💡 Find out more in the rule documentation for Methods\NoConstructorParameterWithDefaultValueRule.

This rule reports an error when a method uses a nullable return type declaration.

💡 Find out more in the rule documentation for Methods\NoNullableReturnTypeDeclarationRule.

This rule reports an error when a method has a parameter that is passed by reference.

💡 Find out more in the rule documentation for Methods\NoParameterPassedByReferenceRule.

This rule reports an error when a method has a type declaration for a known dependency injection container or service locator.

💡 Find out more in the rule documentation for Methods\NoParameterWithContainerTypeDeclarationRule.

This rule reports an error when a method has a parameter with null as default value.

💡 Find out more in the rule documentation for Methods\NoParameterWithNullDefaultValueRule.

This rule reports an error when a method has a parameter with a nullable type declaration.

💡 Find out more in the rule documentation for Methods\NoParameterWithNullableTypeDeclarationRule.

This rule reports an error when a method returns by reference.

💡 Find out more in the rule documentation for Methods\NoReturnByReferenceRule.

This rule reports an error when a method in a final class is protected but could be private.

💡 Find out more in the rule documentation for Methods\PrivateInFinalClassRule.

This rule reports an error when a property hook has a parameter with a nullable type declaration.

💡 Find out more in the rule documentation for PropertyHooks\NoParameterWithNullableTypeDeclarationRule.

This rule reports an error when a property hook returns by reference.

💡 Find out more in the rule documentation for PropertyHooks\NoReturnByReferenceRule.

This rule reports an error when the statement switch() is used.

💡 Find out more in the rule documentation for Statements\NoSwitchRule.

You can disable all rules using the allRules configuration parameter:

parameters:
	ergebnis:
		allRules: false

If you have disabled all rules using the allRules configuration parameter, you can re-enable individual rules with their corresponding configuration parameters:

parameters:
	ergebnis:
		allRules: false
		privateInFinalClass:
			enabled: true

The maintainers of this project record notable changes to this project in a changelog.

The maintainers of this project suggest following the contribution guide.

The maintainers of this project ask contributors to follow the code of conduct.

The maintainers of this project provide limited support.

This project currently supports the following PHP versions:

• PHP 7.4 (has reached its end of life on November 28, 2022)
• PHP 8.0 (has reached its end of life on November 26, 2023)
• PHP 8.1 (has reached its end of life on December 31, 2025)
• PHP 8.2
• PHP 8.3
• PHP 8.4
• PHP 8.5

The maintainers of this project add support for a PHP version following its initial release and may drop support for a PHP version when it has reached its end of life.

This project has a security policy.

This project uses the MIT license.

The method FinalRule::isWhitelistedClass() is inspired by the work on FinalClassFixer and FinalInternalClassFixer, contributed by Dariusz Rumiński, Filippo Tessarotto, and Spacepossum for friendsofphp/php-cs-fixer (originally licensed under MIT).

Follow @localheinz and @ergebnis on X.