Provides additional rules for phpstan/phpstan.
Run
$ composer require --dev localheinz/phpstan-rules
All of the rules provided (and used) by this library are included in rules.neon. The easiest way to use these rules in your project is to include rules.neon in your phpstan.neon:
includes:
- vendor/localheinz/phpstan-rules/rules.neon💡 You probably want to use these rules on top of the rules provided by:
This package provides the following rules for use with phpstan/phpstan:
Localheinz\PHPStan\Rules\Classes\FinalRuleLocalheinz\PHPStan\Rules\Classes\NoExtendsRuleLocalheinz\PHPStan\Rules\Closures\NoNullableReturnTypeDeclarationRuleLocalheinz\PHPStan\Rules\Closures\NoParameterWithNullableTypeDeclarationRuleLocalheinz\PHPStan\Rules\Closures\NoParameterWithNullDefaultValueRuleLocalheinz\PHPStan\Rules\Functions\NoNullableReturnTypeDeclarationRuleLocalheinz\PHPStan\Rules\Functions\NoParameterWithNullDefaultValueRuleLocalheinz\PHPStan\Rules\Functions\NoParameterWithNullableTypeDeclarationLocalheinz\PHPStan\Rules\Methods\NoConstructorParameterWithDefaultValueRuleLocalheinz\PHPStan\Rules\Methods\NoNullableReturnTypeDeclarationRuleLocalheinz\PHPStan\Rules\Methods\NoParameterWithNullableTypeDeclarationRuleLocalheinz\PHPStan\Rules\Methods\NoParameterWithNullDefaultValueRule
This rule reports an error when a non-anonymous class is not final.
By default, this rule allows to declare abstract classes. If you want to disallow declaring abstract classes, you can set the allowAbstractClasses parameter to false:
parameters:
allowAbstractClasses: falseIf you want to exclude classes from being inspected by this rule, you can set the classesNotRequiredToBeAbstractOrFinal parameter to a list of class names:
parameters:
classesNotRequiredToBeAbstractOrFinal:
- Foo\Bar\NeitherAbstractNorFinal
- Bar\Baz\NeitherAbstractNorFinalThis rule reports an error when a class extends another class.
By default, this rule allows the following classes to be extended:
If you want to allow additional classes to be extended, you can set the classesAllowedToBeExtended parameter to a list of class names:
parameters:
classesAllowedToBeExtended:
- Localheinz\PHPStan\Rules\Test\Integration\AbstractTestCase
- PHPStan\Testing\RuleTestCaseThis rule reports an error when a closure uses a nullable return type declaration.
This rule reports an error when a closure has a parameter with a nullable type declaration.
This rule reports an error when a closure has a parameter with null as default value.
This rule reports an error when a function uses a nullable return type declaration.
This rule reports an error when a function has a parameter with a nullable type declaration.
This rule reports an error when a function has a parameter with null as default value.
This rule reports an error when a constructor declared in
- an anonymous class
- a class
has a default value.
This rule reports an error when a method declared in
- an anonymous class
- a class
- an interface
uses a nullable return type declaration.
This rule reports an error when a method declared in
- an anonymous class
- a class
- an interface
has a parameter with a nullable type declaration.
This rule reports an error when a method declared in
- an anonymous class
- a class
- an interface
has a parameter with null as default value.
Please have a look at CHANGELOG.md.
Please have a look at CONTRIBUTING.md.
Please have a look at CODE_OF_CONDUCT.md.
This package is licensed using the MIT License.