pereorga / phpstan-rules
Custom PHPStan rules enforcing an opinionated code style.
Installs: 2 382
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Type:phpstan-extension
pkg:composer/pereorga/phpstan-rules
Requires
- php: ^8.1
- phpstan/phpstan: ^2.0
Requires (Dev)
- php-cs-fixer/shim: ^3.92
- phpstan/phpstan-strict-rules: ^2.0
README
Opinionated rules for PHPStan.
Installation
Run:
composer require --dev pereorga/phpstan-rules
Usage
All provided rules are included in rules.neon.
To enable them, reference rules.neon in your phpstan.neon file:
includes: - vendor/pereorga/phpstan-rules/rules.neon
Rules
NoRedundantBooleanComparisonRule
Disallows comparing boolean expressions with === true, === false, !== true, or !== false. Use the boolean value directly instead.
NoNonReferenceParameterAssignmentRule
Disallows assigning values to parameters that are not passed by reference. Encourages the use of separate working variables.
NoSuperfluousPhpDocTypesRule
Detects @param and @return tags that redundantly duplicate type information already present in native type declarations. Encourages using prose descriptions (e.g., "The name parameter specifies...") for simple types, and @param/@return tags only for complex types (array shapes, generics).
SnakeCaseFunctionRule
Requires all function names to be written in snake_case.
SnakeCaseParameterRule
Requires all parameter names to be written in snake_case.
SnakeCaseVariableRule
Requires all variable names to be written in snake_case.