ergebnis/phpstan-rules
Stars: 310
Forks: 18
Pull Requests: 600
Issues: 24
Watchers: 6
Last Updated: 2023-09-15 10:34:03
:eyeglasses: Provides additional rules for phpstan/phpstan.
License: MIT License
Languages: PHP, Makefile
phpstan-rules
Provides additional rules for phpstan/phpstan.
Installation
Run
composer require --dev ergebnis/phpstan-rulesUsage
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:
Rules
This package provides the following rules for use with phpstan/phpstan:
Ergebnis\PHPStan\Rules\Classes\FinalRuleErgebnis\PHPStan\Rules\Classes\NoExtendsRuleErgebnis\PHPStan\Rules\Classes\PHPUnit\Framework\TestCaseWithSuffixRuleErgebnis\PHPStan\Rules\Closures\NoNullableReturnTypeDeclarationRuleErgebnis\PHPStan\Rules\Closures\NoParameterWithNullableTypeDeclarationRuleErgebnis\PHPStan\Rules\Closures\NoParameterWithNullDefaultValueRuleErgebnis\PHPStan\Rules\Expressions\NoCompactRuleErgebnis\PHPStan\Rules\Expressions\NoErrorSuppressionRuleErgebnis\PHPStan\Rules\Expressions\NoEvalRuleErgebnis\PHPStan\Rules\Expressions\NoIssetRuleErgebnis\PHPStan\Rules\Files\DeclareStrictTypesRuleErgebnis\PHPStan\Rules\Functions\NoNullableReturnTypeDeclarationRuleErgebnis\PHPStan\Rules\Functions\NoParameterWithNullableTypeDeclarationErgebnis\PHPStan\Rules\Functions\NoParameterWithNullDefaultValueRuleErgebnis\PHPStan\Rules\Methods\FinalInAbstractClassRuleErgebnis\PHPStan\Rules\Methods\NoConstructorParameterWithDefaultValueRuleErgebnis\PHPStan\Rules\Methods\NoNullableReturnTypeDeclarationRuleErgebnis\PHPStan\Rules\Methods\NoParameterWithContainerTypeDeclarationRuleErgebnis\PHPStan\Rules\Methods\NoParameterWithNullableTypeDeclarationRuleErgebnis\PHPStan\Rules\Methods\NoParameterWithNullDefaultValueRuleErgebnis\PHPStan\Rules\Methods\PrivateInFinalClassRuleErgebnis\PHPStan\Rules\Statements\NoSwitchRule
Classes
Classes\FinalRule
This rule reports an error when a non-anonymous class is not final.
💡 This rule ignores classes that
- use
@Entity,@ORM\Entity, or@ORM\Mapping\Entityannotations - use
Doctrine\ORM\Mapping\Entityattributes
on the class level.
Disabling the rule
You can set the the enabled parameter to false to disable this rule.
parameters:
ergebnis:
final:
enabled: falseDisallowing abstract classes
By default, this rule allows to declare abstract classes.
You can set the allowAbstractClasses parameter to false to disallow abstract classes.
parameters:
ergebnis:
final:
allowAbstractClasses: falseExcluding classes from inspection
You can set the classesNotRequiredToBeAbstractOrFinal parameter to a list of class names that you want to exclude from inspection.
parameters:
ergebnis:
final:
classesNotRequiredToBeAbstractOrFinal:
- Foo\Bar\NeitherAbstractNorFinal
- Bar\Baz\NeitherAbstractNorFinalClasses\NoExtendsRule
This rule reports an error when a class extends another class.
Defaults
By default, this rule allows the following classes to be extended:
Disabling the rule
You can set the the enabled parameter to false to disable this rule.
parameters:
ergebnis:
noExtends:
enabled: falseAllowing classes to be extended
You can set the classesAllowedToBeExtended parameter to a list of class names that you want to allow to be extended.
parameters:
ergebnis:
noExtends:
classesAllowedToBeExtended:
- Ergebnis\PHPStan\Rules\Test\Integration\AbstractTestCase
- Ergebnis\PHPStan\Rules\Test\Integration\AbstractTestCaseClasses\PHPUnit\Framework\TestCaseWithSuffixRule
This rule reports an error when a concrete class is a sub-class of PHPUnit\Framework\TestCase but does not have a Test suffix.
Disabling the rule
You can set the the enabled parameter to false to disable this rule.
parameters:
ergebnis:
testCaseWithSuffix:
enabled: falseClosures
Closures\NoNullableReturnTypeDeclarationRule
This rule reports an error when a closure uses a nullable return type declaration.
Disabling the rule
You can set the the enabled parameter to false to disable this rule.
parameters:
ergebnis:
noNullableReturnTypeDeclaration:
enabled: falseClosures\NoParameterWithNullableTypeDeclarationRule
This rule reports an error when a closure has a parameter with a nullable type declaration.
Disabling the rule
You can set the the enabled parameter to false to disable this rule.
parameters:
ergebnis:
noParameterWithNullableTypeDeclaration:
enabled: falseClosures\NoParameterWithNullDefaultValueRule
This rule reports an error when a closure has a parameter with null as default value.
Disabling the rule
You can set the the enabled parameter to false to disable this rule.
parameters:
ergebnis:
noParameterWithNullDefaultValue:
enabled: falseExpressions
Expressions\NoCompactRule
This rule reports an error when the function compact() is used.
Disabling the rule
You can set the the enabled parameter to false to disable this rule.
parameters:
ergebnis:
noCompact:
enabled: falseExpressions\NoEvalRule
This rule reports an error when the language construct eval() is used.
Disabling the rule
You can set the the enabled parameter to false to disable this rule.
parameters:
ergebnis:
noEval:
enabled: falseExpressions\NoErrorSuppressionRule
This rule reports an error when @ is used to suppress errors.
Disabling the rule
You can set the the enabled parameter to false to disable this rule.
parameters:
ergebnis:
noErrorSuppression:
enabled: falseExpressions\NoIssetRule
This rule reports an error when the language construct isset() is used.
Disabling the rule
You can set the the enabled parameter to false to disable this rule.
parameters:
ergebnis:
noIsset:
enabled: falseFiles
Files\DeclareStrictTypesRule
This rule reports an error when a non-empty file does not contain a declare(strict_types=1) declaration.
Disabling the rule
You can set the the enabled parameter to false to disable this rule.
parameters:
ergebnis:
declareStrictTypes:
enabled: falseFunctions
Functions\NoNullableReturnTypeDeclarationRule
This rule reports an error when a function uses a nullable return type declaration.
Disabling the rule
You can set the the enabled parameter to false to disable this rule.
parameters:
ergebnis:
noNullableReturnTypeDeclaration:
enabled: falseFunctions\NoParameterWithNullableTypeDeclarationRule
This rule reports an error when a function has a parameter with a nullable type declaration.
Disabling the rule
You can set the the enabled parameter to false to disable this rule.
parameters:
ergebnis:
noParameterWithNullableTypeDeclaration:
enabled: falseFunctions\NoParameterWithNullDefaultValueRule
This rule reports an error when a function has a parameter with null as default value.
Disabling the rule
You can set the the enabled parameter to false to disable this rule.
parameters:
ergebnis:
noParameterWithNullDefaultValue:
enabled: falseMethods
Methods\FinalInAbstractClassRule
This rule reports an error when a concrete public or protected method in an abstract class is not final.
Disabling the rule
You can set the the enabled parameter to false to disable this rule.
parameters:
ergebnis:
finalInAbstractClass:
enabled: falseMethods\NoConstructorParameterWithDefaultValueRule
This rule reports an error when a constructor declared in
- an anonymous class
- a class
has a default value.
Disabling the rule
You can set the the enabled parameter to false to disable this rule.
parameters:
ergebnis:
noConstructorParameterWithDefaultValue:
enabled: falseMethods\NoNullableReturnTypeDeclarationRule
This rule reports an error when a method declared in
- an anonymous class
- a class
- an interface
uses a nullable return type declaration.
Disabling the rule
You can set the the enabled parameter to false to disable this rule.
parameters:
ergebnis:
noNullableReturnTypeDeclaration:
enabled: falseMethods\NoParameterWithContainerTypeDeclarationRule
This rule reports an error when a method has a type declaration for a known dependency injection container or service locator.
Defaults
By default, this rule disallows the use of type declarations indicating an implementation of
is expected to be injected into a method.
Disabling the rule
You can set the the enabled parameter to false to disable this rule.
parameters:
ergebnis:
noParameterWithContainerTypeDeclaration:
enabled: falseConfiguring container interfaces
You can set the interfacesImplementedByContainers parameter to a list of interface names of additional containers and service locators.
parameters:
ergebnis:
noParameterWithContainerTypeDeclaration:
interfacesImplementedByContainers:
- Fancy\DependencyInjection\ContainerInterface
- Other\ServiceLocatorInterfaceConfiguring methods allowed to use parameters with container type declarations
You can set the methodsAllowedToUseContainerTypeDeclarations parameter to a list of method names that are allowed to use parameters with container type declarations.
parameters:
ergebnis:
noParameterWithContainerTypeDeclaration:
methodsAllowedToUseContainerTypeDeclarations:
- loadExtensionMethods\NoParameterWithNullableTypeDeclarationRule
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.
Disabling the rule
You can set the the enabled parameter to false to disable this rule.
parameters:
ergebnis:
noParameterWithNullableTypeDeclaration:
enabled: falseMethods\NoParameterWithNullDefaultValueRule
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.
Disabling the rule
You can set the the enabled parameter to false to disable this rule.
parameters:
ergebnis:
noParameterWithNullDefaultValue:
enabled: falseMethods\PrivateInFinalClassRule
This rule reports an error when a method in a final class is protected but could be private.
Disabling the rule
You can set the the enabled parameter to false to disable this rule.
parameters:
ergebnis:
privateInFinalClass:
enabled: falseStatements
Statements\NoSwitchRule
This rule reports an error when the statement switch() is used.
Disabling the rule
You can set the the enabled parameter to false to disable this rule.
parameters:
ergebnis:
noSwitch:
enabled: falseChangelog
Please have a look at CHANGELOG.md.
Contributing
Please have a look at CONTRIBUTING.md.
Code of Conduct
Please have a look at CODE_OF_CONDUCT.md.
Security Policy
Please have a look at SECURITY.md.
License
This package is licensed using the MIT License.
Please have a look at LICENSE.md.
Credits
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).
Curious what I am up to?
Follow me on Twitter!
OPEN ISSUES
See all- `abstract` Doctrine entities should not require `final` methods by @localheinz
- Question regarding NoConstructorParameterWithDefaultValueRule by @daniplaninc
- Nullable return type declaration with explicit types by @temp
- Suggestion: Suppress `NoParameterWithContainerTypeDeclarationRule` in a bundle's `loadExtension()` by @ThomasLandauer
- Configure errorTips by @localheinz
- `PrivateInFinalClassRule` should not report trait methods by @enumag
RELEASES
See all- 1.0.0 by @ergebnis-bot
- 0.15.3 by @ergebnis-bot
- 0.15.2 by @ergebnis-bot
- 0.15.1 by @ergebnis-bot
- 0.15.0 by @ergebnis-bot
- 0.14.4 by @ergebnis-bot
- 0.14.3 by @ergebnis-bot
- 0.14.2 by @localheinz
- 0.14.1 by @localheinz
- 0.14.0 by @localheinz
- 0.13.0 by @localheinz
- 0.12.2 by @localheinz
- 0.12.1 by @localheinz
- 0.12.0 by @localheinz
- 0.11.0 by @localheinz
- 0.10.0 by @localheinz
- 0.9.1 by @localheinz
- 0.9.0 by @localheinz
- 0.8.1 by @localheinz
- 0.8.0 by @localheinz
- 0.7.1 by @localheinz
- 0.7.0 by @localheinz
- 0.6.0 by @localheinz
- 0.5.0 by @localheinz
- 0.4.0 by @localheinz
- 0.3.0 by @localheinz
- 0.2.0 by @localheinz
- 0.1.0 by @localheinz
- 2.1.0 by @ergebnis-bot
- 2.0.0 by @ergebnis-bot