Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/slamdunk/phpstan-extensions
Extensions for PHPStan
https://github.com/slamdunk/phpstan-extensions
php phpstan static-analysis yii2
Last synced: 7 days ago
JSON representation
Extensions for PHPStan
- Host: GitHub
- URL: https://github.com/slamdunk/phpstan-extensions
- Owner: Slamdunk
- License: mit
- Created: 2018-01-05T13:41:18.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2024-10-28T17:00:50.000Z (3 months ago)
- Last Synced: 2024-10-29T23:49:56.365Z (3 months ago)
- Topics: php, phpstan, static-analysis, yii2
- Language: PHP
- Size: 193 KB
- Stars: 67
- Watchers: 5
- Forks: 13
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Slam PHPStan extensions
[](https://packagist.org/packages/slam/phpstan-extensions)
[](https://packagist.org/packages/slam/phpstan-extensions)
[](https://github.com/Slamdunk/phpstan-extensions/actions)
[](https://codecov.io/gh/Slamdunk/phpstan-extensions)
Extensions for [PHPStan](https://phpstan.org/)
## Installation
To use this extension, require it in [Composer](https://getcomposer.org/):
```bash
composer require --dev slam/phpstan-extensions
```
## Usage
When you are using [`phpstan/extension-installer`](https://github.com/phpstan/extension-installer),
`conf/slam-rules.neon` will be automatically included.
Otherwise you need to include `conf/slam-rules.neon` in your `phpstan.neon`:
```yaml
includes:
- vendor/slam/phpstan-extensions/conf/slam-rules.neon
```
## Rules
1. `SlamPhpStan\UnusedVariableRule`: check for variable inside functions never used after initial assignment
1. `SlamPhpStan\MissingClosureParameterTypehintRule`: requires parameter typehints for closures; WARNING: no PhpDoc
allowed, see [`phpstan/phpstan-strict-rules#87`](https://github.com/phpstan/phpstan-strict-rules/issues/87)
1. `SlamPhpStan\StringToClassRule`: requires strings that refer to classes to be expressed with `::class` notation
1. `SlamPhpStan\GotoRule`: no goto allowed
1. `SlamPhpStan\ClassNotationRule`:
1. Interfaces must end with "Interface"
1. Traits must end with "Trait"
1. Abstract classes must start with "Abstract"
1. Exceptions must end with "Exception"
1. `SlamPhpStan\PhpUnitFqcnAnnotationRule`: classes found in following PHPUnit annotations must exist:
1. `@expectedException`
1. `@covers`
1. `@coversDefaultClass`
1. `@uses`
1. `SlamPhpStan\AccessGlobalVariableWithinContextRule`: inhibit the access to globals within
classes that extend or implement a certain class/interface
1. `SlamPhpStan\AccessStaticPropertyWithinModelContextRule`: inhibit the access to static attributes of a class within
classes that extend or implement a certain class/interface, useful to prohibit usage of singletons in models
## Not-NOW config
A `not-now-rules.neon` config is present for forbidding raw date system calls:
```yaml
includes:
- vendor/slam/phpstan-extensions/conf/not-now-rules.neon
```
These rules forbid:
1. `new DateTimeImmutable()`
1. `new DateTime('yesterday')`
1. `date('Y-m-d')`
1. `time()`
1. `strtotime('noon')`
You should instead rely on a clock abstraction like [`lcobucci/clock`](https://github.com/lcobucci/clock).
WARNING: the rules are not perfect, a user can tricks them easily; they are meant only to help the transition to
a proper clock abstraction.
## Symfony-specific config
A `symfony-rules.neon` config is present for Symfony projects:
```yaml
includes:
- vendor/slam/phpstan-extensions/conf/symfony-rules.neon
```
With the following configurations:
1. `SlamPhpStan\SymfonyFilesystemRule`: forbid calls to raw filesystem functions well wrapped by
[`symfony/filesystem`](https://github.com/symfony/filesystem) component
1. `SlamPhpStan\SymfonyProcessRule`: forbid calls to raw system functions well wrapped by
[`symfony/process`](https://github.com/symfony/process) component
## Yii-specific config
A `yii-rules.neon` config is present for Yii projects:
```yaml
includes:
- vendor/slam/phpstan-extensions/conf/yii-rules.neon
```
With the following configurations:
1. `SlamPhpStan\AccessGlobalVariableWithinContextRule` to deny the usage of `$_GET`, `$_POST` and other global variables
in models implementing `yii\db\ActiveRecordInterface`: accessing to singletons in models is considered an anti-pattern
1. `SlamPhpStan\AccessStaticPropertyWithinModelContextRule` to deny the usage of `yii\BaseYii` static variables like
`$app` in models implementing `yii\db\ActiveRecordInterface`: accessing to singletons in models is considered an
anti-pattern